You can use the Fulfillment resource to view fulfillments for an order or a fulfillment order.
A fulfillment order represents a group of one or more items in an order that will be fulfilled from the same location. A fulfillment represents work that is completed as part of a fulfillment order and can include one or more items.
You can use the Fulfillment resource to manage fulfillments for fulfillment orders.
This resource is typically used in apps that perform shipping-related actions, such as making tracking and delivery updates, or creating additional shipments as required for an order or fulfillment order.
Each fulfillment supports a single tracking number. If you need to use multiple tracking numbers, then you should create separate fulfillments.
## Resource Properties
### Fulfillment
* created_at: The date and time when the fulfillment was created. The API returns this value in ISO 8601 format.
* Type: x-string
* Example: "2012-03-13T16:09:54-04:00"
* id: The ID for the fulfillment.
* Type: x-string
* Example: 255858046
* line_items:
A list of the fulfillment's line items, which includes:
id: The ID of the line item within the fulfillment.
variant_id: The ID of the product variant being fulfilled.
title: The title of the product.
quantity: The number of items in the fulfillment.
price: The price of the item before discounts have been applied in the shop currency.
price_set: The price of the line item in shop and presentment currencies.
grams: The weight of the item in grams.
sku: The unique identifier of the item in the fulfillment.
variant_title: The title of the product variant being fulfilled.
vendor: The name of the supplier of the item.
fulfillment_service: The service provider who is doing the fulfillment. This field will be deprecated. Use the assigned_location property on the FulfillmentOrder resource instead.
product_id: The unique numeric identifier for the product in the fulfillment.
requires_shipping: Whether a customer needs to provide a shipping address when placing an order for this product variant.
variant_inventory_management: The name of the inventory management system.
properties: Any additional properties associated with the line item.
product_exists: Whether the product exists.
fulfillable_quantity: The amount available to fulfill. This is the quantity - max (refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity.
This field will be deprecated. Use the fulfillable_quantity property of the line_item property on the FulfillmentOrder resource instead.
total_discount: The total of any discounts applied to the line item with respect to its total quantity on the order. Instead of using this field, Shopify recommends using discount_allocations, which provides the same information.
fulfillment_status: The status of an order in terms of the line items being fulfilled. Valid values: fulfilled, null, or partial.
This field will be deprecated. Use the status property on the FulfillmentOrder resource instead.
total_discount_set: The total amount allocated to the line item in the presentment currency. Instead of using this field, Shopify recommends using discount_allocations, which provides the same information.
discount_allocations: An ordered list of amounts allocated by discount applications. The amount is representative of the discount applied to the total quantity of the line item on the order, not just this fulfillment. Each discount allocation is associated with a particular discount application.
amount: The discount amount allocated to the line in the shop currency.
discount_application_index: The index of the associated discount application in the order's discount_applications list.
amount_set: The discount amount allocated to the line item in shop and presentment currencies.
fulfillment_line_item_id: A unique identifier for a quantity of items within a single fulfillment. An order can have multiple fulfillment line items.
tax_lines: The title, price, and rate of any taxes applied to the line item for its total quantity on the order.
duties: A list of duty objects, each containing information about a duty on the line item for its total quantity on the order.
* Type: x-string
* Example: [{"id"=>466157049, "variant_id"=>39072856, "title"=>"IPod Nano - 8gb", "quantity"=>1, "price"=>"199.00", "grams"=>200, "sku"=>"IPOD2008GREEN", "variant_title"=>"green", "vendor"=>nil, "fulfillment_service"=>"manual", "product_id"=>632910392, "requires_shipping"=>true, "taxable"=>true, "gift_card"=>false, "name"=>"IPod Nano - 8gb - green", "variant_inventory_management"=>"shopify", "properties"=>[], "product_exists"=>true, "fulfillable_quantity"=>1, "total_discount"=>"0.00", "fulfillment_status"=>nil, "fulfillment_line_item_id"=>274098237, "tax_lines"=>[], "duties"=>[{"id"=>"2", "harmonized_system_code"=>"520300", "country_code_of_origin"=>"CA", "shop_money"=>{"amount"=>"164.86", "currency_code"=>"CAD"}, "presentment_money"=>{"amount"=>"105.31", "currency_code"=>"EUR"}, "tax_lines"=>[{"title"=>"VAT", "price"=>"16.486", "rate"=>0.1, "price_set"=>{"shop_money"=>{"amount"=>"16.486", "currency_code"=>"CAD"}, "presentment_money"=>{"amount"=>"10.531", "currency_code"=>"EUR"}}}], "admin_graphql_api_id"=>"gid://shopify/Duty/2"}]}]
* location_id: The unique identifier of the location that the fulfillment was processed at. To find the ID of the location, use the Location resource.
* Type: x-string
* Example: 40642626
* name: The uniquely identifying fulfillment name, consisting of two parts separated by a .. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).
* Type: x-string
* Example: "#1001.1"
* order_id: The unique numeric identifier for the order.
* Type: x-string
* Example: 450789469
* origin_address:
The address of the fulfillment location. This property is intended for tax purposes,
as a full address is required for tax providers to accurately calculate taxes. To retrieve
a fulfillment location's address, use the assigned_location` property on the
FulfillmentOrder resource instead.
address1: (string) The street address of the fulfillment location.
address2: (string) The second line of the address. Typically the number of the apartment, suite, or unit.
city: (string) The city of the fulfillment location.
country_code: (string) (required) The two-letter country code
(ISO 3166-1 alpha-2 format) of the fulfillment location.
province_code: (string) The province of the fulfillment location.
zip: (string) The zip code of the fulfillment location.
* Type: x-string
* Example: [{"address1"=>"1 Rue des Carrieres", "address2"=>"Suite 1234", "city"=>"Montreal", "country_code"=>"CA", "province_code"=>"QC", "zip"=>"G1R 4P5"}]
* receipt:
A text field that provides information about the receipt:
The current shipment status of the fulfillment. Valid values:
label_printed: A label for the shipment was purchased and printed.
label_purchased: A label for the shipment was purchased, but not printed.
attempted_delivery: Delivery of the shipment was attempted, but unable to be completed.
ready_for_pickup: The shipment is ready for pickup at a shipping depot.
confirmed: The carrier is aware of the shipment, but hasn't received it yet.
in_transit: The shipment is being transported between shipping facilities on the way to its destination.
out_for_delivery: The shipment is being delivered to its final destination.
delivered: The shipment was succesfully delivered.
failure: Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
* Type: x-string
* Example: "confirmed"
* status:
The status of the fulfillment. Valid values:
pending: Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to 'open' or 'success'.
open: The fulfillment has been acknowledged by the service and is in processing.
success: The fulfillment was successful.
cancelled: The fulfillment was cancelled.
error: There was an error with the fulfillment request.
For the tracking company names from the
list below
Shopify automatically builds tracking URLs for all of the provided tracking numbers,
which makes the tracking numbers clickable in the interface.
Additionally, for the tracking companies listed on the
Shipping Carriers help page
Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process.
Supported tracking companies
The following tracking companies display for shops located in any country:
4PX
AGS
Amazon Logistics UK
Amazon Logistics US
An Post
Anjun Logistics
APC
Asendia USA
Australia Post
Bonshaw
BPost
BPost International
Canada Post
Canpar
CDL Last Mile
China Post
Chronopost
Chukou1
Colissimo
Comingle
Coordinadora
Correios
Correos
CTT
CTT Express
Cyprus Post
Delnext
Deutsche Post
DHL eCommerce
DHL eCommerce Asia
DHL Express
DPD
DPD Local
DPD UK
DTD Express
DX
Eagle
Estes
Evri
FedEx
First Global Logistics
First Line
FSC
Fulfilla
GLS
Guangdong Weisuyi Information Technology (WSE)
Heppner Internationale Spedition GmbH & Co.
Iceland Post
IDEX
Israel Post
Japan Post (EN)
Japan Post (JA)
La Poste
Lasership
Latvia Post
Lietuvos Paštas
Logisters
Lone Star Overnight
M3 Logistics
Meteor Space
Mondial Relay
New Zealand Post
NinjaVan
North Russia Supply Chain (Shenzhen) Co.
OnTrac
Packeta
Pago Logistics
Ping An Da Tengfei Express
Pitney Bowes
Portal PostNord
Poste Italiane
PostNL
PostNord DK
PostNord NO
PostNord SE
Purolator
Qxpress
Qyun Express
Royal Mail
Royal Shipments
Sagawa (EN)
Sagawa (JA)
Sendle
SF Express
SFC Fulfillment
SHREE NANDAN COURIER
Singapore Post
Southwest Air Cargo
StarTrack
Step Forward Freight
Swiss Post
TForce Final Mile
Tinghao
TNT
Toll IPEC
United Delivery Service
UPS
USPS
Venipak
We Post
Whistl
Wizmo
WMYC
Xpedigo
XPO Logistics
Yamato (EN)
Yamato (JA)
YiFan Express
YunExpress
The following tracking companies are displayed for shops located in specific countries:
Australia: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics
Austria: Österreichische Post
Bulgaria: Speedy
Canada: Intelcom, BoxKnight, Loomis, GLS
China: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC
Czechia: Zásilkovna
Germany: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS
Spain: SEUR
France: Colissimo, Mondial Relay, Colis Privé, GLS
United Kingdom: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells
Greece: ACS Courier
Hong Kong SAR: SF Express
Ireland: Fastway, DPD Ireland
India: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart
A list of tracking numbers provided by the shipping company.
The tracking numbers are clickable in the interface if one of the following applies
(the highest in the list has the highest priority):
Tracking URL provided in the url field.
Shopify-known tracking company name
specified in the company field.
Shopify will build the tracking url automatically based on the tracking number specified.
The tracking number has a Shopify-known format.
Shopify will guess the tracking provider and build the tracking url based on the tracking number format.
Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.
This can result in an invalid tracking URL.
It is highly recommended that you send the tracking company and the tracking URL.
A tracking number provided by the shipping company.
If multiple tracking numbers are set on this fulfillment,
only the first one will be returned in the tracking_number field.
Use the tracking_numbers array field to access all tracking numbers associated with this fulfillment.
The tracking URLs are displayed in the merchant's admin on the order page.
The tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer.
When accounts are enabled, the tracking URLs are also displayed in the customer's order history.
If multiple tracking urls are set on this fulfillment,
only the first one will be returned in the tracking_url field.
Use the tracking_urls array field for accessing all tracking URLs associated with this fulfillment.
* Type: x-string
* Example: "http://track-chinapost.com/startairmail.php?code=112345Z2345"
* updated_at: The date and time (ISO 8601 format) when the fulfillment was last modified..
* Type: x-string
* Example: "2012-05-01T14:22:25-04:00"
* variant_inventory_management: The name of the inventory management service.
* Type: x-string
* Example: "shopify"
## Retrieves fulfillments associated with an order
Retrieves fulfillments associated with an order. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
### Endpoint
/admin/api/#{api_version}/orders/{order_id}/fulfillments.json (GET)
### Parameters
* api_version (required):
* order_id (required):
* created_at_max: Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).
* created_at_min: Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).
* fields: A comma-separated list of fields to include in the response.
* limit: Limit the amount of results.
* since_id: Restrict results to after the specified ID.
* updated_at_max: Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).
* updated_at_min: Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).
### Responses
#### 200
Retrieves fulfillments associated with an order
Examples:
##### Retrieve a list of all fulfillments for an order
Request:
```
GET /admin/api/unstable/orders/450789469/fulfillments.json
```
Response:
```
HTTP/1.1 200 OK
{"fulfillments":[{"id":255858046,"order_id":450789469,"status":"failure","created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:15-05:00","tracking_company":"USPS","shipment_status":null,"location_id":655441491,"origin_address":null,"line_items":[{"id":466157049,"variant_id":39072856,"title":"IPod Nano - 8gb","quantity":1,"sku":"IPOD2008GREEN","variant_title":"green","vendor":null,"fulfillment_service":"manual","product_id":632910392,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"IPod Nano - 8gb - green","variant_inventory_management":"shopify","properties":[{"name":"Custom Engraving Front","value":"Happy Birthday"},{"name":"Custom Engraving Back","value":"Merry Christmas"}],"product_exists":true,"fulfillable_quantity":0,"grams":200,"price":"199.00","total_discount":"0.00","fulfillment_status":null,"price_set":{"shop_money":{"amount":"199.00","currency_code":"USD"},"presentment_money":{"amount":"199.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[{"amount":"3.34","discount_application_index":0,"amount_set":{"shop_money":{"amount":"3.34","currency_code":"USD"},"presentment_money":{"amount":"3.34","currency_code":"USD"}}}],"admin_graphql_api_id":"gid://shopify/LineItem/466157049","duties":[],"tax_lines":[{"price":"3.98","rate":0.06,"title":"State Tax","price_set":{"shop_money":{"amount":"3.98","currency_code":"USD"},"presentment_money":{"amount":"3.98","currency_code":"USD"}},"channel_liable":null}],"fulfillment_line_item_id":225088298}],"tracking_number":"1Z1234512345123456","tracking_numbers":["1Z1234512345123456"],"tracking_url":"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456","tracking_urls":["https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456"],"receipt":{"testcase":true,"authorization":"123456"},"name":"#1001.0","admin_graphql_api_id":"gid://shopify/Fulfillment/255858046"}]}
```
##### Retrieve all fulfillments after the specified ID
Request:
```
GET /admin/api/unstable/orders/450789469/fulfillments.json
```
Response:
```
HTTP/1.1 200 OK
{"fulfillments":[{"id":1069019878,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:43-05:00","service":"shipwire-app","updated_at":"2025-01-02T11:38:43-05:00","tracking_company":"my-custom-shipping-company","shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":518995019,"variant_id":49148385,"title":"IPod Nano - 8gb","quantity":1,"sku":"IPOD2008RED","variant_title":"red","vendor":null,"fulfillment_service":"shipwire-app","product_id":632910392,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"IPod Nano - 8gb - red","variant_inventory_management":"shopify","properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":200,"price":"199.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"199.00","currency_code":"USD"},"presentment_money":{"amount":"199.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[{"amount":"3.33","discount_application_index":0,"amount_set":{"shop_money":{"amount":"3.33","currency_code":"USD"},"presentment_money":{"amount":"3.33","currency_code":"USD"}}}],"admin_graphql_api_id":"gid://shopify/LineItem/518995019","duties":[],"tax_lines":[{"price":"3.98","rate":0.06,"title":"State Tax","price_set":{"shop_money":{"amount":"3.98","currency_code":"USD"},"presentment_money":{"amount":"3.98","currency_code":"USD"}},"channel_liable":null}],"fulfillment_line_item_id":1024374829}],"tracking_number":"123456789","tracking_numbers":["123456789"],"tracking_url":"http://my-custom-shipping-company.shopifyapps.com/track/123456","tracking_urls":["http://my-custom-shipping-company.shopifyapps.com/track/123456","http://my-custom-shipping-company.shopifyapps.com/track/789012"],"receipt":{},"name":"#1001.1","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019878"}]}
```
## Retrieves fulfillments associated with a fulfillment order
Retrieves fulfillments associated with a fulfillment order.
### Endpoint
/admin/api/#{api_version}/fulfillment_orders/{fulfillment_order_id}/fulfillments.json (GET)
### Parameters
* api_version (required):
* fulfillment_order_id (required):
* fulfillment_order_id: The ID of the fulfillment order that is associated with the fulfillments.
### Responses
#### 200
Retrieves fulfillments associated with a fulfillment order
Examples:
##### Retrieve a list of all fulfillments for a fulfillment order
Request:
```
GET /admin/api/unstable/fulfillment_orders/1046000819/fulfillments.json
```
Response:
```
HTTP/1.1 200 OK
{"fulfillments":[{"id":1069019880,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:15-05:00","tracking_company":"UPS","shipment_status":null,"location_id":24826418,"origin_address":{"address1":"150 Elgin St","city":"Ottawa","zip":"K2P 1L4","province_code":"ON","country_code":"CA"},"line_items":[{"id":1071823219,"variant_id":43729076,"title":"Draft","quantity":1,"sku":"draft-151","variant_title":"151cm","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":108828309,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Draft - 151cm","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":1,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823219","tax_lines":[]}],"tracking_number":"#☠1☢\n---\n4321\n","tracking_numbers":["#☠1☢\n---\n4321\n"],"tracking_url":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=#☠1☢---4321","tracking_urls":["https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=#☠1☢---4321"],"receipt":{},"name":"#1001.1","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019880"}]}
```
## Retrieves a count of fulfillments associated with a specific order
Retrieves a count of fulfillments associated with a specific order
### Endpoint
/admin/api/#{api_version}/orders/{order_id}/fulfillments/count.json (GET)
### Parameters
* api_version (required):
* order_id (required):
* created_at_max: Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).
* created_at_min: Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).
* updated_at_max: Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).
* updated_at_min: Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).
### Responses
#### 200
Retrieves a count of fulfillments associated with a specific order
Examples:
##### Count the total number of fulfillments for an order
Request:
```
GET /admin/api/unstable/orders/450789469/fulfillments/count.json
```
Response:
```
HTTP/1.1 200 OK
{"count":1}
```
## Receive a single Fulfillment
Retrieve a specific fulfillment
### Endpoint
/admin/api/#{api_version}/orders/{order_id}/fulfillments/{fulfillment_id}.json (GET)
### Parameters
* api_version (required):
* fulfillment_id (required):
* order_id (required):
* fields: Comma-separated list of fields to include in the response.
### Responses
#### 200
Receive a single Fulfillment
Examples:
##### Retrieve a specific fulfillment
Request:
```
GET /admin/api/unstable/orders/450789469/fulfillments/255858046.json
```
Response:
```
HTTP/1.1 200 OK
{"fulfillment":{"id":255858046,"order_id":450789469,"status":"failure","created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:15-05:00","tracking_company":"USPS","shipment_status":null,"location_id":655441491,"origin_address":null,"line_items":[{"id":466157049,"variant_id":39072856,"title":"IPod Nano - 8gb","quantity":1,"sku":"IPOD2008GREEN","variant_title":"green","vendor":null,"fulfillment_service":"manual","product_id":632910392,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"IPod Nano - 8gb - green","variant_inventory_management":"shopify","properties":[{"name":"Custom Engraving Front","value":"Happy Birthday"},{"name":"Custom Engraving Back","value":"Merry Christmas"}],"product_exists":true,"fulfillable_quantity":1,"grams":200,"price":"199.00","total_discount":"0.00","fulfillment_status":null,"price_set":{"shop_money":{"amount":"199.00","currency_code":"USD"},"presentment_money":{"amount":"199.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[{"amount":"3.34","discount_application_index":0,"amount_set":{"shop_money":{"amount":"3.34","currency_code":"USD"},"presentment_money":{"amount":"3.34","currency_code":"USD"}}}],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/466157049","tax_lines":[{"title":"State Tax","price":"3.98","rate":0.06,"channel_liable":null,"price_set":{"shop_money":{"amount":"3.98","currency_code":"USD"},"presentment_money":{"amount":"3.98","currency_code":"USD"}}}]}],"tracking_number":"1Z1234512345123456","tracking_numbers":["1Z1234512345123456"],"tracking_url":"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456","tracking_urls":["https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456"],"receipt":{"testcase":true,"authorization":"123456"},"name":"#1001.0","admin_graphql_api_id":"gid://shopify/Fulfillment/255858046"}}
```
## Creates a fulfillment for one or many fulfillment orders
Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
### Endpoint
/admin/api/#{api_version}/fulfillments.json (POST)
### Parameters
* api_version (required):
* line_items_by_fulfillment_order (required):
The fulfillment order line items that have to be fulfilled.
fulfillment_order_id: (integer) (required) The ID of the fulfillment order.
fulfillment_order_line_items: (array) The fulfillment order line items and the quantity of each which should be fulfilled.
If this property is undefined, then all of the fulfillment order line items of the associated fulfillment order are fulfilled.
id: (integer) (required) The ID of the fulfillment order line item.
quantity: (integer) (required) (minimum: 1) The quantity of the fulfillment order line item.
* message: A message that's associated with the fulfillment request. This message is only available if the associated
fulfillment order is assigned to a third-party fulfillment service that has opted in to managing fulfillment
orders.
* notify_customer: Whether the customer should be notified.
If set to true, then an email will be sent when the fulfillment is created or updated.
The default value is false.
* origin_address:
The address of the fulfillment location. This property is intended for tax purposes,
as a full address is required for tax providers to accurately calculate taxes. To retrieve
a fulfillment location's address, use the assigned_location` property on the
FulfillmentOrder resource instead.
address1: (string) The street address of the fulfillment location.
address2: (string) The second line of the address. Typically the number of the apartment, suite, or unit.
city: (string) The city of the fulfillment location.
country_code: (string) (required) The two-letter country code
(ISO 3166-1 alpha-2 format) of the fulfillment location.
province_code: (string) The province of the fulfillment location.
zip: (string) The zip code of the fulfillment location.
* tracking_info:
The tracking information for the fulfillment.
company: (string) The name of the tracking company.
For the tracking company names from the
list below
Shopify automatically builds tracking URLs for all of the provided tracking numbers,
which makes the tracking numbers clickable in the interface.
Additionally, for the tracking companies listed on the
Shipping Carriers help page
Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process.
Supported tracking companies
The following tracking companies display for shops located in any country:
4PX
AGS
Amazon Logistics UK
Amazon Logistics US
An Post
Anjun Logistics
APC
Asendia USA
Australia Post
Bonshaw
BPost
BPost International
Canada Post
Canpar
CDL Last Mile
China Post
Chronopost
Chukou1
Colissimo
Comingle
Coordinadora
Correios
Correos
CTT
CTT Express
Cyprus Post
Delnext
Deutsche Post
DHL eCommerce
DHL eCommerce Asia
DHL Express
DPD
DPD Local
DPD UK
DTD Express
DX
Eagle
Estes
Evri
FedEx
First Global Logistics
First Line
FSC
Fulfilla
GLS
Guangdong Weisuyi Information Technology (WSE)
Heppner Internationale Spedition GmbH & Co.
Iceland Post
IDEX
Israel Post
Japan Post (EN)
Japan Post (JA)
La Poste
Lasership
Latvia Post
Lietuvos Paštas
Logisters
Lone Star Overnight
M3 Logistics
Meteor Space
Mondial Relay
New Zealand Post
NinjaVan
North Russia Supply Chain (Shenzhen) Co.
OnTrac
Packeta
Pago Logistics
Ping An Da Tengfei Express
Pitney Bowes
Portal PostNord
Poste Italiane
PostNL
PostNord DK
PostNord NO
PostNord SE
Purolator
Qxpress
Qyun Express
Royal Mail
Royal Shipments
Sagawa (EN)
Sagawa (JA)
Sendle
SF Express
SFC Fulfillment
SHREE NANDAN COURIER
Singapore Post
Southwest Air Cargo
StarTrack
Step Forward Freight
Swiss Post
TForce Final Mile
Tinghao
TNT
Toll IPEC
United Delivery Service
UPS
USPS
Venipak
We Post
Whistl
Wizmo
WMYC
Xpedigo
XPO Logistics
Yamato (EN)
Yamato (JA)
YiFan Express
YunExpress
The following tracking companies are displayed for shops located in specific countries:
Australia: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics
Austria: Österreichische Post
Bulgaria: Speedy
Canada: Intelcom, BoxKnight, Loomis, GLS
China: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC
Czechia: Zásilkovna
Germany: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS
Spain: SEUR
France: Colissimo, Mondial Relay, Colis Privé, GLS
United Kingdom: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells
Greece: ACS Courier
Hong Kong SAR: SF Express
Ireland: Fastway, DPD Ireland
India: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart
Turkey: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo
United States: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo
South Africa: Fastway, Skynet
number: (string) The tracking number for the fulfillment.
The tracking number will be clickable in the interface if one of the following applies
(the highest in the list has the highest priority):
Tracking URL provided in the url field.
Shopify-known tracking company name
specified in the company field.
Shopify will build the tracking url automatically based on the tracking number specified.
The tracking number has a Shopify-known format.
Shopify will guess the tracking provider and build the tracking url based on the tracking number format.
Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.
This can result in an invalid tracking URL.
It is highly recommended that you send the tracking company and the tracking URL.
url: (string) The URL to track the fulfillment.
The tracking URL is displayed in the merchant's admin in the order page.
The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.
When accounts are enabled, it is also displayed in the customer's order history.
The URL must be an RFC 3986 and
RFC 3987-compliant URI string.
For example, https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER is a valid URL.
It includes a scheme (https) and a host (myshipping.com).
If you do not provide a scheme (http or https), then http will be substituted.
### Responses
#### 201
Creates a fulfillment for one or many fulfillment orders
Examples:
##### Create a fulfillment with a tracking number of a Shopify unsupported tracking carrier,
and therefore with a tracking url provided.
Request:
```
POST /admin/api/unstable/fulfillments.json
{"fulfillment":{"line_items_by_fulfillment_order":[{"fulfillment_order_id":1046000816}],"tracking_info":{"number":"MS1562678","url":"https://www.my-shipping-company.com?tracking_number=MS1562678"}}}
```
Response:
```
HTTP/1.1 201 Created
{"fulfillment":{"id":1069019877,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:43-05:00","service":"manual","updated_at":"2025-01-02T11:38:43-05:00","tracking_company":null,"shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":1071823216,"variant_id":389013007,"title":"Crafty Shoes - Red","quantity":1,"sku":"crafty_shoes_red","variant_title":"Small","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":910489600,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Crafty Shoes - Red - Small","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823216","tax_lines":[]}],"tracking_number":"MS1562678","tracking_numbers":["MS1562678"],"tracking_url":"https://www.my-shipping-company.com?tracking_number=MS1562678","tracking_urls":["https://www.my-shipping-company.com?tracking_number=MS1562678"],"receipt":{},"name":"#1001.2","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019877"}}
```
##### Create a fulfillment with a tracking number provided.
Tracking url and tracking company name will be determined automatically as the tracking number format
unambiguously maps to a supported company (UPS).
Request:
```
POST /admin/api/unstable/fulfillments.json
{"fulfillment":{"line_items_by_fulfillment_order":[{"fulfillment_order_id":1046000813}],"tracking_info":{"number":"1Z001985YW99744790"}}}
```
Response:
```
HTTP/1.1 201 Created
{"fulfillment":{"id":1069019871,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:40-05:00","service":"manual","updated_at":"2025-01-02T11:38:40-05:00","tracking_company":"UPS","shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":1071823210,"variant_id":389013007,"title":"Crafty Shoes - Red","quantity":1,"sku":"crafty_shoes_red","variant_title":"Small","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":910489600,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Crafty Shoes - Red - Small","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823210","tax_lines":[]}],"tracking_number":"1Z001985YW99744790","tracking_numbers":["1Z001985YW99744790"],"tracking_url":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790","tracking_urls":["https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790"],"receipt":{},"name":"#1001.2","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019871"}}
```
##### Create a fulfillment for all fulfillment order line items if `fulfillment_order_line_items` is left blank
Request:
```
POST /admin/api/unstable/fulfillments.json
{"fulfillment":{"message":"The package was shipped this morning.","notify_customer":false,"tracking_info":{"number":"MS1562678","url":"https://www.my-shipping-company.com?tracking=MS1562678"},"line_items_by_fulfillment_order":[{"fulfillment_order_id":1046000814}]}}
```
Response:
```
HTTP/1.1 201 Created
{"fulfillment":{"id":1069019873,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:41-05:00","service":"manual","updated_at":"2025-01-02T11:38:41-05:00","tracking_company":null,"shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":1071823212,"variant_id":389013007,"title":"Crafty Shoes - Red","quantity":1,"sku":"crafty_shoes_red","variant_title":"Small","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":910489600,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Crafty Shoes - Red - Small","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823212","tax_lines":[]}],"tracking_number":"MS1562678","tracking_numbers":["MS1562678"],"tracking_url":"https://www.my-shipping-company.com?tracking=MS1562678","tracking_urls":["https://www.my-shipping-company.com?tracking=MS1562678"],"receipt":{},"name":"#1001.2","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019873"}}
```
##### Create a fulfillment for the fulfillment order line items specified
Request:
```
POST /admin/api/unstable/fulfillments.json
{"fulfillment":{"message":"The package was shipped this morning.","notify_customer":false,"tracking_info":{"number":"1Z001985YW99744790","company":"UPS"},"line_items_by_fulfillment_order":[{"fulfillment_order_id":1046000811,"fulfillment_order_line_items":[{"id":1072503316,"quantity":1}]}]}}
```
Response:
```
HTTP/1.1 201 Created
{"fulfillment":{"id":1069019868,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:38-05:00","service":"manual","updated_at":"2025-01-02T11:38:38-05:00","tracking_company":"UPS","shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":1071823206,"variant_id":389013007,"title":"Crafty Shoes - Red","quantity":1,"sku":"crafty_shoes_red","variant_title":"Small","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":910489600,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Crafty Shoes - Red - Small","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823206","tax_lines":[]}],"tracking_number":"1Z001985YW99744790","tracking_numbers":["1Z001985YW99744790"],"tracking_url":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790","tracking_urls":["https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790"],"receipt":{},"name":"#1001.2","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019868"}}
```
##### Create a fulfillment without tracking info. Tracking numbers can be set later with the /admin/api/API_VERSION/fulfillments/FULFILLMENT_ID/update_tracking.json endpoint.
Request:
```
POST /admin/api/unstable/fulfillments.json
{"fulfillment":{"line_items_by_fulfillment_order":[{"fulfillment_order_id":1046000815}]}}
```
Response:
```
HTTP/1.1 201 Created
{"fulfillment":{"id":1069019875,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:42-05:00","service":"manual","updated_at":"2025-01-02T11:38:42-05:00","tracking_company":null,"shipment_status":null,"location_id":24826418,"origin_address":null,"line_items":[{"id":1071823214,"variant_id":389013007,"title":"Crafty Shoes - Red","quantity":1,"sku":"crafty_shoes_red","variant_title":"Small","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":910489600,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Crafty Shoes - Red - Small","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":0,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823214","tax_lines":[]}],"tracking_number":null,"tracking_numbers":[],"tracking_url":null,"tracking_urls":[],"receipt":{},"name":"#1001.2","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019875"}}
```
## Updates the tracking information for a fulfillment
Updates the tracking information for a fulfillment.
### Endpoint
/admin/api/#{api_version}/fulfillments/{fulfillment_id}/update_tracking.json (POST)
### Parameters
* api_version (required):
* fulfillment_id (required):
* tracking_info (required):
The tracking information for the fulfillment.
company: (string) The name of the tracking company.
For the tracking company names from the
list below
Shopify automatically builds tracking URLs for all of the provided tracking numbers,
which makes the tracking numbers clickable in the interface.
Additionally, for the tracking companies listed on the
Shipping Carriers help page
Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process.
Supported tracking companies
The following tracking companies display for shops located in any country:
4PX
AGS
Amazon Logistics UK
Amazon Logistics US
An Post
Anjun Logistics
APC
Asendia USA
Australia Post
Bonshaw
BPost
BPost International
Canada Post
Canpar
CDL Last Mile
China Post
Chronopost
Chukou1
Colissimo
Comingle
Coordinadora
Correios
Correos
CTT
CTT Express
Cyprus Post
Delnext
Deutsche Post
DHL eCommerce
DHL eCommerce Asia
DHL Express
DPD
DPD Local
DPD UK
DTD Express
DX
Eagle
Estes
Evri
FedEx
First Global Logistics
First Line
FSC
Fulfilla
GLS
Guangdong Weisuyi Information Technology (WSE)
Heppner Internationale Spedition GmbH & Co.
Iceland Post
IDEX
Israel Post
Japan Post (EN)
Japan Post (JA)
La Poste
Lasership
Latvia Post
Lietuvos Paštas
Logisters
Lone Star Overnight
M3 Logistics
Meteor Space
Mondial Relay
New Zealand Post
NinjaVan
North Russia Supply Chain (Shenzhen) Co.
OnTrac
Packeta
Pago Logistics
Ping An Da Tengfei Express
Pitney Bowes
Portal PostNord
Poste Italiane
PostNL
PostNord DK
PostNord NO
PostNord SE
Purolator
Qxpress
Qyun Express
Royal Mail
Royal Shipments
Sagawa (EN)
Sagawa (JA)
Sendle
SF Express
SFC Fulfillment
SHREE NANDAN COURIER
Singapore Post
Southwest Air Cargo
StarTrack
Step Forward Freight
Swiss Post
TForce Final Mile
Tinghao
TNT
Toll IPEC
United Delivery Service
UPS
USPS
Venipak
We Post
Whistl
Wizmo
WMYC
Xpedigo
XPO Logistics
Yamato (EN)
Yamato (JA)
YiFan Express
YunExpress
The following tracking companies are displayed for shops located in specific countries:
Australia: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics
Austria: Österreichische Post
Bulgaria: Speedy
Canada: Intelcom, BoxKnight, Loomis, GLS
China: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC
Czechia: Zásilkovna
Germany: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS
Spain: SEUR
France: Colissimo, Mondial Relay, Colis Privé, GLS
United Kingdom: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells
Greece: ACS Courier
Hong Kong SAR: SF Express
Ireland: Fastway, DPD Ireland
India: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart
Turkey: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo
United States: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo
South Africa: Fastway, Skynet
number: (string) The tracking number for the fulfillment.
The tracking number will be clickable in the interface if one of the following applies
(the highest in the list has the highest priority):
Tracking URL provided in the url field.
Shopify-known tracking company name
specified in the company field.
Shopify will build the tracking url automatically based on the tracking number specified.
The tracking number has a Shopify-known format.
Shopify will guess the tracking provider and build the tracking url based on the tracking number format.
Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.
This can result in an invalid tracking URL.
It is highly recommended that you send the tracking company and the tracking URL.
url: (string) The URL to track the fulfillment.
The tracking URL is displayed in the merchant's admin in the order page.
The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.
When accounts are enabled, it is also displayed in the customer's order history.
The URL must be an RFC 3986 and
RFC 3987-compliant URI string.
For example, https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER is a valid URL.
It includes a scheme (https) and a host (myshipping.com).
If you do not provide a scheme (http or https), then http will be substituted.
* notify_customer: Whether the customer will be notified of this update and future updates for the fulfillment.
### Responses
#### 200
Updates the tracking information for a fulfillment
Examples:
##### Update the tracking information for a fulfillment with a supported tracking company name and a tracking number. Notify the customer about the tracking details provided.
Request:
```
POST /admin/api/unstable/fulfillments/1069019869/update_tracking.json
{"fulfillment":{"notify_customer":true,"tracking_info":{"company":"UPS","number":"1Z001985YW99744790"}}}
```
Response:
```
HTTP/1.1 200 OK
{"fulfillment":{"tracking_company":"UPS","location_id":24826418,"id":1069019869,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:39-05:00","shipment_status":null,"origin_address":{"address1":"150 Elgin St","city":"Ottawa","zip":"K2P 1L4","province_code":"ON","country_code":"CA"},"line_items":[{"id":1071823207,"variant_id":43729076,"title":"Draft","quantity":1,"sku":"draft-151","variant_title":"151cm","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":108828309,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Draft - 151cm","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":1,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823207","tax_lines":[]}],"tracking_number":"1Z001985YW99744790","tracking_numbers":["1Z001985YW99744790"],"tracking_url":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790","tracking_urls":["https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790"],"receipt":{},"name":"#1001.1","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019869"}}
```
##### Update the tracking information for a fulfillment with a tracking number and a tracking url
Request:
```
POST /admin/api/unstable/fulfillments/1069019866/update_tracking.json
{"fulfillment":{"notify_customer":true,"tracking_info":{"number":"1111","url":"http://www.my-url.com"}}}
```
Response:
```
HTTP/1.1 200 OK
{"fulfillment":{"tracking_company":null,"location_id":24826418,"id":1069019866,"order_id":450789469,"status":"success","created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:37-05:00","shipment_status":null,"origin_address":{"address1":"150 Elgin St","city":"Ottawa","zip":"K2P 1L4","province_code":"ON","country_code":"CA"},"line_items":[{"id":1071823203,"variant_id":43729076,"title":"Draft","quantity":1,"sku":"draft-151","variant_title":"151cm","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":108828309,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Draft - 151cm","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":1,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823203","tax_lines":[]}],"tracking_number":"1111","tracking_numbers":["1111"],"tracking_url":"http://www.my-url.com","tracking_urls":["http://www.my-url.com"],"receipt":{},"name":"#1001.1","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019866"}}
```
## Cancels a fulfillment
Cancels a fulfillment.
### Endpoint
/admin/api/#{api_version}/fulfillments/{fulfillment_id}/cancel.json (POST)
### Parameters
* api_version (required):
* fulfillment_id (required):
### Responses
#### 200
Cancels a fulfillment
Examples:
##### Cancel a fulfillment
Request:
```
POST /admin/api/unstable/fulfillments/1069019879/cancel.json
{}
```
Response:
```
HTTP/1.1 200 OK
{"fulfillment":{"order_id":450789469,"status":"cancelled","location_id":24826418,"id":1069019879,"created_at":"2025-01-02T11:38:15-05:00","service":"manual","updated_at":"2025-01-02T11:38:45-05:00","tracking_company":"UPS","shipment_status":null,"origin_address":{"address1":"150 Elgin St","city":"Ottawa","zip":"K2P 1L4","province_code":"ON","country_code":"CA"},"line_items":[{"id":1071823217,"variant_id":43729076,"title":"Draft","quantity":1,"sku":"draft-151","variant_title":"151cm","vendor":"Birthday Present Factory","fulfillment_service":"manual","product_id":108828309,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"Draft - 151cm","variant_inventory_management":null,"properties":[],"product_exists":true,"fulfillable_quantity":1,"grams":0,"price":"10.00","total_discount":"0.00","fulfillment_status":"fulfilled","price_set":{"shop_money":{"amount":"10.00","currency_code":"USD"},"presentment_money":{"amount":"10.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/1071823217","tax_lines":[]}],"tracking_number":"#☠1☢\n---\n4321\n","tracking_numbers":["#☠1☢\n---\n4321\n"],"tracking_url":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=#☠1☢---4321","tracking_urls":["https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=#☠1☢---4321"],"receipt":{},"name":"#1001.1","admin_graphql_api_id":"gid://shopify/Fulfillment/1069019879"}}
```