Skip to content

Relationships

Schema relationships
graph LR
    Orders -->|"customer"| Customers

Properties

idstring
required·

The unique identifier for an order

billing_addressobject

The billing address for an order

citystring

The city of the billing address

company_namestring

The company name of customer

countrystring

The country of the billing address

postal_codestring

The postal code of the billing address

statestring

The state/province of the billng address

street_1string

The first line of billing address

street_2string

The second line of billing address

created_atstring · date-time

The date and time when order was created

currencystring

The currency associated for amount of an order

customerobject

The customer this order is linked to

References: Customers → id
company_namestring

The company name of customer

emailsobject[]

The emails of customer

3 properties
emailstring

The email of the customer

is_primaryboolean

The status of email

typestring

The type of email

first_namestring

The first name of customer

idstring

The unique identifier for customer

last_namestring

The last name of customer

namestring

The full name of customer

phonesobject[]

The phone numbers of customer

2 properties
numberstring

The number of phone

typestring

The type of phone

discountsobject[]

The discounts for an order

amountstring

The fixed amount of the discount

codestring

The code used to apply the discount

percentagestring

The percentage of discount

exchange_ratestring

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

fulfillment_statusstring

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

Possible values:
pendingpartialdeliveredcancelled
line_itemsobject[]

The line items for an order

namestring
required·

The name of the line item

quantitystring
required·

The quantity of the line item

descriptionstring

The description of the line item

discountsobject[]

The discounts for line item

3 properties
amountstring

The fixed amount for discounts

codestring

The used for discounts

percentagestring

The percentage of discounts

idstring

The id of the line item

optionsobject[]

The options for line item

3 properties
idstring

The unique identifier for options

namestring

The name for options

valuestring

The value for options

product_idstring

The product id of the line item

skustring

The sku of the line item

tax_amountstring

The tax amount of the line item

tax_ratestring

The tax rate of the line item

total_amountstring

The total amount of the line item

unit_pricestring

The unit price of the line item

variant_idstring

The variant id of the line item

notestring

The note for an order

order_numberstring

The order number for an order

payment_methodstring

The payment method used for this order

payment_statusstring

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

Possible values:
pendingauthorizedpaidpartialrefundedvoidedcancelledunknown
remote_dataRecord<string, any>

Raw data returned from the remote API call.

shipping_addressobject

The shipping address for an order

citystring

The city of the shipping address

company_namestring

The company name of customer

countrystring

The country of the shipping address

postal_codestring

The postal code of the shipping address

statestring

The state/province of the shipping address

street_1string

The first line of shipping address

street_2string

The second line of shipping address

shipping_coststring

The shipping cost for an order

shipping_methodsobject

The shipping methods that are associated with the Order.

statusstring

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

Possible values:
activecompletedcancelledarchivedpending
sub_totalstring

The sub-total amount for an order

submitted_datestring
total_amountstring

The total amount for an order

total_discountstring

The total discount for an order

total_taxstring

The total tax for an order

trackingobject

The tracking details for an order

numberstring
required·

The tracking number of shipment

providerstring
required·

The name of carrier handling the shipment

updated_atstring · date-time

The date and time of last parcel update

urlstring

The url of tracking page

typestring

The type of the order

updated_atstring · date-time

The date and time when order was updated