Update Fulfillment

🔒
Requires write_order access scope. More access scope

The Update Fulfillment API updates the details of an existing fulfillment, including tracking information and notification preferences. This enables users to modify tracking data and notify customers via email.

This API is especially useful for:

Updating shipment tracking information.
Resending fulfillment email notifications to customers.
Modifying tracking URLs or logistics company details.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`order_id`	string	Yes	`633130-00000012`	Unique identifier for the order.
`fulfillment_id`	string	Yes	`49a731b0-1b7e-47c3-94d9-6d688f36201e`	Unique identifier for the fulfillment.

Body Parameters

Parameter	Type	Required	Example	Description
`tracking_number`	string	No	`DHL1231232113`	Tracking number of the shipment.
`tracking_company`	string	No	`DHL`	Name of the tracking company.
`tracking_company_code`	string	No	`dhl`	Code of the tracking company.
`tracking_url`	string	No	`https://tracking.url`	URL to track the shipment.
`send_email`	boolean	No	`true`	Whether to send email notifications to customers.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Field	Type	Description	Example
`fulfillment`	`object`	Fulfillment details.	`-`
`fulfillment. id`	`string`	Unique ID of the fulfillment.	`51c7dd5d-8f49-40c3-b2c1-5dfdeef9946d`
`fulfillment. order_id`	`string`	Order ID associated with the fulfillment.	`633130-00000007`
`fulfillment. status`	`string`	Status of the fulfillment (`shipped`, `pending`, etc.).	`shipped`
`fulfillment. tracking_company`	`string`	Name of the shipping company.	`燕文物流`
`fulfillment. tracking_number`	`string`	Tracking number for the shipment.	`11111111111`
`fulfillment. tracking_company_code`	`string`	Code of the shipping company.	`DJ-11343`
`fulfillment. tracking_url`	`string`	URL for tracking the shipment.	`https://tracking.example.com`
`fulfillment. created_at`	`string`	Timestamp of creation in ISO-8601 format.	`2024-04-22T08:37:12Z`
`fulfillment. updated_at`	`string`	Timestamp of the last update in ISO-8601 format.	`2024-04-22T08:37:12Z`
`fulfillment. line_items`	`array of objects`	List of fulfilled line items.	`-`
`fulfillment. line_items[]. id`	`string`	Line item ID.	`ed8af005-1f4e-42d1-859d-99b0fd420781`
`fulfillment. line_items[]. product_id`	`string`	Product ID.	`a1a88be0-a1d4-47e4-a2f2-ba6e131cf447`
`fulfillment. line_items[]. variant_id`	`string`	Variant ID of the product.	`a7175820-36b3-4fc6-9baf-51e3035242ba`
`fulfillment. line_items[]. variant_title`	`string`	Title of the product variant.	`L-blue-T`
`fulfillment. line_items[]. product_title`	`string`	Title of the product.	`shirt`
`fulfillment. line_items[]. product_handle`	`string`	Handle of the product.	`shirt`
`fulfillment. line_items[]. quantity`	`integer`	Quantity of the product fulfilled.	`1`
`fulfillment. line_items[]. note`	`string`	Note associated with the line item.	`Special instructions`
`fulfillment. line_items[]. fulfillment_status`	`string`	Fulfillment status for the line item.	`shipped`
`fulfillment. line_items[]. sku`	`string`	SKU of the product.	`T-M-L-blue-T-A001008`
`fulfillment. line_items[]. weight_unit`	`string`	Unit for the weight of the product.	`kg`
`fulfillment. line_items[]. weight`	`string`	Weight of the product.	`1.10`
`fulfillment. line_items[]. vendor`	`string`	Vendor or supplier of the product.	`shoplazza`
`fulfillment. line_items[]. product_url`	`string`	URL of the product page.	`/products/shirt`
`fulfillment. line_items[]. image`	`string`	URL of the product image.	`//cdn.shoplazza.com/image.jpg`
`fulfillment. line_items[]. price`	`string`	Price of the product per unit.	`81.00`
`fulfillment. line_items[]. total`	`string`	Total price for the fulfilled quantity.	`81.00`
`fulfillment. line_items[]. compare_at_price`	`string`	Original (compare at) price of the product.	`97.00`
`fulfillment. line_items[]. properties`	`array of objects`	Custom properties of the line item.	`[{ "name": "size", "value": "L" }]`
`fulfillment. line_items[]. refund_quantity`	`integer`	Quantity refunded from this line item.	`0`
`fulfillment. line_items[]. refund_total`	`string`	Total refunded amount for this line item.	`0.00`
`fulfillment. line_items[]. taxable`	`boolean`	Indicates whether the product is taxable.	`true`
`fulfillment. line_items[]. requires_shipping`	`boolean`	Indicates if shipping is required for the product.	`true`
`fulfillment. line_items[]. shipping_quantity`	`integer`	Quantity being shipped in this fulfillment.	`1`

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Field	Type	Example	Description
`errors`	Array	`[ "invalid line_item id"]`	A list of errors encountered during the request processing.

Field	Type	Example	Description
`error`	String	`"store is not active"`	Indicates an error encountered during the process

Error Detail

Status Code	Message	Possible Reason	Example Response
400	Bad Request	Invalid input format or request structure (e.g., missing required fields or incorrect data types).	`Bad Request`
	Unauthorized	The request is missing valid authentication credentials or the credentials provided are invalid.	`Unauthorized`
404	Record not found	provided `order_id` and `fulfillment_id` is not existing	`{"errors": ["Record not found"]}`

Update Fulfillment

🔒
Requires `write_order` access scope. More access scope

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Body Parameters

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Error Response

Error Detail

API Structure Overview

🔒Requires write_order access scope. More access scope

Request Parameters

Public Request Parameters

📘Public Request Parameters

Path Parameters

Body Parameters

Response Explanation

Public Response Parameters

📘Public Response Parameters

Successful Response

Error Response

Error Detail

API Structure Overview

🔒
Requires `write_order` access scope. More access scope

📘
Public Request Parameters

📘
Public Response Parameters