get https://{subdomain}.myshoplaza.com/openapi/2024-07/orders//fulfillments/
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.
📘 Public Request Parameters
Parameter Type Required Description Example order_id
string Yes Unique order identifier "ORD_123ABC"
fulfillment_id
string Yes Unique fulfillment identifier "FUL_789XYZ"
📘 Public Response Parameters
Parameter Type Description Example code
string Status code (e.g., "success"
) "success"
message
string Human-readable message "Fulfillment retrieved successfully"
data
object Contains fulfillment details See data
object
Parameter Type Description Example fulfillment
object Fulfillment data See fulfillment
object
Parameter Type Description Example id
string Fulfillment unique ID "FUL_789XYZ"
order_id
string Associated order ID "ORD_123ABC"
status
string Fulfillment state "shipped"
created_at
string Creation timestamp (ISO 8601) "2024-04-15T10:30:00Z"
updated_at
string Last update timestamp (ISO 8601) "2024-04-15T14:45:00Z"
tracking_items
array Logistics tracking details See tracking_items
array line_items
array Array of line items to See Tracking Items
object table
Parameter Type Description Example tracking_number
string Carrier tracking number "SF123456789"
tracking_company
string Logistics company name "SF Express"
tracking_company_code
string Carrier code "SF"
tracking_url
string Tracking URL "https://sf-express.com/track/SF123456789"
Parameter Type Description line_item_id
string Line item ID "ITEM_789"
quantity
int32 Quantity to fulfill (0 = fulfill all) 1
or 0
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