Sitecore OrderCloud Documentation

docs

Portal Login

Get a list of shipment items visible to this user.

GET

/me/shipments/{shipmentID}/items

200

Description

Only available to Buyer Users.

Roles

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

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---
orderIDstringID of the order.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, BuyerID, Shipper, DateShipped, DateDelivered, TrackingNumber
sortByarrayComma-delimited list of fields to sort by.DateShipped, OwnerID, ID, BuyerID, Shipper, DateDelivered, Cost, !DateShipped, !OwnerID, !ID, !BuyerID, !Shipper, !DateDelivered, !Cost
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
Metaobject---------

Get a list of shipment items visible to this user.

GET

/me/shipments/{shipmentID}/items

200

Description

Only available to Buyer Users.

Roles

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

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---
orderIDstringID of the order.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, BuyerID, Shipper, DateShipped, DateDelivered, TrackingNumber
sortByarrayComma-delimited list of fields to sort by.DateShipped, OwnerID, ID, BuyerID, Shipper, DateDelivered, Cost, !DateShipped, !OwnerID, !ID, !BuyerID, !Shipper, !DateDelivered, !Cost
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
Metaobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore