post

/orders/fulfillOnline

Fulfills an order via one of our accepted shipping providers that offer online shipping, including Joom Logistics.

Special Conditions

  • Only orders in state approved can be fulfilled.

  • Certain orders cannot be fulfilled via this endpoint.

  • Pickup is available only for certain locations.

For more information contact your KAM or merchant support.

Returns

Shipping info (including tracking number) for the order.

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
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

pickupAddressId
string

ID of the merchant’s pickup address from which carrier should pick up the package. Required if pickup is true

Responses

Schema
object
trackingNumber
string

The unique identifier that your carrier provided so that the user can track their package as it is being delivered.

shippingOrderNumber
string

Internal order identifier of the carrier (waybill number)

shipperName
string

Name of the first mile shipper

Send a Test Request

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