🔒
Requires write_order access scope. More access scope
The Create Fulfillment API creates a fulfillment record for specific order items and updates their shipping status.
📘
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|
order_id | string | Yes | Order's unique identifier | "ORD_123456" |
| Parameter | Type | Required | Description | Example |
|---|
line_items | array | Yes | Array of line items to fulfill | See line_items object table |
tracking_items | array | Yes | Array of line items to | See Tracking Items object table |
phone_number | string | Yes | trackShipper's phone number | "+8613800138000" |
| Parameter | Type | Required | Description | |
|---|
line_item_id | string | Yes | Line item ID | "ITEM_789" |
quantity | int32 | Yes | Quantity to fulfill (0 = fulfill all) | 1 or 0 |
| Parameter | Type | Required | Description | |
|---|
tracking_number | string | Yes | Tracking number for the shipment | "1234567890" |
tracking_company | string | Yes | Logistics company name (must be same for multiple numbers) | "SF Express" |
tracking_company_code | string | Yes | Logistics company code (must match tracking_company) | "SF" |
tracking_url | string | Yes | Tracking URL (must match tracking_company) | "https://sf-express.com/track" |
📘
Public Response Parameters
| Parameter | Type | Required | Description | Example |
|---|
code | string | Yes | Status code (e.g., "success") | "success" |
message | string | Yes | Human-readable message | "Fulfillment created" |
data | object | Yes | Contains fulfillment details | See data object |
| Parameter | Type | Required | Description | Example |
|---|
fulfillment_id | string | Yes | Unique ID for the fulfillment | "FUL_123456" |
| Field | Type | Description | Example |
|---|
code | string | The error code indicating the type of issue. | InvalidParameter |
message | string | A detailed message describing the error. | Order id is required. |
| 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 |
