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.
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.
Joom’s unique identifier for the order, or order_id in the Order object. You can ship several orders made by the same buyer and ordered to the same address together in a single package. To request shipping for the batch of orders repeat this parameter for every order_id (see the example request)
The carrier that will be shipping your package to its destination. See list of accepted providers
Required for Joom Express orders. Need to pass
channel_id value from the
shipping_option from the order.
Request a pickup for this order
ID of the warehouse for pickup
The note to the user when you marked the order as shipped (if applicable)
Contains the status code for the request, 0 means success and any other number implies a failure
Sometimes will store a human readable status message to aid in debugging. It is generally used only for errors