List Orders

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:

How many results to return at a time in the "orders" field of the response object. Defaults to 50.

offset

integer

default:

How many results to skip. Used for pagination. Defaults to 0.

payment_status

enum<string>[]

Payment status filter.

Available options:

paid,

unpaid

fulfillment_status

enum<string>[]

Available options:

partial,

fulfilled,

unfulfilled

order_type

enum<string>[]

Available options:

invoice,

memo

sort_col

enum<string>

default:

ordered_on

Selects a column to sort the orders. Defaults to sorting by the created_on date.

Available options:

ordered_on,

total,

merchant_legal_dba

sort_order

enum<string>

default:

asc

Order to sort the column.

Available options:

asc,

desc

Response

200 - application/json

metadata

object

orders

object[]

orders.billing_address

object

orders.cancellations

null

orders.events

object[]

orders.fulfillment_status

null

orders.fulfillments

object[]

orders.line_items

object[]

orders.line_items.created_on

string

orders.line_items.description

string | null

orders.line_items.fulfilled_quantity

integer

orders.line_items.fulfillment_status

string | null

orders.line_items.name

string

orders.line_items.position

integer

orders.line_items.price

integer

orders.line_items.product_data

object

orders.line_items.product_data.fields

object

orders.line_items.product_data.fields.base_currency_code

string

orders.line_items.product_data.fields.base_retail_price

integer

orders.line_items.product_data.fields.base_wholesale_price

integer

orders.line_items.product_data.fields.cert_num

string

orders.line_items.product_data.fields.cert_url

string

orders.line_items.product_data.fields.clarity

string

orders.line_items.product_data.fields.color

string

orders.line_items.product_data.fields.cost

number

orders.line_items.product_data.fields.country_code

string

orders.line_items.product_data.fields.crown_angle

null

orders.line_items.product_data.fields.culet_size

null

orders.line_items.product_data.fields.currency_code

string

orders.line_items.product_data.fields.cut_grade

null

orders.line_items.product_data.fields.cut_grade_description

null

orders.line_items.product_data.fields.delivery_days_max

integer

orders.line_items.product_data.fields.delivery_days_min

integer

orders.line_items.product_data.fields.depth

number

orders.line_items.product_data.fields.depth_percentage

number

orders.line_items.product_data.fields.exchange_rate

integer

orders.line_items.product_data.fields.fluorescence

string

orders.line_items.product_data.fields.girdle_max

string

orders.line_items.product_data.fields.girdle_min

string

orders.line_items.product_data.fields.id

integer

orders.line_items.product_data.fields.image_bottom_url

null

orders.line_items.product_data.fields.image_top_url

string

orders.line_items.product_data.fields.lab

string

orders.line_items.product_data.fields.length

number

orders.line_items.product_data.fields.memo

boolean

orders.line_items.product_data.fields.merchant_template_group

null

orders.line_items.product_data.fields.merchant_template_label

null

orders.line_items.product_data.fields.merchant_template_uuid

null

orders.line_items.product_data.fields.off_rap_price

integer

orders.line_items.product_data.fields.parcel

boolean

orders.line_items.product_data.fields.pavilion_angle

integer

orders.line_items.product_data.fields.pavilion_depth

integer

orders.line_items.product_data.fields.polish_grade

string

orders.line_items.product_data.fields.quantity

integer

orders.line_items.product_data.fields.ratio

integer

orders.line_items.product_data.fields.retail_price

integer

orders.line_items.product_data.fields.returnable

boolean

orders.line_items.product_data.fields.shape

string

orders.line_items.product_data.fields.shape_icon_url

string

orders.line_items.product_data.fields.shape_icon_url_png

string

orders.line_items.product_data.fields.shape_image_url

string

orders.line_items.product_data.fields.sku

string

orders.line_items.product_data.fields.supplier_id

null

orders.line_items.product_data.fields.symmetry_grade

string

orders.line_items.product_data.fields.table_percentage

number

orders.line_items.product_data.fields.type

string

orders.line_items.product_data.fields.ux_url

string

orders.line_items.product_data.fields.vendor_sku

string

orders.line_items.product_data.fields.video_url

null

orders.line_items.product_data.fields.weight

number

orders.line_items.product_data.fields.wholesale_price

integer

orders.line_items.product_data.fields.width

number

orders.line_items.product_id

string | null

orders.line_items.product_type

string

orders.line_items.properties

object[] | null

orders.line_items.quantity

integer

orders.line_items.sku

string

orders.line_items.updated_on

string

orders.line_items.uuid

string

orders.line_items.vendor

string

orders.margins

object

orders.memo_due_date

null

orders.memo_id

null

orders.merchant

object

orders.merchant_uuid

string

orders.notes

string

orders.order_channel

string

orders.order_id

string

orders.order_reference

string

orders.order_type

string

orders.ordered_on

string

orders.payment_status

null

orders.products

object

orders.products.data

object[]

orders.products.data.base_currency_code

string

orders.products.data.base_retail_price

integer

orders.products.data.base_wholesale_price

integer

orders.products.data.cert_num

string

orders.products.data.cert_url

string

orders.products.data.clarity

string

orders.products.data.color

string

orders.products.data.country_code

string

orders.products.data.crown_angle

null

orders.products.data.culet_size

null

orders.products.data.currency_code

string

orders.products.data.cut_grade

null

orders.products.data.cut_grade_description

null

orders.products.data.delivery_days_max

integer

orders.products.data.delivery_days_min

integer

orders.products.data.depth

number

orders.products.data.depth_percentage

number

orders.products.data.exchange_rate

integer

orders.products.data.fluorescence

string

orders.products.data.girdle_max

string

orders.products.data.girdle_min

string

orders.products.data.id

integer

orders.products.data.image_bottom_url

null

orders.products.data.image_top_url

string

orders.products.data.lab

string

orders.products.data.length

number

orders.products.data.memo

boolean

orders.products.data.merchant_template_group

null

orders.products.data.merchant_template_label

null

orders.products.data.merchant_template_uuid

null

orders.products.data.off_rap_price

integer

orders.products.data.parcel

boolean

orders.products.data.pavilion_angle

integer

orders.products.data.pavilion_depth

integer

orders.products.data.polish_grade

string

orders.products.data.quantity

integer

orders.products.data.ratio

integer

orders.products.data.retail_price

integer

orders.products.data.returnable

boolean

orders.products.data.shape

string

orders.products.data.shape_icon_url

string

orders.products.data.shape_icon_url_png

string

orders.products.data.shape_image_url

string

orders.products.data.sku

string

orders.products.data.symmetry_grade

string

orders.products.data.table_percentage

number

orders.products.data.type

string

orders.products.data.ux_url

string

orders.products.data.video_url

null

orders.products.data.weight

number

orders.products.data.wholesale_price

integer

orders.products.data.width

number

orders.provider

string

orders.shipping_address

object

orders.skus

string[]

orders.tracking

null

orders.uuid

string

Diamonds

Inventory

Orders

Merchant Templates

Profit Margins

Defaults

Returns

Authorizations

Query Parameters

Response