Skip to main content
POST
Fulfill Order

Fulfill Order

Creates a fulfillment record for an order, marking items as shipped. You can fulfill all items at once or create partial fulfillments.

Request

Path Parameters

string
required
The unique order ID

Body Parameters

string
Tracking number for the shipment
string
Shipping carrier name (e.g., “UPS”, “FedEx”, “USPS”, “DHL”)
string
Full tracking URL
string
default:"pending"
Initial fulfillment status. One of pending, open, success, cancelled, error, failure. A shipped state (success) advances the order to shipped / partial based on the line items covered.
string
Fulfillment service ID associated with this fulfillment.
boolean
default:"true"
Whether to send a shipping notification email to the customer. Only sent when the fulfillment moves the order into a shipped/partial state.
array
Specific line items to fulfill. If not provided (empty), the fulfillment is treated as covering the whole order.

Response

On success (201 Created) the created fulfillment is returned under data.fulfillment.
integer
HTTP status (201 on success).
string
success or error.
string
Human-readable message, or null on success.
object
The created fulfillment object.

Example Response

Tracking Company

tracking_company is stored verbatim as the carrier label — there is no fixed list of accepted values and no carrier normalization. Send the carrier name you want shown (e.g. "UPS", "FedEx") and, where useful, the full tracking_url.

Error Codes