Cancel Fulfillment

POST 
/openapi/2022-01/orders/:order_id/fulfillments/:fulfillment_id/cancel

Cancels a specific fulfillment for an order. This action marks the fulfillment as cancelled, stopping any further processing or shipping operations.

Request

Path Parameters

order_id stringrequired

Order's ID

fulfillment_id stringrequired

Fulfillment's id

Responses

200

200

application/json

Schema

Schema

fulfillment object
idstring
Example: 23042b57-f30b-4642-8740-cbdc33115c8a
order_idstring
Example: 633130-00000001
statusstring
Example: cancelled
tracking_companystring
Example: shoplazza
tracking_numberstring
Example: 111111111
tracking_company_codestring
Example: -1
tracking_urlstring
Example:
created_atstring
Example: 2024-04-17T09:05:54Z
updated_atstring
Example: 2024-04-22T08:49:08Z
line_items object[]
Array [
idstring
Example: 3eba6ade-e249-4e4d-b216-624cf2936e9e
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: 1
notestring
Example:
fulfillment_statusstring
Example: waiting
skustring
Example: T-M-S-blue-T-A001004
weight_unitstring
Example: kg
vendorstring
Example: shoplazza
product_urlstring
Example: /products/shirt
compare_at_pricestring
Example: 12.10
imagestring
Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
pricestring
Example: 10.10
totalstring
Example: 10.10
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: 0.00
taxableboolean
Default value: true
Example: true
requires_shippingboolean
Default value: true
Example: true
shipping_quantityinteger
Default value: 0
Example: 1
]

Example

{
  "fulfillment": {
    "id": "23042b57-f30b-4642-8740-cbdc33115c8a",
    "order_id": "633130-00000001",
    "status": "cancelled",
    "tracking_company": "shoplazza",
    "tracking_number": "111111111",
    "tracking_company_code": "-1",
    "tracking_url": "",
    "created_at": "2024-04-17T09:05:54Z",
    "updated_at": "2024-04-22T08:49:08Z",
    "line_items": [
      {
        "id": "3eba6ade-e249-4e4d-b216-624cf2936e9e",
        "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": 1,
        "note": "",
        "fulfillment_status": "waiting",
        "sku": "T-M-S-blue-T-A001004",
        "weight_unit": "kg",
        "vendor": "shoplazza",
        "product_url": "/products/shirt",
        "compare_at_price": "12.10",
        "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
        "price": "10.10",
        "total": "10.10",
        "weight": "1.10",
        "properties": [
          {
            "name": "size",
            "value": "S"
          }
        ],
        "custom_properties": {},
        "refund_quantity": 0,
        "refund_total": "0.00",
        "taxable": true,
        "requires_shipping": true,
        "shipping_quantity": 1
      }
    ]
  }
}

Result

{
    "fulfillment": {
        "id": "23042b57-f30b-4642-8740-cbdc33115c8a",
        "order_id": "633130-00000001",
        "status": "cancelled",
        "tracking_company": "shoplazza",
        "tracking_number": "111111111",
        "tracking_company_code": "-1",
        "tracking_url": "",
        "created_at": "2024-04-17T09:05:54Z",
        "updated_at": "2024-04-22T08:49:08Z",
        "line_items": [
            {
                "id": "3eba6ade-e249-4e4d-b216-624cf2936e9e",
                "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": 1,
                "note": "",
                "fulfillment_status": "waiting",
                "sku": "T-M-S-blue-T-A001004",
                "weight_unit": "kg",
                "vendor": "shoplazza",
                "product_url": "/products/shirt",
                "compare_at_price": "12.10",
                "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
                "price": "10.10",
                "total": "10.10",
                "weight": "1.10",
                "properties": [
                    {
                        "name": "size",
                        "value": "S"
                    },
                    {
                        "name": "color",
                        "value": "blue"
                    },
                    {
                        "name": "type",
                        "value": "T"
                    }
                ],
                "custom_properties": {},
                "refund_quantity": 0,
                "refund_total": "0.00",
                "taxable": true,
                "requires_shipping": true,
                "shipping_quantity": 1
            }
        ]
    }
}