post

/orders/fulfillOnline

Call this API via Joom when you are ready to request shipment of an order, using one of our accepted shipping providers that offer online shipping. Joom will automatically transfer the order information, such as package weight, to your shipping carrier of choice. Once the carrier confirms the request, Joom will assign a tracking number to that order.

Returns

If the shipping request is approved by the shipping provider, then API will mark the order as shipped, return a tracking number for the order, and return an HTTP status code of 200.

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

ids
array[string]

Joom’s unique identifiers of orders that should be shipped together

required
channelId
string

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

note
string

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

pickup
boolean

Determines whether carrier should pick up the package from merchant’s warehouse or the merchant wants to bring the package to carrier on his own

warehouseId
string

ID of the merchant’s warehouse from which carrier should pick up the package. If pickup is true and no warehouseId is stated then orders wouldn’t be fulfilled and an appropriate error would be returned

Responses

Schema
object
code
number

Contains the status code for the request, 0 means success and any other number implies a failure

1 validation + required
message
string

Sometimes will store a human readable status message to aid in debugging. It is generally used only for errors

required
object

Send a Test Request

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