Sitecore OrderCloud Documentation

docs

Portal Login

Create or update a shipment.

PUT

/shipments/{shipmentID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShipmentAdmin

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------
FromAddressRead Onlyobject---------
ToAddressRead Onlyobject---------

Create or update a shipment.

PUT

/shipments/{shipmentID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShipmentAdmin

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------
FromAddressRead Onlyobject---------
ToAddressRead Onlyobject---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore