POST /admin/api/{api_version}/fulfillment_orders/{fulfillment_order_id}/cancel.json

Marks a fulfillment order as cancelled.

Servers

Path parameters

Name Type Required Description
api_version String Yes
fulfillment_order_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

x-shopify-access-token String No

Request body fields

Name Type Required Description
fulfillment_order Object No
fulfillment_order.id Number No
fulfillment_order.supported_actions[] Array No
fulfillment_order.assigned_location Object No
fulfillment_order.assigned_location.location_id Number No
fulfillment_order.assigned_location.province No
fulfillment_order.assigned_location.name String No
fulfillment_order.assigned_location.zip No
fulfillment_order.assigned_location.address2 No
fulfillment_order.assigned_location.phone No
fulfillment_order.assigned_location.address1 No
fulfillment_order.assigned_location.country_code String No
fulfillment_order.assigned_location.city No
fulfillment_order.order_id Number No
fulfillment_order.line_items[] Array No
fulfillment_order.line_items[].id Number No
fulfillment_order.line_items[].fulfillable_quantity Number No
fulfillment_order.line_items[].inventory_item_id Number No
fulfillment_order.line_items[].quantity Number No
fulfillment_order.line_items[].shop_id Number No
fulfillment_order.line_items[].variant_id Number No
fulfillment_order.line_items[].line_item_id Number No
fulfillment_order.line_items[].fulfillment_order_id Number No
fulfillment_order.destination Object No
fulfillment_order.destination.id Number No
fulfillment_order.destination.province String No
fulfillment_order.destination.email String No
fulfillment_order.destination.last_name String No
fulfillment_order.destination.company No
fulfillment_order.destination.zip String No
fulfillment_order.destination.address2 String No
fulfillment_order.destination.first_name String No
fulfillment_order.destination.phone String No
fulfillment_order.destination.address1 String No
fulfillment_order.destination.country String No
fulfillment_order.destination.city String No
fulfillment_order.merchant_requests[] Array No
fulfillment_order.request_status String No
fulfillment_order.assigned_location_id Number No
fulfillment_order.fulfillment_service_handle String No
fulfillment_order.status String No
fulfillment_order.shop_id Number No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.