List shipment items

Request

Security

OAuth2(Required scopes: FullAccessShipmentAdminShipmentReader)

Path

shipmentIDstringrequired

ID of the shipment.

Query

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"OrderID""LineItemID""!OrderID""!LineItemID"

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/{shipmentID}/items?sortBy=OrderID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(ShipmentItem)

Example:

[
  {
    "OrderID": "",
    "LineItemID": "",
    "QuantityShipped": 0,
    "UnitPrice": 0,
    "CostCenter": "",
    "DateNeeded": "2018-01-01T00:00:00-06:00",
    "Product": { … },
    "Variant": { … },
    "Specs": [ … ],
    "xp": {}
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}