Fulfillment List

GET 
/openapi/2022-01/orders/:order_id/fulfillments

Retrieves a list of fulfillments for the order.

Request

Path Parameters

order_id stringrequired

Order's ID

Query Parameters

limit int32
Limit per page, maximum: 250
Default value: 50
page int32
Page number
Default value: 1
created_at_min string

Filter fulfillments created at or after date, for example: 2016-01-18T23:41:00Z

created_at_max string

Filter fulfillments created at or before date, for example: 2016-01-18T23:41:00Z

updated_at_min string

Filter fulfillments last updated at or after date, for example: 2016-01-18T23:41:00Z

updated_at_max string

Filter fulfillments last updated at or before date, for example: 2016-01-18T23:41:00Z

Responses

200

200

application/json

Schema

Schema

fulfillments object[]
Array [
idstring
Example: 49a731b0-1b7e-47c3-94d9-6d688f36201e
order_idstring
Example: 633130-00000012
statusstring
Example: finished
tracking_companystring
Example: 燕文物流
tracking_numberstring
Example: 11111111111
tracking_company_codestring
Example: DJ-11343
tracking_urlstring
Example:
created_atstring
Example: 2024-04-22T06:58:01Z
updated_atstring
Example: 2024-04-22T07:00:57Z
line_items object[]
Array [
idstring
Example: 7037bd0b-cb6b-453a-a936-b349d0c8bf5d
product_idstring
Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
variant_idstring
Example: 88e68830-4ef5-4125-bf7d-aef8047176b2
variant_titlestring
Example: S-blue-T
product_titlestring
Example: shirt
product_handlestring
Example: shirt
quantityinteger
Default value: 0
Example: 2
notestring
Example:
fulfillment_statusstring
Example: partially_returned
skustring
Example: T-M-S-blue-T-A001004
weight_unitstring
Example: kg
vendorstring
Example: shoplazza
product_urlstring
Example: /products/shirt
compare_at_pricestring
Example: 97.00
imagestring
Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
pricestring
Example: 81.00
totalstring
Example: 162.00
weightstring
Example: 1.10
properties object[]
Array [
namestring
Example: size
valuestring
Example: S
]
custom_properties object
object
refund_quantityinteger
Default value: 0
Example: 0
refund_totalstring
Example: 81.00
taxableboolean
Default value: true
Example: true
requires_shippingboolean
Default value: true
Example: true
shipping_quantityinteger
Default value: 0
Example: 2
]
]

Example

{
  "fulfillments": [
    {
      "id": "49a731b0-1b7e-47c3-94d9-6d688f36201e",
      "order_id": "633130-00000012",
      "status": "finished",
      "tracking_company": "燕文物流",
      "tracking_number": "11111111111",
      "tracking_company_code": "DJ-11343",
      "tracking_url": "",
      "created_at": "2024-04-22T06:58:01Z",
      "updated_at": "2024-04-22T07:00:57Z",
      "line_items": [
        {
          "id": "7037bd0b-cb6b-453a-a936-b349d0c8bf5d",
          "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
          "variant_id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
          "variant_title": "S-blue-T",
          "product_title": "shirt",
          "product_handle": "shirt",
          "quantity": 2,
          "note": "",
          "fulfillment_status": "partially_returned",
          "sku": "T-M-S-blue-T-A001004",
          "weight_unit": "kg",
          "vendor": "shoplazza",
          "product_url": "/products/shirt",
          "compare_at_price": "97.00",
          "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "price": "81.00",
          "total": "162.00",
          "weight": "1.10",
          "properties": [
            {
              "name": "size",
              "value": "S"
            }
          ],
          "custom_properties": {},
          "refund_quantity": 0,
          "refund_total": "81.00",
          "taxable": true,
          "requires_shipping": true,
          "shipping_quantity": 2
        }
      ]
    }
  ]
}

Result

{
    "fulfillments": [
        {
            "id": "49a731b0-1b7e-47c3-94d9-6d688f36201e",
            "order_id": "633130-00000012",
            "status": "finished",
            "tracking_company": "燕文物流",
            "tracking_number": "11111111111",
            "tracking_company_code": "DJ-11343",
            "tracking_url": "",
            "created_at": "2024-04-22T06:58:01Z",
            "updated_at": "2024-04-22T07:00:57Z",
            "line_items": [
                {
                    "id": "7037bd0b-cb6b-453a-a936-b349d0c8bf5d",
                    "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
                    "variant_id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
                    "variant_title": "S-blue-T",
                    "product_title": "shirt",
                    "product_handle": "shirt",
                    "quantity": 2,
                    "note": "",
                    "fulfillment_status": "partially_returned",
                    "sku": "T-M-S-blue-T-A001004",
                    "weight_unit": "kg",
                    "vendor": "shoplazza",
                    "product_url": "/products/shirt",
                    "compare_at_price": "97.00",
                    "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
                    "price": "81.00",
                    "total": "162.00",
                    "weight": "1.10",
                    "properties": [
                        {
                            "name": "size",
                            "value": "S"
                        },
                        {
                            "name": "color",
                            "value": "blue"
                        },
                        {
                            "name": "type",
                            "value": "T"
                        }
                    ],
                    "custom_properties": {},
                    "refund_quantity": 0,
                    "refund_total": "81.00",
                    "taxable": true,
                    "requires_shipping": true,
                    "shipping_quantity": 2
                }
            ]
        }
    ]
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Record not found"
  ]
}

Result

{ "errors": ["Record not found"] }

422

422

text/plain

No schema