sale/order/get - Equotix One API

This returns the list of orders available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

order_id

integer

optional

The order ID to search for specifically.

filter_imported_order_id

string

optional

Filter the list based on the channel order ID.

filter_customer_id

integer

optional

Filter the list based on customer ID.

filter_channel_id

integer

optional

Filter the list based on channel ID.

filter_name

string

optional

Filter the list based on name.

filter_email

string

optional

Filter the list based on email.

filter_telephone

string

optional

Filter the list based on the telephone.

filter_order_status

string

optional

Filter the list based on the order status ID, comma separated.

filter_payment_method

string

optional

Filter the list based on the order payment method.

filter_shipping_method

string

optional

Filter the list based on the shipping method.

filter_shipping_tracking

string

optional

Filter the list based on the shipping tracking.

filter_shipping_date

string

optional

Filter the list based on the shipping date.

filter_postcode

string

optional

Filter the list based on the order postcode.

filter_date_start

string

optional

Filter the list by records after the specified date time based on the filter date type key.

filter_date_end

string

optional

Filter the list by records before the specified date time based on the filter date type key.

filter_date_type

string

optional

The key for the date start and date end filter. Accepts "date_added", "date_modified", "date_ordered".

filter_deleted

integer

optional

Filter the list of orders to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "order_id", "shipping_date", "date_ordered", "date_added", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "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

🟢200Success

application/json

Body

total

boolean

optional

The total number of results available.

orders

array [object {42}]

optional

The list of orders available.

order_id

integer

required

The order ID.

imported_order_id

string

required

The channel order ID.

location_id

integer

required

The location ID.

channel_id

integer

required

The channel ID.

channel

string

required

The channel name.

payment_method

string

required

The payment method.

customer_id

integer

required

The customer ID.

firstname

string

required

The order first name.

lastname

string

required

The order last name.

string

required

The order email.

name

string

required

The order first name and last name merged.

company

string

required

The order company.

telephone

string

required

The order telephone.

telephone_2

string

required

The order telephone 2.

currency

string

required

The order currency code.

currency_value

number

required

The order currency value.

total

number

required

The order total.

cost

number

optional

The order cost if user has view permission.

date_added

string

required

The order date time added.

date_modified

string

required

The order date time last modified.

comment

string

required

The order comment.

locked

boolean

required

Indicates if the order is locked from editing.

products

array [object {17}]

required

The order products.

address_1

string

optional

The order address 1.

address_2

string

optional

The order address 2.

city

string

optional

The order city.

postcode

string

optional

The order postcode.

country

string

optional

The order country.

zone

string

optional

The order zone.

order_status

string

optional

The order status.

order_status_id

integer

optional

The order status ID.

shipping_label_status_id

integer

optional

The order shipping label status ID.

order_blacklist_id

integer

optional

The order blacklist ID.

shipping_method

string

optional

The order shipping method.

shipping_tracking

string

optional

The order shipping tracking.

shipping_date

string

optional

The order date time shipped.

date_ordered

string

optional

The order date time placed.

weight

number

optional

The order total weight.

payments

array [object {2}]

optional

totals

array [object {4}]

optional

The order line totals.

payouts

array [object {2}]

optional

The order payout data from its channel.

data

array [object {2}]

optional

Additional order data stored.

Example

{
    "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"
                }
            ]
        }
    ]
}