List Order Fulfillments

GET 
/commerce/orders/:orderId/fulfillments

List fulfillments for an order for a specified user and credential set

Request

Path Parameters

orderId stringrequired

The order ID of the fulfillment

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

carrier string

A string used to retrieve order fulfillments with a specific carrier.

carrierContains string

A string used to retrieve order fulfillments with a carrier containing a specific value.

carrierNotEquals string

A string that should not match the carrier of order fulfillments to be retrieved.

service string

The type of service used for shipping.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

fulfillments

object[]

Array [

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

orderId string

trackingNumbers array

trackingUrls array

lineItems

object[]

Array [

quantity integer

Default value: 0

productId string

lineItemId string

price string

variantId string

title string

sku string

]

id string

]

Example (from schema)

{
  "fulfillments": [
    {
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z",
      "orderId": "0acf204e-62cc-4840-9f0a-b227f97e5613",
      "trackingNumbers": [
        null
      ],
      "trackingUrls": [
        null
      ],
      "lineItems": [
        {
          "quantity": 1,
          "productId": "7892548747520",
          "lineItemId": "12561932648704",
          "price": "2.00",
          "variantId": "43101260415232",
          "title": "Dev Hoodie",
          "sku": ""
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Result

{
  "fulfillments": [
    {
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z",
      "orderId": "0acf204e-62cc-4840-9f0a-b227f97e5613",
      "trackingNumbers": [],
      "trackingUrls": [],
      "lineItems": [
        {
          "quantity": 1,
          "productId": "7892548747520",
          "lineItemId": "12561932648704",
          "price": "2.00",
          "variantId": "43101260415232",
          "title": "Dev Hoodie",
          "sku": ""
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...