Orders
Search Orders
- Developer Sandbox
- Community
- POSTMerchant Search Diamonds
- GETIs In Stock
- GETList Merchant Templates
Diamonds
Inventory
Merchant Templates
Orders
Search Orders
Search Orders. Request query parameters are similar to ListOrders with the addition of ?query= to allow free text search in certain fields.
Returns
An object with a “metadata” field containing pagination information, and an orders field containing a list of order objects.
GET
/
api
/
v2
/
orders
/
search
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
limit
integer
limit
integer
How many results to return at a time in the "orders" field of the response object. Defaults to 50.
offset
integer
offset
integer
How many results to skip. Used for pagination. Defaults to 0.
payment_status
array
payment_status
array
Payment status filter.
fulfillment_status
array
fulfillment_status
array
order_type
array
order_type
array
sort_col
enum<string>
sort_col
enum<string>
Selects a column to sort the orders. Defaults to sorting by the created_on date.
sort_order
enum<string>
sort_order
enum<string>
Order to sort the column.
query
string
query
string
Query string for order searching. This can be used alongside the previously defined filters and pagination parameters. This can be used to search for order/memo ID's, SKU(s), merchant company names, and vendor codes (only with admin token). All of these search parameters can be used simultaneously, just separate with whitespace.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
limit
integer
default: 50How many results to return at a time in the "orders" field of the response object. Defaults to 50.
offset
integer
default: 0How 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_onSelects 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: ascOrder to sort the column.
Available options:
asc, desc query
string
Query string for order searching. This can be used alongside the previously defined filters and pagination parameters. This can be used to search for order/memo ID's, SKU(s), merchant company names, and vendor codes (only with admin token). All of these search parameters can be used simultaneously, just separate with whitespace.
Response
200 - application/json
metadata
object
metadata.limit
integer
metadata.offset
integer
metadata.total_count
integer
orders
object[]
orders.billing_address
object
orders.billing_address.address_1
string
orders.billing_address.address_2
string
orders.billing_address.city
string
orders.billing_address.country_code
string
orders.billing_address.postal_code
string
orders.billing_address.region
string
orders.cancellations
null
orders.events
object[]
orders.events.created_on
string
orders.events.event_data
object
orders.events.event_data.line_items
object[]
orders.events.event_data.line_items.quantity
integer
orders.events.event_data.line_items.uuid
string
orders.events.event_data.order_uuid
string
orders.events.event_data.tracking_company
string
orders.events.event_data.tracking_number
string
orders.events.event_type
string
orders.events.updated_on
string
orders.fulfillment_status
null
orders.fulfillments
object[]
orders.fulfillments.created_on
string
orders.fulfillments.line_items
object[]
orders.fulfillments.line_items.created_on
string
orders.fulfillments.line_items.description
string
orders.fulfillments.line_items.fulfilled_quantity
integer
orders.fulfillments.line_items.fulfillment_status
string
orders.fulfillments.line_items.name
string
orders.fulfillments.line_items.position
integer
orders.fulfillments.line_items.price
integer
orders.fulfillments.line_items.product_data
object
orders.fulfillments.line_items.product_data.fields
object
orders.fulfillments.line_items.product_data.fields.base_currency_code
string
orders.fulfillments.line_items.product_data.fields.base_retail_price
integer
orders.fulfillments.line_items.product_data.fields.base_wholesale_price
integer
orders.fulfillments.line_items.product_data.fields.cert_num
string
orders.fulfillments.line_items.product_data.fields.cert_url
string
orders.fulfillments.line_items.product_data.fields.clarity
string
orders.fulfillments.line_items.product_data.fields.color
string
orders.fulfillments.line_items.product_data.fields.cost
number
orders.fulfillments.line_items.product_data.fields.country_code
string
orders.fulfillments.line_items.product_data.fields.crown_angle
null
orders.fulfillments.line_items.product_data.fields.culet_size
null
orders.fulfillments.line_items.product_data.fields.currency_code
string
orders.fulfillments.line_items.product_data.fields.cut_grade
null
orders.fulfillments.line_items.product_data.fields.cut_grade_description
string
orders.fulfillments.line_items.product_data.fields.delivery_days_max
integer
orders.fulfillments.line_items.product_data.fields.delivery_days_min
integer
orders.fulfillments.line_items.product_data.fields.depth
number
orders.fulfillments.line_items.product_data.fields.depth_percentage
number
orders.fulfillments.line_items.product_data.fields.exchange_rate
integer
orders.fulfillments.line_items.product_data.fields.fluorescence
string
orders.fulfillments.line_items.product_data.fields.girdle_max
string
orders.fulfillments.line_items.product_data.fields.girdle_min
string
orders.fulfillments.line_items.product_data.fields.id
integer
orders.fulfillments.line_items.product_data.fields.image_bottom_url
null
orders.fulfillments.line_items.product_data.fields.image_top_url
string
orders.fulfillments.line_items.product_data.fields.lab
string
orders.fulfillments.line_items.product_data.fields.length
number
orders.fulfillments.line_items.product_data.fields.memo
boolean
orders.fulfillments.line_items.product_data.fields.merchant_template_group
null
orders.fulfillments.line_items.product_data.fields.merchant_template_label
null
orders.fulfillments.line_items.product_data.fields.merchant_template_uuid
null
orders.fulfillments.line_items.product_data.fields.off_rap_price
integer
orders.fulfillments.line_items.product_data.fields.parcel
boolean
orders.fulfillments.line_items.product_data.fields.pavilion_angle
integer
orders.fulfillments.line_items.product_data.fields.pavilion_depth
integer
orders.fulfillments.line_items.product_data.fields.polish_grade
string
orders.fulfillments.line_items.product_data.fields.quantity
integer
orders.fulfillments.line_items.product_data.fields.ratio
integer
orders.fulfillments.line_items.product_data.fields.retail_price
integer
orders.fulfillments.line_items.product_data.fields.returnable
boolean
orders.fulfillments.line_items.product_data.fields.shape
string
orders.fulfillments.line_items.product_data.fields.shape_icon_url
string
orders.fulfillments.line_items.product_data.fields.shape_icon_url_png
string
orders.fulfillments.line_items.product_data.fields.shape_image_url
string
orders.fulfillments.line_items.product_data.fields.sku
string
orders.fulfillments.line_items.product_data.fields.supplier_id
null
orders.fulfillments.line_items.product_data.fields.symmetry_grade
string
orders.fulfillments.line_items.product_data.fields.table_percentage
number
orders.fulfillments.line_items.product_data.fields.type
string
orders.fulfillments.line_items.product_data.fields.ux_url
string
orders.fulfillments.line_items.product_data.fields.vendor_sku
string
orders.fulfillments.line_items.product_data.fields.video_url
null
orders.fulfillments.line_items.product_data.fields.weight
number
orders.fulfillments.line_items.product_data.fields.wholesale_price
integer
orders.fulfillments.line_items.product_data.fields.width
number
orders.fulfillments.line_items.product_id
string
orders.fulfillments.line_items.product_type
string
orders.fulfillments.line_items.properties
null
orders.fulfillments.line_items.quantity
integer
orders.fulfillments.line_items.sku
string
orders.fulfillments.line_items.updated_on
string
orders.fulfillments.line_items.uuid
string
orders.fulfillments.line_items.vendor
string
orders.fulfillments.status
string
orders.fulfillments.tracking_company
string
orders.fulfillments.tracking_number
string
orders.fulfillments.tracking_url
string
orders.fulfillments.updated_on
string
orders.fulfillments.uuid
string
orders.line_items
object[]
orders.line_items.created_on
string
orders.line_items.description
string
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
string
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.properties.name
string
orders.line_items.properties.value
string
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.margins.lab grown
object[]
orders.margins.lab grown.percent
integer
orders.margins.lab grown.weight_max
integer
orders.margins.lab grown.weight_min
number
orders.margins.mined
object[]
orders.margins.mined.percent
integer
orders.margins.mined.weight_max
integer
orders.margins.mined.weight_min
number
orders.memo_due_date
null
orders.memo_id
null
orders.merchant
object
orders.merchant.activated
boolean
orders.merchant.approval_status
string
orders.merchant.billing_address_1
string
orders.merchant.billing_address_2
string
orders.merchant.billing_city
string
orders.merchant.billing_country_code
string
orders.merchant.billing_postal_code
string
orders.merchant.billing_region
string
orders.merchant.braintree_customer_id
string
orders.merchant.business_phone
string
orders.merchant.business_type
string
orders.merchant.cc_emails
null
orders.merchant.deleted
boolean
orders.merchant.email
string
orders.merchant.external_id
string
orders.merchant.first_name
string
orders.merchant.internal_email
string
orders.merchant.last_name
string
orders.merchant.legal_dba
string
orders.merchant.merchant_settings
object
orders.merchant.merchant_settings.margin_mode
string
orders.merchant.onboarding_status
string
orders.merchant.provider
string
orders.merchant.references
object[]
orders.merchant.references.business_phone
string
orders.merchant.references.company_name
string
orders.merchant.references.email
string
orders.merchant.references.first_name
string
orders.merchant.references.last_name
string
orders.merchant.references.position
integer
orders.merchant.references.upload_urls
string[]
orders.merchant.shipping_address_1
string
orders.merchant.shipping_address_2
string
orders.merchant.shipping_city
string
orders.merchant.shipping_country_code
string
orders.merchant.shipping_postal_code
string
orders.merchant.shipping_region
string
orders.merchant.subscription_status
string
orders.merchant.tax_id
string
orders.merchant.url
string
orders.merchant.uuid
string
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
string
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.shipping_address.address_1
string
orders.shipping_address.address_2
string
orders.shipping_address.city
string
orders.shipping_address.country_code
string
orders.shipping_address.postal_code
string
orders.shipping_address.region
string
orders.skus
string[]
orders.tracking
null
orders.uuid
string