Sitecore API catalog/OrderCloud/Shipments

Shipments

Shipments are a grouping of one or more line items from one or more orders that are physically packaged and delivered to the Buyer as a single unit. They are typically created by the marketplace owner or supplier after the order is submitted as part of the fulfillment process.

Operations

List shipments

Request

Security
OAuth2(Required scopes: FullAccessShipmentAdminShipmentReader)
Query
orderIDstring

ID of the order.

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""BuyerID""Shipper""DateShipped""DateDelivered""TrackingNumber"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"DateShipped""OwnerID""ID""BuyerID""Shipper""DateDelivered""Cost""!DateShipped""!OwnerID""!ID"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/shipments?orderID=string&search=string&searchOn=ID&sortBy=DateShipped&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(Shipment)
Example:
[
  {
    "ID": "",
    "BuyerID": "",
    "Shipper": "",
    "DateShipped": "2018-01-01T00:00:00-06:00",
    "DateDelivered": "2018-01-01T00:00:00-06:00",
    "TrackingNumber": "",
    "Cost": 0,
    "OwnerID": "",
    "xp": {},
    "Account": "",
    "FromAddressID": "",
    "ToAddressID": "",
    "FromAddress": { … },
    "ToAddress": { … }
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}