Retrieve orders by conditions
Retrieve orders by conditions
Authorizations:Token
Query Parameters
_cnd[orderNumber] | integerRetrieve order by its number |
_cnd[accessLevel] | stringEnum: "anonymous" "registered" Retrieve order by user access level |
_cnd[dateRange] | Array of integersFilters order by date (timestamp) arranged in two-value array [start, end] |
_cnd[substring] | stringRetrieve order by user login or order number substring |
_cnd[sku] | stringRetrieve order by product sku |
_cnd[recent] | booleanRetrieve only recent (unprocessed) orders |
_cnd[profileId] | integerRetrieve orders by profile id |
_cnd[email] | stringRetrieve orders by user login |
_cnd[paymentStatus] | stringEnum: "A" "PP" "P" "D" "C" "Q" "R" Retrieve orders in certain payment status |
_cnd[shippingStatus] | stringEnum: "N" "P" "S" "D" "WND" "R" "WFA" Retrieve orders in certain shipping status |
_cnd[currency] | integerFilters order by currency id |
_cnd[transactionID] | stringFilters order by payment transaction public_id |
_cnd[zipcode] | stringFilters orders by user zipcode |
_cnd[customerName] | stringFilters orders by customer name |
_cnd[orderByFullname] | stringFilters orders by customer firstname-lastname pair |
_cnd[shippingMethodName] | stringFilters orders by shipping method name |
_cnd[paymentMethodName] | stringFilters orders by payment method name |
_cnd[limit] | Array of stringsSets the offset (first item) and the limit (second item) |
_cnd[orderBy] | Array of stringsSets sorting order field |
Responses
200Success
Response schema:
Success Array
uspsShipment | Array | ||||||||||||||
capostParcels | Array | ||||||||||||||
capostReturns | Array | ||||||||||||||
capostOffice | |||||||||||||||
mailchimpStoreId | string | ||||||||||||||
not_finished_order | |||||||||||||||
demo | boolean | ||||||||||||||
is_opened_dispute | boolean | ||||||||||||||
conversation | |||||||||||||||
children | Array | ||||||||||||||
parent | |||||||||||||||
vendor | |||||||||||||||
commission | |||||||||||||||
profileTransactions | Array | ||||||||||||||
vendorRatings | Array of objects | ||||||||||||||
Array
| |||||||||||||||
usedCoupons | Array | ||||||||||||||
reviewKey | |||||||||||||||
order_id | integer | ||||||||||||||
profile | |||||||||||||||
orig_profile | |||||||||||||||
shipping_id | integer | ||||||||||||||
shipping_method_name | string | ||||||||||||||
payment_method_name | string | ||||||||||||||
tracking | string | ||||||||||||||
date | integer | ||||||||||||||
lastRenewDate | integer | ||||||||||||||
paymentStatus | object | ||||||||||||||
| |||||||||||||||
shippingStatus | object | ||||||||||||||
| |||||||||||||||
notes | string | ||||||||||||||
adminNotes | string | ||||||||||||||
details | Array | ||||||||||||||
trackingNumbers | Array | ||||||||||||||
events | Array | ||||||||||||||
items | Array | ||||||||||||||
surcharges | Array | ||||||||||||||
payment_transactions | Array | ||||||||||||||
currency | |||||||||||||||
orderNumber | string | ||||||||||||||
recent | boolean | ||||||||||||||
xcPendingExport | boolean | ||||||||||||||
backorderCompetitors | Array | ||||||||||||||
total | string | ||||||||||||||
subtotal | string |