Order

For every item that a user purchases from your store there is a corresponding Order. Each order corresponds with one SKU. The order object provides you with the destination, item and any other required information to fulfill a user’s order.

With this API you can fetch order that require fulfillment and orders that have been updated since a given period. This API also allows you to fulfill one order at a time by providing tracking information for an order.

Order State

Orders can be in several different states depending on what has happened. State APPROVED means that the order is ready to ship. State SHIPPED means that the order has been marked as shipped by you. State REFUNDED means that the order has been refunded to the user and should not be fulfilled. State REQUIRE_REVIEW means that the order is under review for fraudulent activity and should not be fulfilled.

object
ShippingDetail
object

Container for all the details about how to ship the order to its destination

buyer_id
string

Joom’s unique identifier for the buyer of the order

color
string

The color of the item that was ordered (if applicable)

cost
string

The amount of money that Joom pays you for the product (per unit)

days_to_fulfill
string

Number of days left to fulfill this order. Order not fulfilled will be automatically refunded.

discounts
object
hours_to_fulfill
string

Number of hours left to fulfill this order. Order not fulfilled will be automatically refunded.

last_updated
string

The UTC date and time of the last update to the order (for example, the last change in state)

markups
object
order_id
string

Joom’s unique identifier for the order

order_time
string

The UTC date and time of when the order was placed

order_total
string

Final order price with all the discounts and markups applied

price
string

Order price without discounts and markups

product_id
string

Joom’s unique identifier for the Product being ordered

product_image_url
string

The image of the product

1 validation
product_name
string

The name of the product

quantity
string

The number of units that the user has purchased

refunded_by
string
1 validation
refunded_note
string
refunded_reason
string
1 validation
refunded_time
string

The UTC time when the order was refunded

shipped_date
string

The date when the order was marked as shipped

shipping
string

The amount of money user pays for shipping for the product (per unit)

shipping_cost
string

The amount of money that Joom pays you for shipping the product (per unit)

shipping_provider
string

This is the courier that has been used to ship the package

size
string

The size of the item that was ordered (if applicable)

sku
string

The unique identifier of the item in your system

state
string

The state of the order. This value can be: APPROVED, SHIPPED, REFUNDED, REQUIRE_REVIEW

1 validation
transaction_id
string

Orders can be grouped under unique identifiers if the user makes several purchases at once

variant_id
string

Joom’s unique identifier for the Product Variation that was ordered

shipping_option
object

Shipping option for Joom Express orders

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

ship_note
string

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

shipping_time
string

The amount of time it takes for the shipment to reach the buyer. Provide a time range in number of days. Lower bound cannot be less than 2 days