Sign in
Shipments

Finds shipments based on search parameters

post/api/shipments/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

shipmentStatus'pending' | 'open' | 'shipped' | 'cancelled'
packingStatus'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked'
salesOrderIdstring nullable

Filter shipments by sales order identifier

purchaseOrderIdstring nullable

Filter shipments by purchase order identifier

shipmentType'unknown' | 'standard' | 'outsideProcessing'
shipmentIdsstring[]

Filter shipments by shipment identifiers.

namesstring[]

Filter shipments by shipment number, e.g. SHP-SO1234-1 or SHP-PO5678-2.

shipByDateBeforestring date-time nullable

Filter to shipments scheduled to ship before this date (exclusive).

shipByDateAfterstring date-time nullable

Filter to shipments scheduled to ship after this date (exclusive).

shippedDateBeforestring date-time nullable

Filter to shipments actually shipped before this date (exclusive). Compares against the shipped date override (a shop-local date) when one is set, otherwise the shipped date (UTC).

shippedDateAfterstring date-time nullable

Filter to shipments actually shipped after this date (exclusive). Compares against the shipped date override (a shop-local date) when one is set, otherwise the shipped date (UTC).

Response

OK

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes

Changed in 1 of the 12 revisions of this API.4

  • 52cb1111beff4See the full diff
    • ○

      added the new optional request property names (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property names (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property names (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property names (media type: application/*+json)

      new-optional-request-property