Orders Object

string

REQUIRED · The unique identifier for an order

order_number

string

The order number for an order

currency

string

The currency associated for amount of an order

exchange_rate

string

The exchange rate for an order's transaction when the currency is different from the store's default currency.

discounts

object[]

The discounts for an order

code

string

The code used to apply the discount

amount

string

The fixed amount of the discount

percentage

string

The percentage of discount

sub_total

string

The sub-total amount for an order

shipping_cost

string

The shipping cost for an order

total_discount

string

The total discount for an order

total_tax

string

The total tax for an order

total_amount

string

The total amount for an order

status

string

The status for an order. If no clear mapping exists, then raw value is returned.

All possible enum values:

active
completed
cancelled
archived
pending

payment_status

string

The payment status for an order. If no clear mapping exists, then raw value is returned.

All possible enum values:

pending
authorized
paid
partial
refunded
voided
cancelled
unknown

fulfillment_status

string

The fullfillment status for an order. If no clear mapping exists, then raw value is returned.

All possible enum values:

pending
partial
delivered
cancelled

payment_method

string

The payment method used for this order

customer

object

The customer this order is linked to

string

The unique identifier for customer

first_name

string

The first name of customer

last_name

string

The last name of customer

name

string

The full name of customer

company_name

string

The company name of customer

emails

object[]

The emails of customer

string

The email of the customer

type

string

The type of email

is_primary

boolean

The status of email

phones

object[]

The phone numbers of customer

number

string

The number of phone

type

string

The type of phone

billing_address

object

The billing address for an order

street_1

string

The first line of billing address

street_2

string

The second line of billing address

company_name

string

The company name of customer

city

string

The city of the billing address

state

string

The state/province of the billng address

postal_code

string

The postal code of the billing address

country

string

The country of the billing address

shipping_address

object

The shipping address for an order

street_1

string

The first line of shipping address

street_2

string

The second line of shipping address

company_name

string

The company name of customer

city

string

The city of the shipping address

state

string

The state/province of the shipping address

postal_code

string

The postal code of the shipping address

country

string

The country of the shipping address

tracking

object

The tracking details for an order

provider

string

REQUIRED · The name of carrier handling the shipment

number

string

REQUIRED · The tracking number of shipment

url

string

The url of tracking page

updated_at

string · date-time

The date and time of last parcel update

line_items

object[]

The line items for an order

name

string

REQUIRED · The name of the line item

quantity

string

REQUIRED · The quantity of the line item

total_amount

string

The total amount of the line item

string

The id of the line item

product_id

string

The product id of the line item

variant_id

string

The variant id of the line item

sku

string

The sku of the line item

description

string

The description of the line item

options

object[]

The options for line item

string

The unique identifier for options

name

string

The name for options

value

string

The value for options

unit_price

string

The unit price of the line item

tax_rate

string

The tax rate of the line item

tax_amount

string

The tax amount of the line item

discounts

object[]

The discounts for line item

code

string

The used for discounts

amount

string

The fixed amount for discounts

percentage

string

The percentage of discounts

note

string

The note for an order

created_at

string · date-time

The date and time when order was created

updated_at

string · date-time

The date and time when order was updated

remote_data

object

Raw data returned from the remote API call.