Retrieves the details of a specific fulfillment for an order. This enables users to fetch specific fulfillment data, such as status, tracking information, and related line items

🔒

Requires read_order access scope. More access scope

The Get Fulfillment API retrieves detailed fulfillment data for a specific order, including status, tracking information, and associated line items.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredDescriptionExample
order_idstringYesUnique order identifier"ORD_123ABC"
fulfillment_idstringYesUnique fulfillment identifier"FUL_789XYZ"

Response Description

Public Response Fields

📘

Public Response Parameters

Success Response

ParameterTypeDescriptionExample
codestringStatus code (e.g., "success")"success"
messagestringHuman-readable message"Fulfillment retrieved successfully"
dataobjectContains fulfillment detailsSee data object

data Object

ParameterTypeDescriptionExample
fulfillmentobjectFulfillment dataSee fulfillment object

fulfillment Object

ParameterTypeDescriptionExample
idstringFulfillment unique ID"FUL_789XYZ"
order_idstringAssociated order ID"ORD_123ABC"
statusstringFulfillment state"shipped"
created_atstringCreation timestamp (ISO 8601)"2024-04-15T10:30:00Z"
updated_atstringLast update timestamp (ISO 8601)"2024-04-15T14:45:00Z"
tracking_itemsarrayLogistics tracking detailsSee tracking_items array
line_itemsarrayArray of line items toSee Tracking Items object table

tracking_items

ParameterTypeDescriptionExample
tracking_numberstringCarrier tracking number"SF123456789"
tracking_companystringLogistics company name"SF Express"
tracking_company_codestringCarrier code"SF"
tracking_urlstringTracking URL"https://sf-express.com/track/SF123456789"

line_items Object

ParameterTypeDescription
line_item_idstringLine item ID"ITEM_789"
quantityint32Quantity to fulfill (0 = fulfill all)1 or 0

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!