Sitecore OrderCloud Documentation

docs

Portal Login

Get a single shipment item.

GET

/shipments/{shipmentID}/items/{orderID}/{lineItemID}

200

Roles

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

FullAccessShipmentAdminShipmentReader

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---
orderIDRequiredstringID of the order.---
lineItemIDRequiredstringID of the line item.---

Response Body

PropertyTypeFormatMax LengthPossible Values
OrderIDstring---------
LineItemIDstring---------
QuantityShippedintegerint32------
UnitPriceRead Onlynumberfloat------
CostCenterRead Onlystring---------
DateNeededRead Onlystringdate-time------
ProductRead Onlyobject---------
VariantRead Onlyobject---------
SpecsRead Onlyarray---------
xpRead Onlyobject---------

Get a single shipment item.

GET

/shipments/{shipmentID}/items/{orderID}/{lineItemID}

200

Roles

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

FullAccessShipmentAdminShipmentReader

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---
orderIDRequiredstringID of the order.---
lineItemIDRequiredstringID of the line item.---

Response Body

PropertyTypeFormatMax LengthPossible Values
OrderIDstring---------
LineItemIDstring---------
QuantityShippedintegerint32------
UnitPriceRead Onlynumberfloat------
CostCenterRead Onlystring---------
DateNeededRead Onlystringdate-time------
ProductRead Onlyobject---------
VariantRead Onlyobject---------
SpecsRead Onlyarray---------
xpRead Onlyobject---------

Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore