post

/orders/fulfill

Fulfills an order in the Joom system.

This endpoint must be called after you have shipped the order to the recipient.

Either provider or providerId must be specified in the request body, but not both. trackingNumber is required.

Special Conditions

  • Only the approved orders can be fulfilled.

  • Certain orders must be shipped by Joom Logistics and cannot be fulfilled via this endpoint.

Returns

The shipped order.

Request Parameters

1 Query Parameter

Request Body

Schema
object
provider
string

The carrier that will be shipping your package to its destination. See list of accepted providers

providerId
string

ID of the carrier that will be shipping your package to its destination. See list of accepted providers

trackingNumber
string

The unique identifier that your carrier provided so that the user can track their package as it is being delivered. Tracking number should only contain alphanumeric characters with no space between them

Responses

Order

Schema
object
data
object

An order

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host