Sitecore OrderCloud Documentation

docs

Portal Login

Get a single shipment.

GET

/shipments/{shipmentID}

200

Roles

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

FullAccessShipmentAdminShipmentReader

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---

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---------

Get a single shipment.

GET

/shipments/{shipmentID}

200

Roles

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

FullAccessShipmentAdminShipmentReader

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---

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