fulfillment-order-shipments

List fulfillment order shipments

Changed on

Returns a paginated list of shipments scoped to the caller account and parent fulfillment order.

get/api/v1/fulfillment-orders/{fulfillmentOrderId}/shipments

Request

Path parameters

fulfillmentOrderIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Parent fulfillment order identifier (UUID).

Query parameters

statusstring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated list of fulfillment order shipments.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortOrder

    • info

      added the new optional query request parameter status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      endpoint added