post

/orders/fulfill

Fulfills an order in the Joom system. Call this API once you have shipped the item to the recipient. Joom will notify the user their order has been shipped upon completion of this request.

Returns

If the order is in the APPROVED state, the order is not already fulfilled and all the parameters are correct, the API will mark the order as shipped and return a HTTP status code of 200.

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

note
string

The note to the user when you marked the order as shipped (if applicable)

channelId
string

Required for Joom Express orders. Need to pass channelId value from the shippingOption of the order

Responses

Schema
object
data
object

An order

code
integer

Status code for the request: 0 for success, any other number for failure

1 validation + required
message
string

Human readable description of what went wrong if code is not 0

Send a Test Request

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