Fulfillment

Important

After August 1st 2018, apps will be required to specify a location_id when creating fulfillments. To learn more, see Migrating to multi-location fulfillment.

You can use the Fulfillment resource to view, create, modify, or delete an order's fulfillments. 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.

In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer.

In most cases, a merchant will make just one shipment per order, but sometimes the availability or size of items in the order requires a merchant to make more than one shipment. Each shipment should be treated as a separate fulfillment.

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:

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. In order to find the ID of the location, use the Location API.

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. The default value is false for fulfillments on any orders created initially through the API. 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 for the order. Valid values: confirmed, in_transit, out_for_delivery, delivered, and failure.

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
  • Australia Post
  • Bluedart
  • Canada Post
  • China Post
  • Correios
  • DHL Express
  • DHL eCommerce
  • DHL eCommerce Asia
  • DPD
  • DPD Local
  • DPD UK
  • Delhivery
  • Eagle
  • FSC
  • FedEx
  • FedEx UK
  • GLS
  • Globegistics
  • Japan Post
  • New Zealand Post
  • Newgistics
  • PostNord
  • Purolator
  • Royal Mail
  • Sagawa (EN)
  • Sagawa (JA)
  • Singapore Post
  • TNT
  • TNT Post
  • UPS
  • USPS
  • Yamato (EN)
  • Yamato (JA)

Important

When creating a fulfillment for a supported carrier, send the tracking_company exactly as written in the list above.

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/orders/450789469/fulfillments.json
Retrieves fulfillments associated with an order
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)
page

Show a specific page of the results.

(default: 1)
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/orders/#{order_id}/fulfillments.json
View Response
HTTP/1.1 200 OK
{
  "fulfillments": [
    {
      "id": 255858046,
      "order_id": 450789469,
      "status": "failure",
      "created_at": "2018-07-05T12:41:00-04:00",
      "service": "manual",
      "updated_at": "2018-07-05T12:41:00-04:00",
      "tracking_company": null,
      "shipment_status": null,
      "location_id": 905684977,
      "tracking_number": "1Z2345",
      "tracking_numbers": [
        "1Z2345"
      ],
      "tracking_url": "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
      "tracking_urls": [
        "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
      ],
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "name": "#1001.0",
      "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "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,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "discount_allocations": [],
          "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ]
    }
  ]
}

Retrieve all fulfillments after the specified ID

GET /admin/orders/#{order_id}/fulfillments.json?since_id=255858046
View Response
HTTP/1.1 200 OK
{
  "fulfillments": [
    {
      "id": 1022782887,
      "order_id": 450789469,
      "status": "success",
      "created_at": "2018-07-05T13:08:36-04:00",
      "service": "manual",
      "updated_at": "2018-07-05T13:08:36-04:00",
      "tracking_company": "Bluedart",
      "shipment_status": null,
      "location_id": 905684977,
      "tracking_number": "123456789",
      "tracking_numbers": [
        "123456789"
      ],
      "tracking_url": "https://www.bluedart.com/servlet/RoutingServlet?handler=tnt&action=awbquery&awb=awb&numbers=123456789",
      "tracking_urls": [
        "https://www.bluedart.com/servlet/RoutingServlet?handler=tnt&action=awbquery&awb=awb&numbers=123456789"
      ],
      "receipt": {},
      "name": "#1001.1",
      "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782887",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "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,
          "total_discount": "0.00",
          "fulfillment_status": "fulfilled",
          "discount_allocations": [],
          "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "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,
          "total_discount": "0.00",
          "fulfillment_status": "fulfilled",
          "discount_allocations": [],
          "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "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,
          "total_discount": "0.00",
          "fulfillment_status": "fulfilled",
          "discount_allocations": [],
          "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ]
    }
  ]
}
GET /admin/orders/450789469/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/orders/#{order_id}/fulfillments/count.json
View Response
HTTP/1.1 200 OK
{
  "count": 1
}
GET /admin/orders/450789469/fulfillments/255858046.json
Retrieve a specific fulfillment
fields

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

Retrieve a specific fulfillment

GET /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}.json
View Response
HTTP/1.1 200 OK
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "failure",
    "created_at": "2018-07-05T12:41:00-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T12:41:00-04:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "1Z2345",
    "tracking_numbers": [
      "1Z2345"
    ],
    "tracking_url": "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
    "tracking_urls": [
      "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
POST /admin/orders/450789469/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.


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/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "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": 1022782888,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:39-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:40-04:00",
    "tracking_company": "Bluedart",
    "shipment_status": null,
    "location_id": 905684977,
    "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/1022782888",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Fulfill line items without a tracking number

POST /admin/orders/#{order_id}/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": 1022782889,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:41-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:42-04:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": null,
    "tracking_numbers": [],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782889",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Fulfill all line items for an order with multiple tracking numbers

POST /admin/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_numbers": [
      "24e342da8e83284f132cd7def4c03405",
      "b690b09948376d85ee0b3ab9cc555819",
      "31f8085e54fe7601b692f104fb5172d3"
    ],
    "line_items": [
      {
        "id": 466157049
      },
      {
        "id": 518995019
      },
      {
        "id": 703073504
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782890,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:43-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:43-04:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "24e342da8e83284f132cd7def4c03405",
    "tracking_numbers": [
      "24e342da8e83284f132cd7def4c03405",
      "b690b09948376d85ee0b3ab9cc555819",
      "31f8085e54fe7601b692f104fb5172d3"
    ],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782890",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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

POST /admin/orders/#{order_id}/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": 1022782891,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:44-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:45-04:00",
    "tracking_company": "Jack Black's Pack, Stack and Track",
    "shipment_status": null,
    "location_id": 905684977,
    "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/1022782891",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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

POST /admin/orders/#{order_id}/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": 1022782892,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:46-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:46-04:00",
    "tracking_company": "4PX",
    "shipment_status": null,
    "location_id": 905684977,
    "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/1022782892",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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/orders/#{order_id}/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": 1022782893,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:47-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:47-04:00",
    "tracking_company": "fed ex",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "123456789010",
    "tracking_numbers": [
      "123456789010"
    ],
    "tracking_url": "http://www.fedex.com/Tracking?tracknumbers=123456789010&action=track",
    "tracking_urls": [
      "http://www.fedex.com/Tracking?tracknumbers=123456789010&action=track"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782893",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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

POST /admin/orders/#{order_id}/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": 1022782894,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:48-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:49-04:00",
    "tracking_company": "fed ex",
    "shipment_status": null,
    "location_id": 905684977,
    "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/1022782894",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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

POST /admin/orders/#{order_id}/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": 1022782895,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:50-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:50-04:00",
    "tracking_company": "Chinese Post",
    "shipment_status": null,
    "location_id": 905684977,
    "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/1022782895",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

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/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "1234567",
    "tracking_company": "Custom Tracking Company",
    "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": "2018-07-05T13:08:51-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:52-04:00",
    "tracking_company": "Custom Tracking Company",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "1234567",
    "tracking_numbers": [
      "1234567"
    ],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782896",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern)

POST /admin/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": "CJ274101086US",
    "tracking_url": "http://www.custom-tracking.com/?tracking_number=CJ274101086US",
    "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": "2018-07-05T13:08:53-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:53-04:00",
    "tracking_company": "USPS",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "CJ274101086US",
    "tracking_numbers": [
      "CJ274101086US"
    ],
    "tracking_url": "http://www.custom-tracking.com/?tracking_number=CJ274101086US",
    "tracking_urls": [
      "http://www.custom-tracking.com/?tracking_number=CJ274101086US"
    ],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782897",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/518995019",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/703073504",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Fulfill a single line item by explicitly specifying the line items to be fulfilled

POST /admin/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": null,
    "line_items": [
      {
        "id": 466157049
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782898,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:55-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:55-04:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": null,
    "tracking_numbers": [],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782898",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Partially fulfill a single line item by specifying a line item and quantity to be fulfilled

POST /admin/orders/#{order_id}/fulfillments.json
{
  "fulfillment": {
    "location_id": 905684977,
    "tracking_number": null,
    "line_items": [
      {
        "id": 466157049,
        "quantity": 1
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 1022782899,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T13:08:56-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:57-04:00",
    "tracking_company": null,
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": null,
    "tracking_numbers": [],
    "tracking_url": null,
    "tracking_urls": [],
    "receipt": {},
    "name": "#1001.1",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/1022782899",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "partial",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
PUT /admin/orders/450789469/fulfillments/255858046.json
Update information associated with a fulfillment

Update the tracking number for a fulfillment

PUT /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}.json
{
  "fulfillment": {
    "tracking_number": "987654321",
    "id": 255858046
  }
}
View Response
HTTP/1.1 200 OK
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "failure",
    "created_at": "2018-07-05T12:41:00-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:58-04:00",
    "tracking_company": "Bluedart",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "987654321",
    "tracking_numbers": [
      "987654321"
    ],
    "tracking_url": "https://www.bluedart.com/servlet/RoutingServlet?handler=tnt&action=awbquery&awb=awb&numbers=987654321",
    "tracking_urls": [
      "https://www.bluedart.com/servlet/RoutingServlet?handler=tnt&action=awbquery&awb=awb&numbers=987654321"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
POST /admin/orders/450789469/fulfillments/255858046/complete.json
Mark a fulfillment as complete

Complete a fulfillment

POST /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/complete.json
{
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "success",
    "created_at": "2018-07-05T12:41:00-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:08:59-04:00",
    "tracking_company": "UPS",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "1Z2345",
    "tracking_numbers": [
      "1Z2345"
    ],
    "tracking_url": "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
    "tracking_urls": [
      "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
POST /admin/orders/450789469/fulfillments/255858046/open.json
Mark a fulfillment as open

Transition a fulfillment from pending to open

POST /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/open.json
{
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "open",
    "created_at": "2018-07-05T12:41:00-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:09:00-04:00",
    "tracking_company": "UPS",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "1Z2345",
    "tracking_numbers": [
      "1Z2345"
    ],
    "tracking_url": "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
    "tracking_urls": [
      "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
POST /admin/orders/450789469/fulfillments/255858046/cancel.json
Cancel a fulfillment

Cancel a fulfillment

POST /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/cancel.json
{
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment": {
    "id": 255858046,
    "order_id": 450789469,
    "status": "cancelled",
    "created_at": "2018-07-05T12:41:00-04:00",
    "service": "manual",
    "updated_at": "2018-07-05T13:09:02-04:00",
    "tracking_company": "UPS",
    "shipment_status": null,
    "location_id": 905684977,
    "tracking_number": "1Z2345",
    "tracking_numbers": [
      "1Z2345"
    ],
    "tracking_url": "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
    "tracking_urls": [
      "http://wwwapps.ups.com/etracking/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
    ],
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "name": "#1001.0",
    "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "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,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "discount_allocations": [],
        "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}

Sign up for a Partner account to get started.

Sign up