Ecommerce — Orders

List orders

Unified multi-channel order lines (Amazon, Flipkart, Meesho, Myntra, Snapdeal, JioMart, AJIO, Shopify, offline), newest first. Money is paise integers. Buyer PII (buyerName, shippingAddress) is null unless the key holds ecommerce:pii:read. Requires scope ecommerce:orders:read.

Date filters: orderSince/orderUntil filter by order date (the response's orderDate); invoiceSince/invoiceUntil filter by invoice date (the response's invoiceDate). Orders without an invoice date are excluded when an invoice-date filter is set. since/until are accepted as aliases of orderSince/orderUntil.

get/ecommerce/orders

Request

  • Base URL: https://app.zobrx.com/api/v1
  • URL: https://app.zobrx.com/api/v1/ecommerce/orders
  • Auth: HTTP bearer

Query parameters

orderSincestring date-time

Order date ≥ (ISO 8601, inclusive). Filters on the response's orderDate. Alias: since.

orderUntilstring date-time

Order date ≤ (ISO 8601, inclusive). Filters on the response's orderDate. Alias: until.

invoiceSincestring date-time

Invoice date ≥ (ISO 8601, inclusive). Filters on the response's invoiceDate.

invoiceUntilstring date-time

Invoice date ≤ (ISO 8601, inclusive). Filters on the response's invoiceDate.

channelsstring

CSV of channel codes (amazon,flipkart,meesho,myntra,snapdeal,jiomart,ajio,shopify,offline). Omit for all.

storeIdsstring

CSV of store ids to scope to (overrides channels).

attributionStatestring

CSV of pending-delivery|shipped|delivered|returned|cancelled|prepaid-paid.

settlement'paid' | 'unpaid'
searchstring
limitinteger
offsetinteger

Response

A page of orders.

perChannelCountobject

Changes

No recorded changes to this operation across all 1 revision of this API.