Fulfillment

Version 2020-01

Important

Apps are required to specify a location_id when creating fulfillments. For more information, see Managing fulfillments.

You can use the Fulfillment resource to view, create, modify, or delete an order's or fulfillment order's fulfillments. A fulfillment order represents a group of one or more items in an order that are to 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 both orders and fulfillment orders.

This resource is most often 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.

What you can do with Fulfillment

The Shopify API lets you do the following with the Fulfillment resource. More detailed versions of these general actions may be available:

GET /admin/api/2020-01/orders/{order_id}/fulfillments.json Retrieves fulfillments associated with an order
GET /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json Retrieves fulfillments associated with a fulfillment order
GET /admin/api/2020-01/orders/{order_id}/fulfillments/count.json Retrieves a count of fulfillments associated with a specific order
GET /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json Receive a single Fulfillment
POST /admin/api/2020-01/orders/{order_id}/fulfillments.json Create a new Fulfillment
POST /admin/api/2020-01/fulfillments.json Creates a fulfillment for one or many fulfillment orders
PUT /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json Modify an existing Fulfillment
POST /admin/api/2020-01/fulfillments/{fulfillment_id}/update_tracking.json Updates the tracking information for a fulfillment
POST /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json Complete a fulfillment
POST /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.json Transition a fulfillment from pending to open.
POST /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json Cancel a fulfillment for a specific order ID
POST /admin/api/2020-01/fulfillments/{fulfillment_id}/cancel.json Cancels a fulfillment

Fulfillment properties

created_at	`"created_at": "2012-03-13T16:09:54-04:00"` The date and time when the fulfillment was created. The API returns this value in ISO 8601 format.
id	`"id": 255858046` The ID for the fulfillment.
line_items	"line_items": [ { "id": 466157049, "variant_id": 39072856, "title": "IPod Nano - 8gb", "quantity": 1, "price": "199.00", "grams": 200, "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": [], "product_exists": true, "fulfillable_quantity": 1, "total_discount": "0.00", "fulfillment_status": null, "tax_lines": [] } ] A historical record of each item in the fulfillment: 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. 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. 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. taxable: Whether the line item is taxable. gift_card: Whether the line item is a gift card. name: The name of the 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. total_discount: The total of any discounts applied to the line item. fulfillment_status: The status of an order in terms of the line items being fulfilled. Valid values: `fulfilled`, `null`, or `partial`. tax_lines: The `title`, `price`, and `rate` of any taxes applied to the line item.
location_id	`"location_id": 40642626` The unique identifier of the location that the fulfillment should be processed for. To find the ID of the location, use the Location resource.
name	`"name": "#1001.1"` 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`).
notify_customer	`"notify_customer": true` Whether the customer should be notified. If set to `true`, then an email will be sent when the fulfillment is created or updated. For orders that were initially created using the API, the default value is `false`. For all other orders, the default value is `true`.
order_id	`"order_id": 450789469` The unique numeric identifier for the order.
receipt	`"receipt": { "testcase": true, "authorization": "123456" }` A text field that provides information about the receipt: testcase: Whether the fulfillment was a testcase. authorization: The authorization code.
service	`"service": "manual"` The type of service used.
shipment_status	`"shipment_status": "confirmed"` 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.
status	`"status": "failure"` The status of the fulfillment. Valid values: pending: The fulfillment is pending. 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. failure: The fulfillment request failed.
tracking_company	`"tracking_company": "China Post"` The name of the tracking company. 4PX APC Amazon Logistics UK Amazon Logistics US Anjun Logistics Australia Post Bluedart Canada Post Canpar China Post Chukou1 Correios Couriers Please DHL Express DHL eCommerce DHL eCommerce Asia DPD DPD Local DPD UK Delhivery Eagle FSC Fastway Australia FedEx GLS GLS (US) Globegistics Japan Post (EN) Japan Post (JA) La Poste New Zealand Post Newgistics PostNL PostNord Purolator Royal Mail SF Express SFC Fulfillment Sagawa (EN) Sagawa (JA) Sendle Singapore Post StarTrack TNT Toll IPEC UPS USPS Whistl Yamato (EN) Yamato (JA) YunExpress Important When creating a fulfillment for a supported carrier, send the `tracking_company` exactly as written in the list above. If the tracking company doesn't match one of the supported entries, then the shipping status might not be updated properly during the fulfillment process.
tracking_numbers	`"tracking_numbers": [ "112345Z2345" ]` A list of tracking numbers, provided by the shipping company. Important It is highly recommended that you send the tracking company and the tracking URL as well. If neither one of these is sent, then the tracking company will be determined automatically. This can result in an invalid tracking URL. 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.
tracking_urls	`"tracking_urls": [ "http://track-chinapost.com/startairmail.php?code=112345Z2345" ]` The URLs of tracking pages for the fulfillment.
updated_at	`"updated_at": "2012-05-01T14:22:25-04:00"` The date and time (ISO 8601 format) when the fulfillment was last modified..
variant_inventory_management	`"variant_inventory_management": "shopify"` The name of the inventory management service.

Endpoints

GET /admin/api/2020-01/orders/{order_id}/fulfillments.json

Retrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

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. (default: `50`, maximum: `250`)
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).

Retrieve a list of all fulfillments for an order

GET /admin/api/2020-01/orders/450789469/fulfillments.json

View Response

HTTP/1.1 200 OK
{
  "fulfillments": [
    {
      "id": 255858046,
      "order_id": 450789469,
      "status": "failure",
      "created_at": "2021-01-01T14:22:39-05:00",
      "service": "manual",
      "updated_at": "2021-01-01T14:22:39-05:00",
      "tracking_company": "USPS",
      "shipment_status": null,
      "location_id": 905684977,
      "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",
          "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"
                }
              }
            }
          ]
        }
      ],
      "tracking_number": "1Z2345",
      "tracking_numbers": [
        "1Z2345"
      ],
      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345",
      "tracking_urls": [
        "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
      ],
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "name": "#1001.0",
      "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046"
    }
  ]
}

Retrieve all fulfillments after the specified ID

GET /admin/api/2020-01/orders/450789469/fulfillments.json?since_id=255858046

View Response

HTTP/1.1 200 OK
{
  "fulfillments": [
    {
      "id": 1022782888,
      "order_id": 450789469,
      "status": "success",
      "created_at": "2021-01-01T14:25:38-05:00",
      "service": "manual",
      "updated_at": "2021-01-01T14:25:38-05:00",
      "tracking_company": "TNT",
      "shipment_status": null,
      "location_id": 487838322,
      "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",
          "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"
                }
              }
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "sku": "IPOD2008RED",
          "variant_title": "red",
          "vendor": null,
          "fulfillment_service": "manual",
          "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": 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.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",
          "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"
                }
              }
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "sku": "IPOD2008BLACK",
          "variant_title": "black",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "shopify",
          "properties": [],
          "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.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/703073504",
          "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"
                }
              }
            }
          ]
        }
      ],
      "tracking_number": "123456789",
      "tracking_numbers": [
        "123456789"
      ],
      "tracking_url": "https://www.tnt.com/express/en_us/site/tracking.html?searchType=con&cons=123456789",
      "tracking_urls": [
        "https://www.tnt.com/express/en_us/site/tracking.html?searchType=con&cons=123456789"
      ],
      "receipt": {},
      "name": "#1001.1",
      "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782888"
    }
  ]
}

GET /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json

Retrieves fulfillments associated with a fulfillment order.

fulfillment_order_id

The ID of the fulfillment order that is associated with the fulfillments.

Retrieve a list of all fulfillments for a fulfillment order

GET /admin/api/2020-01/fulfillment_orders/1046000793/fulfillments.json

View Response

HTTP/1.1 200 OK
{
  "fulfillments": [
    {
      "id": 1022782889,
      "order_id": 1073459977,
      "status": "success",
      "created_at": "2021-01-01T14:22:39-05:00",
      "service": "manual",
      "updated_at": "2021-01-01T14:22:39-05:00",
      "tracking_company": "UPS",
      "shipment_status": null,
      "location_id": 48752903,
      "line_items": [
        {
          "id": 1071823188,
          "variant_id": 43729076,
          "title": "Draft",
          "quantity": 1,
          "sku": "draft-151",
          "variant_title": "151cm",
          "vendor": null,
          "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": 10,
          "price": "10.00",
          "total_discount": "0.00",
          "fulfillment_status": null,
          "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": [],
          "admin_graphql_api_id": "gid://shopify/LineItem/1071823188",
          "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": "#1033.1",
      "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782889"
    }
  ]
}

GET /admin/api/2020-01/orders/{order_id}/fulfillments/count.json

Retrieves a count of fulfillments associated with a specific order

created_at_min	Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).
created_at_max	Count fulfillments created 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).
updated_at_max	Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).

Count the total number of fulfillments for an order

GET /admin/api/2020-01/orders/450789469/fulfillments/count.json

View Response

HTTP/1.1 200 OK
{
  "count": 1
}

GET /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json

Retrieve a specific fulfillment

fields

Comma-separated list of fields to include in the response.

Retrieve a specific fulfillment

GET /admin/api/2020-01/orders/450789469/fulfillments/255858046.json

View Response

HTTP/1.1 200 OK
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "failure",
    "created_at": "2021-01-01T14:22:39-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:22:39-05:00",
    "tracking_company": "USPS",
    "shipment_status": null,
    "location_id": 905684977,
    "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,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "1Z2345",
    "tracking_numbers": [
      "1Z2345"
    ],
    "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345",
    "tracking_urls": [
      "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046"
  }
}

POST /admin/api/2020-01/orders/{order_id}/fulfillments.json

Create a fulfillment for the specified order and line items.

The fulfillment's status depends on the line items in the order:

If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately.
If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked.

A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled.

All line items being fulfilled must have the same fulfillment service.

About tracking urls

If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields.

Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled.

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 487838322,
    "tracking_number": "123456789",
    "tracking_urls": [
      "https://shipping.xyz/track.php?num=123456789",
      "https://anothershipper.corp/track.php?code=abc"
    ],
    "notify_customer": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782890,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:44-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:44-05:00",
    "tracking_company": "TNT",
    "shipment_status": null,
    "location_id": 487838322,
    "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": "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.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,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "123456789",
    "tracking_numbers": [
      "123456789"
    ],
    "tracking_url": "https://shipping.xyz/track.php?num=123456789",
    "tracking_urls": [
      "https://shipping.xyz/track.php?num=123456789",
      "https://anothershipper.corp/track.php?code=abc"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782890"
  }
}

Fulfill line items without a tracking number

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": null,
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782891,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:46-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:46-05:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": null,
    "tracking_numbers": [],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782891"
  }
}

Fulfill all line items for an order with multiple tracking numbers

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_numbers": [
      "1572658fbfb2b782ca9662b55e7a2cf1",
      "7234cea45c441498e3211e0060cac56d",
      "a9faef075a4ac7c76c191100fcfef3f9"
    ],
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782892,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:48-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:48-05:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "1572658fbfb2b782ca9662b55e7a2cf1",
    "tracking_numbers": [
      "1572658fbfb2b782ca9662b55e7a2cf1",
      "7234cea45c441498e3211e0060cac56d",
      "a9faef075a4ac7c76c191100fcfef3f9"
    ],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782892"
  }
}

Fulfill all line items for an order and use a custom tracking URL and company

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_url": "http://www.packagetrackr.com/track/somecarrier/1234567",
    "tracking_company": "Jack Black's Pack, Stack and Track",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782893,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:50-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:50-05:00",
    "tracking_company": "Jack Black's Pack, Stack and Track",
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": null,
    "tracking_numbers": [],
    "tracking_url": "http://www.packagetrackr.com/track/somecarrier/1234567",
    "tracking_urls": [
      "http://www.packagetrackr.com/track/somecarrier/1234567"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782893"
  }
}

Fulfill without a location_id results in a bad request

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "tracking_url": "http://www.packagetrackr.com/track/somecarrier/1234567",
    "tracking_company": "Jack Black's Pack, Stack and Track",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 400 Bad Request
{
  "error": "location_id must be specified when creating fulfillments."
}

Fulfill an order using a supported tracking company (generates tracking URL)

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "123456789",
    "tracking_company": "4PX",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782894,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:52-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:52-05:00",
    "tracking_company": "4PX",
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "123456789",
    "tracking_numbers": [
      "123456789"
    ],
    "tracking_url": "http://track.4px.com",
    "tracking_urls": [
      "http://track.4px.com"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782894"
  }
}

Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied)

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "123456789010",
    "tracking_company": "fed ex",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782895,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:54-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:54-05:00",
    "tracking_company": "fed ex",
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "123456789010",
    "tracking_numbers": [
      "123456789010"
    ],
    "tracking_url": "https://www.fedex.com/Tracking?tracknumbers=123456789010&action=track",
    "tracking_urls": [
      "https://www.fedex.com/Tracking?tracknumbers=123456789010&action=track"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782895"
  }
}

Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL)

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "123456789010",
    "tracking_company": "fed ex",
    "tracking_url": "https://www.new-fedex-tracking.com/?number=123456789010",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782896,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:55-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:56-05:00",
    "tracking_company": "fed ex",
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "123456789010",
    "tracking_numbers": [
      "123456789010"
    ],
    "tracking_url": "https://www.new-fedex-tracking.com/?number=123456789010",
    "tracking_urls": [
      "https://www.new-fedex-tracking.com/?number=123456789010"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782896"
  }
}

Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern)

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "RR123456789CN",
    "tracking_company": "Chinese Post",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response

HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782897,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2021-01-01T14:25:57-05:00",
    "service": "manual",
    "updated_at": "2021-01-01T14:25:57-05:00",
    "tracking_company": "Chinese Post",
    "shipment_status": null,
    "location_id": 905684977,
    "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"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "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": 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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [],
        "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.33",
            "discount_application_index": 0,
            "amount_set": {
              "shop_money": {
                "amount": "3.33",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.33",
                "currency_code": "USD"
              }
            }
          }
        ],
        "duties": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06,
            "price_set": {
              "shop_money": {
                "amount": "3.98",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "3.98",
                "currency_code": "USD"
              }
            }
          }
        ]
      }
    ],
    "tracking_number": "RR123456789CN",
    "tracking_numbers": [
      "RR123456789CN"
    ],
    "tracking_url": "http://www.track-chinapost.com",
    "tracking_urls": [
      "http://www.track-chinapost.com"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782897"
  }
}

Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern.

POST /admin/api/2020-01/orders/450789469/fulfillments.json

{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "1234567",
    "tracking_company": "Custom Tracking Company",
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}

View Response