GET
/
consumers
/
{consumer_id}
/
commerce
/
orders
/
{order_id}

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

order_id
string
required
consumer_id
string
required

Query Parameters

include_product_categories
enum<string>
default:
false

Include detailed information about categories

Available options:
true,
false

Response

200 - application/json
currency
string
required

Indicates the currency of the order (e.g. EUR).

current_tax_amount
number
required

Total taxes applied to the order. After returns, removes and returns.

current_total
number
required

Current total of the order with discount. After returns, removes and returns.

current_untaxed_amount
number
required

Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns.

discount_amount
number
required
id
string
required

Technical id in Chift

lines
object[]
required
source_ref
object
required

Technical id in the target software

status
enum<string>
required

An enumeration.

Available options:
cancelled_unpaid,
cancelled,
draft,
confirmed,
shipped,
refunded
tax_amount
number
required

Total taxes applied to the order. Refunds and returns are not included.

tax_amount_without_fees
number
required

Total taxes applied to the order without taxes linked to fees (e.g. shipping).

total
number
required

Total of the order with discount. Refunds and returns are not included.

total_without_fees
number
required

Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included.

untaxed_amount
number
required

Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included.

untaxed_amount_without_fees
number
required

Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included.

billing_address
object
cancelled_on
string
confirmed_on
string
created_on
string
customer
object
delivery_date
string
detailed_refunds
object[]
last_updated_on
string
note
string
order_number
string
other_fees
object[]
payment_method_id
string

Technical id of the payment method in the eCommerce

payment_methods
object[]
refunded_amount
number
default:
0
returns
object[]
shipping_address
object
tags
string[]
transactions
object[]