Private
impersonatingCreate a shipment Check out the docs for more info
Delete a shipment Check out the docs for more info
ID of the shipment.
Delete a shipment item Check out the docs for more info
ID of the shipment.
ID of the order.
ID of the line item.
Retrieve a shipment Check out the docs for more info
ID of the shipment.
Retrieve a shipment item Check out the docs for more info
ID of the shipment.
ID of the order.
ID of the line item.
List shipments Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
orderID?: stringID of the order.
Optional
page?: numberPage of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
List shipment items Check out the docs for more info
ID of the shipment.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page.
Partially update a shipment Check out the docs for more info
ID of the shipment.
Create or update a shipment If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
ID of the shipment.
Create or update a shipment item Check out the docs for more info
ID of the shipment.
Required fields: OrderID, LineItemID, QuantityShipped
Set a ship from address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead. Check out the docs for more info
ID of the shipment.
Required fields: Street1, City, State, Zip, Country
Set a ship to address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead. Check out the docs for more info
ID of the shipment.
Required fields: Street1, City, State, Zip, Country
Generated using TypeDoc
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example