Create Fulfillment

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

Creates a fulfillment for specific order items and updates their shipping details.

Request

Path Parameters

order_id stringrequired

Order's ID

application/json

Body

Body

line_item_idsstring[]

Order's Line Item IDs, If you need split the quantity on different fulfillments on same product, leave this field empty, and use line_items below instead.

line_items object[]
Array of line item id and the quantity of each item, If you need split the quantity on different fulfillments on same product, you can use this field, if you don't, you can leave this field empty , and use the line_item_ids instead.
Array [
idstringrequired
The order's line item ID
ship_quantityint32required
The order's product quantity, 0 means all of the quantity will ship together.
]
tracking_numberstringrequired

Tracking Number, for example: DHL1231232113

tracking_companystring

Tracking Company, for example: DHL

tracking_company_codestring

Tracking Company's code, for example: dhl

tracking_urlstring

Tracking Url

Example

{
  "line_item_ids": [
    "string"
  ],
  "line_items": [
    {
      "id": "string",
      "ship_quantity": 0
    }
  ],
  "tracking_number": "string",
  "tracking_company": "string",
  "tracking_company_code": "string",
  "tracking_url": "string"
}

Responses

200

200

application/json

Schema

Schema

fulfillment object
idstring
Example: 51c7dd5d-8f49-40c3-b2c1-5dfdeef9946d
order_idstring
Example: 633130-00000007
statusstring
Example: shipped
tracking_companystring
Example: 燕文物流
tracking_numberstring
Example: 11111111111
tracking_company_codestring
Example: DJ-11343
tracking_urlstring
Example:
created_atstring
Example: 2024-04-22T08:37:12Z
updated_atstring
Example: 2024-04-22T08:37:12Z
line_items object[]
Array [
idstring
Example: ed8af005-1f4e-42d1-859d-99b0fd420781
product_idstring
Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
variant_idstring
Example: a7175820-36b3-4fc6-9baf-51e3035242ba
variant_titlestring
Example: L-blue-T
product_titlestring
Example: shirt
product_handlestring
Example: shirt
quantityinteger
Default value: 0
Example: 1
notestring
Example:
fulfillment_statusstring
Example: shipped
skustring
Example: T-M-L-blue-T-A001008
weight_unitstring
Example: kg
vendorstring
Example: shoplazza
product_urlstring
Example: /products/shirt
compare_at_pricestring
Example: 97.00
imagestring
Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
pricestring
Example: 81.00
totalstring
Example: 81.00
weightstring
Example: 1.10
properties object[]
Array [
namestring
Example: size
valuestring
Example: L
]
custom_properties object
object
refund_quantityinteger
Default value: 0
Example: 0
refund_totalstring
Example: 0.00
taxableboolean
Default value: true
Example: true
requires_shippingboolean
Default value: true
Example: true
shipping_quantityinteger
Default value: 0
Example: 1
]

Example

{
  "fulfillment": {
    "id": "51c7dd5d-8f49-40c3-b2c1-5dfdeef9946d",
    "order_id": "633130-00000007",
    "status": "shipped",
    "tracking_company": "燕文物流",
    "tracking_number": "11111111111",
    "tracking_company_code": "DJ-11343",
    "tracking_url": "",
    "created_at": "2024-04-22T08:37:12Z",
    "updated_at": "2024-04-22T08:37:12Z",
    "line_items": [
      {
        "id": "ed8af005-1f4e-42d1-859d-99b0fd420781",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "variant_id": "a7175820-36b3-4fc6-9baf-51e3035242ba",
        "variant_title": "L-blue-T",
        "product_title": "shirt",
        "product_handle": "shirt",
        "quantity": 1,
        "note": "",
        "fulfillment_status": "shipped",
        "sku": "T-M-L-blue-T-A001008",
        "weight_unit": "kg",
        "vendor": "shoplazza",
        "product_url": "/products/shirt",
        "compare_at_price": "97.00",
        "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
        "price": "81.00",
        "total": "81.00",
        "weight": "1.10",
        "properties": [
          {
            "name": "size",
            "value": "L"
          }
        ],
        "custom_properties": {},
        "refund_quantity": 0,
        "refund_total": "0.00",
        "taxable": true,
        "requires_shipping": true,
        "shipping_quantity": 1
      }
    ]
  }
}

Result

{
    "fulfillment": {
        "id": "51c7dd5d-8f49-40c3-b2c1-5dfdeef9946d",
        "order_id": "633130-00000007",
        "status": "shipped",
        "tracking_company": "燕文物流",
        "tracking_number": "11111111111",
        "tracking_company_code": "DJ-11343",
        "tracking_url": "",
        "created_at": "2024-04-22T08:37:12Z",
        "updated_at": "2024-04-22T08:37:12Z",
        "line_items": [
            {
                "id": "ed8af005-1f4e-42d1-859d-99b0fd420781",
                "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
                "variant_id": "a7175820-36b3-4fc6-9baf-51e3035242ba",
                "variant_title": "L-blue-T",
                "product_title": "shirt",
                "product_handle": "shirt",
                "quantity": 1,
                "note": "",
                "fulfillment_status": "shipped",
                "sku": "T-M-L-blue-T-A001008",
                "weight_unit": "kg",
                "vendor": "shoplazza",
                "product_url": "/products/shirt",
                "compare_at_price": "97.00",
                "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
                "price": "81.00",
                "total": "81.00",
                "weight": "1.10",
                "properties": [
                    {
                        "name": "size",
                        "value": "L"
                    },
                    {
                        "name": "color",
                        "value": "blue"
                    },
                    {
                        "name": "type",
                        "value": "T"
                    }
                ],
                "custom_properties": {},
                "refund_quantity": 0,
                "refund_total": "0.00",
                "taxable": true,
                "requires_shipping": true,
                "shipping_quantity": 1
            }
        ]
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Record not found"
  ]
}

Result

{ "errors": ["Record not found"] }

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "invalid line_item id"
  ]
}

Result

{
  "errors": [
    "invalid line_item id",
    "Shipment not allowed under current status.",
     "The fulfill failed due to insufficient remaining fulfillment quantity",
    "ShipQuantity is required"
    
  ]
}