sale/order/get
POST/sale/order/getThis returns the list of orders available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The order ID to search for specifically.
Filter the list based on the channel order ID.
Filter the list based on customer ID.
Filter the list based on channel ID.
Filter the list based on name.
Filter the list based on email.
Filter the list based on the telephone.
Filter the list based on the order status ID, comma separated.
Filter the list based on the order payment method.
Filter the list based on the shipping method.
Filter the list based on the shipping tracking.
Filter the list based on the shipping date.
Filter the list based on the order postcode.
Filter the list by records after the specified date time based on the filter date type key.
Filter the list by records before the specified date time based on the filter date type key.
The key for the date start and date end filter. Accepts "date_added", "date_modified", "date_ordered".
Filter the list of orders to include deleted records.
Page number of the results.
The key for the ordering of the results. Accepts "order_id", "shipping_date", "date_ordered", "date_added", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"order_id": 0,
"filter_imported_order_id": "string",
"filter_customer_id": 0,
"filter_channel_id": 0,
"filter_name": "string",
"filter_email": "string",
"filter_telephone": "string",
"filter_order_status": "string",
"filter_payment_method": "string",
"filter_shipping_method": "string",
"filter_shipping_tracking": "string",
"filter_shipping_date": "string",
"filter_postcode": "string",
"filter_date_start": "string",
"filter_date_end": "string",
"filter_date_type": "string",
"filter_deleted": 0,
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
The total number of results available.
The list of orders available.
The order ID.
The channel order ID.
The location ID.
The channel ID.
The channel name.
The payment method.
The customer ID.
The order first name.
The order last name.
The order email.
The order first name and last name merged.
The order company.
The order telephone.
The order telephone 2.
The order currency code.
The order currency value.
The order total.
The order cost if user has view permission.
The order date time added.
The order date time last modified.
The order comment.
Indicates if the order is locked from editing.
The order products.
The order address 1.
The order address 2.
The order city.
The order postcode.
The order country.
The order zone.
The order status.
The order status ID.
The order shipping label status ID.
The order blacklist ID.
The order shipping method.
The order shipping tracking.
The order date time shipped.
The order date time placed.
The order total weight.
The order line totals.
The order payout data from its channel.
Additional order data stored.
{
"total": true,
"orders": [
{
"order_id": 0,
"imported_order_id": "string",
"location_id": 0,
"channel_id": 0,
"channel": "string",
"payment_method": "string",
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"email": "string",
"name": "string",
"company": "string",
"telephone": "string",
"telephone_2": "string",
"currency": "string",
"currency_value": 0,
"total": 0,
"cost": 0,
"date_added": "string",
"date_modified": "string",
"comment": "string",
"locked": true,
"products": [
{
"order_product_id": 0,
"imported_order_product_id": "string",
"item_id": 0,
"thumb": "string",
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"discount": 0,
"discount_platform": 0,
"total": 0,
"cost": 0,
"order_status": "string",
"order_status_id": 0,
"weight": 0,
"deducted": true
}
],
"address_1": "string",
"address_2": "string",
"city": "string",
"postcode": "string",
"country": "string",
"zone": "string",
"order_status": "string",
"order_status_id": 0,
"shipping_label_status_id": 0,
"order_blacklist_id": 0,
"shipping_method": "string",
"shipping_tracking": "string",
"shipping_date": "string",
"date_ordered": "string",
"weight": 0,
"payments": [
{
"payment_method": "string",
"total": 0
}
],
"totals": [
{
"code": "string",
"name": "string",
"price": 0,
"sort_order": 0
}
],
"payouts": [
{
"name": "string",
"amount": 0
}
],
"data": [
{
"name": "string",
"value": "string"
}
]
}
]
}