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

🔒

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

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredDescriptionExample
order_idstringYesOrder's unique identifier"ORD_123456"
fulfillment_idstringYesFulfillment's unique identifier"FUL_123456"

Body Parameters

ParameterTypeRequiredDescriptionExample
line_itemsarrayYesArray of line items to fulfillSee line_items object table
tracking_itemsarrayYesArray of line items toSee Tracking Items object table
phone_numberstringYestrackShipper's phone number"+8613800138000"

line_items Object

ParameterTypeRequiredDescription
line_item_idstringYesLine item ID"ITEM_789"
quantityint32YesQuantity to fulfill (0 = fulfill all)1 or 0

Tracking Items

ParameterTypeRequiredDescription
tracking_numberstringYesTracking number for the shipment"1234567890"
tracking_companystringYesLogistics company name (must be same for multiple numbers)"SF Express"
tracking_company_codestringYesLogistics company code (must match tracking_company)"SF"
tracking_urlstringYesTracking URL (must match tracking_company)"https://sf-express.com/track"

Response Description

Public Response Fields

📘

Public Response Parameters

Success Response

ParameterTypeRequiredDescriptionExample
codestringYesStatus code (e.g., "success")"success"
messagestringYesHuman-readable message"Fulfillment created"
dataobjectYesContains fulfillment details{}

Error Response

FieldTypeDescriptionExample
codestringThe error code indicating the type of issue.InvalidParameter
messagestringA detailed message describing the error.Order id is required.

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!