Skip to main content

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
uspsShipmentArray
capostParcelsArray
capostReturnsArray
capostOffice
mailchimpStoreIdstring
not_finished_order
demoboolean
is_opened_disputeboolean
conversation
childrenArray
parent
vendor
commission
profileTransactionsArray
vendorRatingsArray of objects
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray
reviewKey
order_idinteger
profile
orig_profile
shipping_idinteger
shipping_method_namestring
payment_method_namestring
trackingstring
dateinteger
lastRenewDateinteger
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstring
adminNotesstring
detailsArray
trackingNumbersArray
eventsArray
itemsArray
surchargesArray
payment_transactionsArray
currency
orderNumberstring
recentboolean
xcPendingExportboolean
backorderCompetitorsArray
totalstring
subtotalstring