Shopify Connector Public API

id

long

The ID for the checkout

name

string

Where the checkout originated. Valid values: web , pos , iphone , android

abandoned_checkout_url

string

The recovery URL that's sent to a customer so they can recover their checkout

billing_address_address1

string

The street address of the billing address

billing_address_address2

string

An optional additional field for the street address of the billing address

billing_address_city

string

The customer's city, town, or village

billing_address_company

string

The customer's company

billing_address_country

string

The name of the country of the billing address

billing_address_country_code

string

The two-letter country code corresponding to the customer's country

billing_address_first_name

string

The first name of the person associated with the payment method

billing_address_last_name

string

The last name of the person associated with the payment method

billing_address_latitude

bigdecimal

The latitude of the billing address

billing_address_longitude

bigdecimal

The longitude of the billing address

billing_address_name

string

The full name of the person associated with the payment method

billing_address_phone

string

The phone number at the billing address

billing_address_province

string

The name of the state or province of the billing address

billing_address_province_code

string

The alphanumeric abbreviation of the state or province of the billing address

billing_address_zip

string

The zip or postal code of the billing address

buyer_accepts_marketing

boolean

Whether the customer would like to receive email updates from the shop. This is set by the I want to receive occasional emails about new products, promotions and other news checkbox during checkout

buyer_accepts_sms_marketing

boolean

Whether the customer would like to receive SMS updates from the shop. This is set by the Text me with news and offers checkbox during checkout

cart_token

string

The ID for the cart that's attached to the checkout

closed_at

timestamp

The date and time ( ISO 8601 format ) when the checkout was closed. If the checkout was not closed, then this value is null

completed_at

timestamp

The date and time ( ISO 8601 format ) when the checkout was completed. For abandoned checkouts, this value is null until a customer completes the checkout using the recovery URL

currency

string

The three-letter code ( ISO 4217 format) of the shop's default currency at the time of checkout. For the currency that the customer used at checkout, see presentment_currency

customer_created_at

timestamp

The date and time ( ISO 8601 format) when the customer was created

customer_currency

string

The three-letter code ( ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders

customer_default_address_address1

string

The first line of the customer's mailing address

customer_default_address_address2

string

An additional field for the customer's mailing address

customer_default_address_city

string

The customer's city, town, or village

customer_default_address_company

string

The customer's company

customer_default_address_country

string

The customer's country

customer_default_address_country_code

string

The two-letter country code corresponding to the customer's country

customer_default_address_country_name

string

The customer's normalized country name

customer_default_address_customer_id

long

Customer default address customer id

customer_default_address_default

boolean

Returns true for each default address

customer_default_address_first_name

string

The customer's first name

customer_default_address_id

long

A unique identifier for the address

customer_default_address_last_name

string

The customer's last name

customer_default_address_name

string

The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings . This is different from the id property, which is the ID of the order used by the API. This field can also be set by the API to be any string value

customer_default_address_phone

string

The customer's phone number at this address

customer_default_address_province

string

The customer's region name. Typically a province, a state, or a prefecture

customer_default_address_province_code

string

The alphanumeric code for the customer's region

customer_default_address_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

customer_email

string

The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error

customer_email_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by email. If no date is provided, then the date and time when the consent information was sent is used

customer_email_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by email

customer_email_marketing_consent_state

string

The current email marketing state for the customer

customer_first_name

string

The customer's first name

customer_id

long

A unique identifier for the customer

customer_last_name

string

The customer's last name

customer_last_order_id

long

The ID of the customer's last order

customer_last_order_name

string

The name of the customer's last order. This is directly related to the name field on the Order resource

customer_locale

string

The two or three-letter language code, optionally followed by a region modifier. Example values: en , en-CA

customer_multipass_identifier

string

A unique identifier for the customer that's used with Multipass login

customer_note

string

A note about the customer

customer_orders_count

integer

The number of orders associated with this customer. Test and archived orders aren't counted

customer_phone

string

The unique phone number (<a href="https://en.wikipedia.org/wiki/E.164">E.164 format ) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: 6135551212 +16135551212 (613)555-1212 +1 613-555-1212

customer_sms_marketing_consent_consent_collected_from

string

The source for whether the customer has consented to receive marketing material by SMS

customer_sms_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used

customer_sms_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by SMS

customer_sms_marketing_consent_state

string

The current SMS marketing state for the customer

customer_state

string

The state of the customer's account with a shop. Default value: disabled . Valid values: disabled : The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. invited : The customer has received an email invite to create an account. enabled : The customer has created an account. declined : The customer declined the email invite to create an account

customer_tags

string

Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters

customer_tax_exempt

boolean

Whether the customer is exempt from paying taxes on their order. If true , then taxes won't be applied to an order at checkout. If false , then taxes will be applied at checkout

customer_total_spent

bigdecimal

The total amount of money that the customer has spent across their order history

customer_updated_at

timestamp

The date and time ( ISO 8601 format) when the customer information was last updated

customer_verified_email

boolean

Whether the customer has verified their email address

device_id

long

The ID of the Shopify POS device that created the checkout

discount_codes

string

Discount codes applied to the checkout. Returns an empty array when no codes are applied. Each discount code has the following fields: amount : The amount of the discount in presentment currency. code : The discount code. type : The type of discount. Valid values: percentage , shipping , fixed_amount . (default: fixed_amount )

email

string

The customer's email address

gateway

string

The payment gateway used by the checkout. For abandoned checkouts, this value is always null

landing_site

string

The URL for the page where the customer entered the shop

location_id

long

The ID of the physical location where the checkout was processed

note

string

The text of an optional note that a shop owner can attach to the order

note_attributes

string

Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys

phone

string

The customer's phone number for receiving SMS notifications

presentment_currency

string

The three-letter code ( ISO 4217 format) of the currency that the customer used at checkout. For the shop's default currency, see currency

referring_site

string

The website that referred the customer to the shop

reservation_token

string

Reservation token

shipping_address_address1

string

The street address of the shipping address

shipping_address_address2

string

An optional additional field for the street address of the shipping address

shipping_address_city

string

The city of the shipping address

shipping_address_company

string

The company of the person associated with the shipping address

shipping_address_country

string

The name of the country of the shipping address

shipping_address_country_code

string

The two-letter code ( format) for the country of the shipping address

shipping_address_first_name

string

The first name of the person associated with the shipping address

shipping_address_last_name

string

The last name of the person associated with the shipping address

shipping_address_latitude

bigdecimal

The latitude of the shipping address

shipping_address_longitude

bigdecimal

The longitude of the shipping address

shipping_address_name

string

The full name of the person associated with the shipping address

shipping_address_phone

string

The phone number at the shipping address

shipping_address_province

string

The name of the state or province of the shipping address

shipping_address_province_code

string

The alphanumeric abbreviation of the state or province of the shipping address

shipping_address_zip

string

The zip or postal code of the shipping address

sms_marketing_phone

string

The phone number used to opt in to SMS marketing during checkout

source

string

The channel where the checkout originated. Example value: shopify

source_identifier

string

Source identifier

source_name

string

Where the checkout originated. Valid values: web , pos , iphone , android

source_url

string

Source url

subtotal_price

bigdecimal

The price of the checkout in presentment currency before shipping and taxes

taxes_included

boolean

Whether taxes are included in the price

token

string

A unique ID for a checkout

total_discounts

bigdecimal

The total amount of discounts to be applied in presentment currency

total_duties

bigdecimal

The total duties of the checkout in presentment currency

total_line_items_price

bigdecimal

The sum of the prices of all line items in the checkout in presentment currency

total_price

bigdecimal

The sum of line item prices, all discounts, shipping costs, and taxes for the checkout in presentment currency

total_tax

bigdecimal

The sum of all the taxes applied to the checkout in presentment currency

total_weight

bigdecimal

The sum of all the weights in grams of the line items in the checkout

user_id

long

The ID of the user who created the checkout

created_at

timestamp

The date and time ( ISO 8601 format ) when the checkout was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the checkout was last modified

handle

string

Handle

id

long

The ID of the application charge

name

string

The application charge name

api_client_id

long

Api client id

charge_type

string

Charge type

currency

string

The currency of the price of the application charge

decorated_return_url

string

Decorated return url

external_id

string

External id

price

bigdecimal

The price of the application charge. The minimum price is 0.50, and maximum price is 10,000

return_url

string

The URL where the merchant is redirected after accepting a charge

status

string

The status of the application charge. Valid values: pending : The application charge is pending approval by the merchant. accepted : Removed in version 2021-01 . The application charge has been accepted by the merchant and is ready to be activated by the app. At this point it will appear on the merchant's invoice. As of API version 2021-01, when a merchant accepts a charge, the charge immediately transitions from pending to active . active : The application charge has been activated by the app and will be paid out to the Partner. declined : The application charge was declined by the merchant. expired : The application charge was not accepted within 2 days of being created

test

boolean

Whether the application charge is a test transaction. Valid values: true , null

created_at

timestamp

The date and time ( ISO 8601 format) when the application charge was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the charge was last updated

id

long

The ID of the application credit

amount

bigdecimal

The amount refunded by the application credit

currency

string

The currency of the application credit amount

description

string

The description of the application credit

test

boolean

Whether the application credit is a test transaction. Valid values: true , null

author

string

The name of the author of the article

tag

string

Tag

checksum

string

The MD5 representation of the content, consisting of a string of 32 hexadecimal digits. May be null if an asset has not been updated recently

content_type

string

The MIME representation of the content, consisting of the type and subtype of the asset

key

string

The path to the asset within a theme. It consists of the file's directory and filename. For example, the asset assets/bg-body-green.gif is in the assets directory, so its key is assets/bg-body-green.gif

public_url

string

The public-facing URL of the asset

size

long

The asset size in bytes

theme_id

long

The ID for the theme that an asset belongs to

value

string

The text content of the asset, such as the HTML and Liquid markup of a template file

created_at

timestamp

The date and time ( ISO 8601 format) when the asset was created

updated_at

timestamp

The date and time ( ISO 8601 format) when an asset was last updated

id

long

The ID of the fulfillment order

assigned_location_address1

string

The customer's mailing address

assigned_location_address2

string

An additional field for the customer's mailing address

assigned_location_city

string

The customer's city, town, or village

assigned_location_country_code

string

The two-letter country code corresponding to the customer's country

assigned_location_id

long

The unique identifier for the address

assigned_location_location_id

long

Assigned location id

assigned_location_name

string

The customer's first and last names

assigned_location_phone

string

The customer's phone number at this address

assigned_location_province

string

The customer's region name. Typically a province, a state, or a prefecture

assigned_location_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

destination_address1

string

The first line of the address of the destination

destination_address2

string

The second line of the address of the destination

destination_city

string

The city of the destination

destination_company

string

The company of the destination

destination_country

string

The country of the destination

destination_email

string

The email of the customer at the destination

destination_first_name

string

The first name of the customer at the destination

destination_id

long

The ID of the fulfillment order destination

destination_last_name

string

The last name of the customer at the destination

destination_phone

string

The phone number of the customer at the destination

destination_province

string

The province of the destination

destination_zip

string

The ZIP code of the destination

fulfillment_service_handle

string

Fulfillment service handle

international_duties_incoterm

string

The international duties relevant to the fulfillment order

order_id

long

The ID of the order that's associated with the fulfillment order

request_status

string

The request status of the fulfillment order. Valid values: unsubmitted : The initial request status for the newly-created fulfillment orders. This is the only valid request status for fulfillment orders that aren't assigned to a fulfillment service. submitted : The merchant requested fulfillment for this fulfillment order. accepted : The fulfillment service accepted the merchant's fulfillment request. rejected : The fulfillment service rejected the merchant's fulfillment request. cancellation_requested : The merchant requested a cancellation of the fulfillment request for this fulfillment order. cancellation_accepted : The fulfillment service accepted the merchant's fulfillment cancellation request. cancellation_rejected : The fulfillment service rejected the merchant's fulfillment cancellation request. closed : The fulfillment service closed the fulfillment order without completing it

shop_id

long

The ID of the shop that's associated with the fulfillment order

status

string

The status of the fulfillment order. Valid values: open : Default state for newly created fulfillment orders. in_progress : The fulfillment order is being processed. cancelled : The fulfillment order has been cancelled by the merchant. incomplete : The fulfillment order cannot be completed as requested. closed : The fulfillment order has been completed and closed

supported_actions

string

Supported actions

id

long

The unique identifier of the transaction

adjustment_reason

string

The reason for the adjustment that is associated with the transaction. If the source_type is not an adjustment, the value will be null

amount

bigdecimal

The gross amount of the transaction, in a decimal formatted string

currency

string

The ISO 4217 currency code of the transaction

fee

bigdecimal

The total amount of fees deducted from the transaction amount

net

bigdecimal

The net amount of the transaction

payout_id

long

The id of the payout the transaction was paid out in

payout_status

string

The status of the payout the transaction was paid out in, or 'pending' if the transaction has not yet been included in a payout

source_id

long

The id of the resource leading to the transaction

source_order_id

long

The id of the Order that this transaction ultimately originated from

source_order_transaction_id

string

The id of the Order Transaction that resulted in this balance transaction. If the source_type is an adjustment, the value will be null

source_type

string

The type of the resource leading to the transaction. charge refund dispute reserve adjustment payout

test

boolean

If the transaction was created for a test mode Order or payment

type

string

The type of the balance transaction. The value will be one of the following: charge refund dispute reserve adjustment credit debit payout payout_failure payout_cancellation

processed_at

timestamp

The time the transaction was processed

id

long

The ID of the article

title

string

The title of the article

author

string

The name of the author of the article

blog_id

long

The ID of the blog containing the article

body_html

string

The text of the body of the article, complete with HTML markup

handle

string

A human-friendly unique string for the article that's automatically generated from the article's title. The handle is used in the article's URL

image_alt

string

Image alt attribute

image_created_at

timestamp

The date and time when the product image was created. The API returns this value in ISO 8601 format

image_height

bigdecimal

Height dimension of the image which is determined on upload

image_src

string

Specifies the location of the product image. This parameter supports Liquid filters that you can use to retrieve modified copies of the image

image_width

bigdecimal

Width dimension of the image which is determined on upload

published_at

timestamp

The date and time ( ISO 8601 format) when the article was published

summary_html

string

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page

tags

string

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values

template_suffix

string

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null

user_id

long

A unique numeric identifier for the author of the article

created_at

timestamp

The date and time ( ISO 8601 format) when the article was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the article was last updated

id

long

A unique numeric identifier for the blog

title

string

The title of the blog

commentable

string

Indicates whether readers can post comments to the blog and if comments are moderated or not. Possible values are: no (default) : Readers cannot post comments to blog articles. moderate : Readers can post comments to blog articles, but comments must be moderated before they appear. yes : Readers can post comments to blog articles without moderation

feedburner

string

FeedBurner is a web feed management provider and can be enabled to provide custom RSS feeds for Shopify bloggers. Google has stopped supporting FeedBurner, and new or existing blogs that are not already integrated with FeedBurner can't use the service. This property will default to blank unless FeedBurner is enabled

feedburner_location

string

The URL that points to the FeedBurner location for blogs that have FeedBurner enabled. Google has stopped supporting FeedBurner, and new or existing blogs that are not already integrated with FeedBurner can't use the service. This property will default to blank unless FeedBurner is enabled

handle

string

A human-friendly unique string that is automatically generated from the title if no handle is sent during the creation of a blog. Duplicate handles are appended with an incremental number, for example, 'blog-2'. The handle is customizable and is used by the Liquid templating language to refer to the blog. If you change the handle of a blog, then it can negatively affect the SEO of the shop. We recommend that you create a URL redirect to avoid any SEO issues

tags

string

A list of tags associated with the 200 most recent blog articles. Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3. Tags are limited to 255 characters

template_suffix

string

States the name of the template a blog is using if it is using an alternate template. If a blog is using the default blog.liquid template, the value returned is "null"

created_at

timestamp

The date and time when the blog was created. The API returns this value in ISO 8601 format

updated_at

timestamp

The date and time when changes were last made to the blog's properties. Note that this is not updated when creating, modifying or deleting articles in the blog. The API returns this value in ISO 8601 format

id

long

The ID of the carrier service

name

string

The name of the shipping service as seen by merchants and their customers

active

boolean

Whether this carrier service is active. If true , then the service will be available to serve rates in checkout

callback_url

string

The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL

carrier_service_type

string

Distinguishes between API or legacy carrier services

format

string

The format of the data retu...

id

long

The ID for the collection

title

string

The name of the collection

body_html

string

A description of the collection, complete with HTML markup. Many templates display this on their collection pages

collection_type

string

Collection type

handle

string

A unique, human-readable string for the collection automatically generated from its title. This is used in themes by the Liquid templating language to refer to the collection. (limit: 255 characters)

image_alt

string

The alternative text that describes the collection image

image_created_at

timestamp

The time and date ( format) when the image was added to the collection

image_height

bigdecimal

The height of the image in pixels

image_src

string

The source URL that specifies the location of the image

image_width

bigdecimal

The width of the image in pixels

products_count

integer

Products count

published_at

timestamp

The time and date ( ISO 8601 format) when the collection was made visible. Returns null for a hidden collection

published_scope

string

Whether the collection is published to the Point of Sale channel. Valid values: web : The collection is published to the Online Store channel but not published to the Point of Sale channel. global : The collection is published to both the Online Store channel and the Point of Sale channel

sort_order

string

The order in which products in the collection appear. Valid values: alpha-asc : Alphabetically, in ascending order (A - Z). alpha-desc : Alphabetically, in descending order (Z - A). best-selling : By best-selling products. created : By date created, in ascending order (oldest - newest). created-desc : By date created, in descending order (newest - oldest). manual : In the order set manually by the shop owner. price-asc : By price, in ascending order (lowest - highest). price-desc : By price, in descending order (highest - lowest)

template_suffix

string

The suffix of the liquid template being used. For example, if the value is custom , then the collection is using the collection.custom.liquid template. If the value is null , then the collection is using the default collection.liquid

updated_at

timestamp

The date and time ( ISO 8601 format) when the collection was last modified

id

long

A unique numeric identifier for the collect

collection_id

long

The ID of the custom collection containing the product

position

integer

The position of this product in a manually sorted custom collection. The first position is 1. This value is applied only when the custom collection is sorted manually

product_id

long

The unique numeric identifier for the product in the custom collection

sort_value

long

This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. This value is applied only when the custom collection is sorted manually

created_at

timestamp

The date and time ( ISO 8601 format) when the collect was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the collect was last updated

id

long

A unique numeric identifier for the comment

article_id

long

A unique numeric identifier for the article that the comment belongs to

author

string

The name of the author of the comment

blog_id

long

A unique numeric identifier for the blog containing the article that the comment belongs to

body

string

The basic Textile markup of a comment

body_html

string

The text of the comment, complete with HTML markup

email

string

The email address of the author of the comment

ip

string

The IP address from which the comment was posted

published_at

timestamp

The date and time ( ISO 8601 format) when the comment was published

status

string

The status of the comment. Valid values: pending : The comment has been created but is awaiting spam detection. Depending on the result of the spam detection and the shop owner's comment preferences, this property will be transitioned to either spam , unapproved , or approved . unapproved (default) : The comment is awaiting approval by the shop owner. It's not visible to the readers of the blog. published : The comment has been approved (if the blog requires comments to be approved) and is visible to readers of the blog. spam : The comment has been marked as spam and removed from the Shopify admin. It's not visible to readers of the blog. removed : The comment has been removed by the shop owner. It's not visible to readers of the blog

user_agent

string

The user agent string provided by the software used to create the comment (usually a browser)

created_at

timestamp

The date and time ( ISO 8601 format) when the comment was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the comment was last modified. When the comment is created, this matches the value of created_at . If the blog requires comments to be approved, then this value is updated to the date and time when the comment is approved

id

long

The unique identifier for the address

name

string

The customer's first and last names

address1

string

The customer's mailing address

address2

string

An additional field for the customer's mailing address

city

string

The customer's city, town, or village

company

string

The customer's company

country

string

The customer's country

country_code

string

The two-letter country code corresponding to the customer's country

country_name

string

The customer's normalized country name

customer_id

long

The unique identifier for the customer

default

boolean

Default

first_name

string

The customer's first name

last_name

string

The customer's last name

phone

string

The customer's phone number at this address

province

string

The customer's region name. Typically a province, a state, or a prefecture

province_code

string

The alphanumeric code for the customer's region

zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

id

long

A unique identifier for the customer

currency

string

The three-letter code ( ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders

default_address_address1

string

The first line of the customer's mailing address

default_address_address2

string

An additional field for the customer's mailing address

default_address_city

string

The customer's city, town, or village

default_address_company

string

The customer's company

default_address_country

string

The customer's country

default_address_country_code

string

The two-letter country code corresponding to the customer's country

default_address_country_name

string

The customer's normalized country name

default_address_default

boolean

Returns true for each default address

default_address_first_name

string

The customer's first name

default_address_id

long

A unique identifier for the address

default_address_last_name

string

The customer's last name

default_address_name

string

Default address name

default_address_phone

string

The customer's phone number at this address

default_address_province

string

The customer's region name. Typically a province, a state, or a prefecture

default_address_province_code

string

The alphanumeric code for the customer's region

default_address_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

email

string

The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error

email_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by email. If no date is provided, then the date and time when the consent information was sent is used

email_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by email

email_marketing_consent_state

string

The current email marketing state for the customer

first_name

string

The customer's first name

last_name

string

The customer's last name

last_order_id

long

The ID of the customer's last order

last_order_name

string

The name of the customer's last order. This is directly related to the name field on the Order resource

multipass_identifier

string

A unique identifier for the customer that's used with Multipass login

note

string

A note about the customer

orders_count

integer

The number of orders associated with this customer. Test and archived orders aren't counted

phone

string

The unique phone number (<a href="https://en.wikipedia.org/wiki/E.164">E.164 format ) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: 6135551212 +16135551212 (613)555-1212 +1 613-555-1212

sms_marketing_consent_consent_collected_from

string

The source for whether the customer has consented to receive marketing material by SMS

sms_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used

sms_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by SMS

sms_marketing_consent_state

string

The current SMS marketing state for the customer

state

string

The state of the customer's account with a shop. Default value: disabled . Valid values: disabled : The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. invited : The customer has received an email invite to create an account. enabled : The customer has created an account. declined : The customer declined the email invite to create an account

tags

string

Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters

tax_exempt

boolean

Whether the customer is exempt from paying taxes on their order. If true , then taxes won't be applied to an order at checkout. If false , then taxes will be applied at checkout

total_spent

bigdecimal

The total amount of money that the customer has spent across their order history

verified_email

boolean

Whether the customer has verified their email address

created_at

timestamp

The date and time ( ISO 8601 format) when the customer was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the customer information was last updated

api_type

string

API type

description

string

Description

documentation_url

string

Documentation URL

endpoint

string

Endpoint

graphql_schema_name

string

GraphQL schema name

last_call_at

timestamp

Last call at

migration_deadline

timestamp

Migration deadline

version

string

Version

id

long

The ID for the discount code

code

string

The case-insensitive discount code that customers use at checkout. (maximum: 255 characters) Use the same value for code as the title property of the associated price rule

price_rule_id

long

The ID for the price rule that this discount code belongs to

usage_count

integer

The number of times that the discount code has been redeemed

created_at

timestamp

The date and time ( ISO 8601 format) when the discount code was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the discount code was updated

id

long

The ID of the draft order

name

string

Name of the draft order

applied_discount_amount

bigdecimal

The applied amount of the discount, based on the setting of value_type. For more information, see

applied_discount_description

string

Reason for the discount

applied_discount_title

string

Title of the discount

applied_discount_value

bigdecimal

The value of the discount. If the type of discount is fixed_amount, then it corresponds to a fixed dollar amount. If the type is percentage, then it corresponds to percentage

applied_discount_value_type

string

The type of discount. Valid values: percentage, fixed_amount

billing_address_address1

string

The street address of the billing address

billing_address_address2

string

An optional additional field for the street address of the billing address

billing_address_city

string

The customer's city, town, or village

billing_address_company

string

The customer's company

billing_address_country

string

The name of the country of the billing address

billing_address_country_code

string

The two-letter country code corresponding to the customer's country

billing_address_first_name

string

The first name of the person associated with the payment method

billing_address_last_name

string

The last name of the person associated with the payment method

billing_address_latitude

bigdecimal

The latitude of the billing address

billing_address_longitude

bigdecimal

The longitude of the billing address

billing_address_name

string

The full name of the person associated with the payment method

billing_address_phone

string

The phone number at the billing address

billing_address_province

string

The name of the billing address region, such as province, state, or prefecture

billing_address_province_code

string

The alphanumeric abbreviation of the region for the billing address

billing_address_zip

string

The postal code of the billing address, such as zip, postcode, or Eircode

completed_at

timestamp

The date and time ( ISO 8601 format) when the order is created and the draft order is completed

currency

string

The three letter code ( ISO 4217 format) for the currency used for the payment

customer_created_at

timestamp

The date and time ( ISO 8601 format) when the customer was created

customer_currency

string

The three-letter code ( ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders

customer_default_address_address1

string

The first line of the customer's mailing address

customer_default_address_address2

string

An additional field for the customer's mailing address

customer_default_address_city

string

The customer's city, town, or village

customer_default_address_company

string

The customer's company

customer_default_address_country

string

The customer's country

customer_default_address_country_code

string

The two-letter country code corresponding to the customer's country

customer_default_address_country_name

string

The customer's normalized country name

customer_default_address_customer_id

long

Customer default address customer id

customer_default_address_default

boolean

Returns true for each default address

customer_default_address_first_name

string

The customer's first name

customer_default_address_id

long

A unique identifier for the address

customer_default_address_last_name

string

The customer's last name

customer_default_address_name

string

Customer default address name

customer_default_address_phone

string

The customer's phone number at this address

customer_default_address_province

string

The customer's region name. Typically a province, a state, or a prefecture

customer_default_address_province_code

string

The alphanumeric code for the customer's region

customer_default_address_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

customer_email

string

The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error

customer_email_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by email. If no date is provided, then the date and time when the consent information was sent is used

customer_email_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by email

customer_email_marketing_consent_state

string

The current email marketing state for the customer

customer_first_name

string

The customer's first name

customer_id

long

Customer id

customer_last_name

string

The customer's last name

customer_last_order_id

long

The ID of the customer's last order

customer_last_order_name

string

The name of the customer's last order. This is directly related to the name field on the Order resource

customer_multipass_identifier

string

A unique identifier for the customer that's used with Multipass login

customer_note

string

A note about the customer

customer_orders_count

integer

The number of orders associated with this customer. Test and archived orders aren't counted

customer_phone

string

The unique phone number (<a href="https://en.wikipedia.org/wiki/E.164">E.164 format ) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: 6135551212 +16135551212 (613)555-1212 +1 613-555-1212

customer_sms_marketing_consent_consent_collected_from

string

The source for whether the customer has consented to receive marketing material by SMS

customer_sms_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used

customer_sms_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by SMS

customer_sms_marketing_consent_state

string

The current SMS marketing state for the customer

customer_state

string

The state of the customer's account with a shop. Default value: disabled . Valid values: disabled : The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. invited : The customer has received an email invite to create an account. enabled : The customer has created an account. declined : The customer declined the email invite to create an account

customer_tags

string

Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters

customer_tax_exempt

boolean

Whether the customer is exempt from paying taxes on their order. If true , then taxes won't be applied to an order at checkout. If false , then taxes will be applied at checkout

customer_total_spent

bigdecimal

The total amount of money that the customer has spent across their order history

customer_updated_at

timestamp

The date and time ( ISO 8601 format) when the customer information was last updated

customer_verified_email

boolean

Whether the customer has verified their email address

email

string

The customer's email address

invoice_sent_at

timestamp

The date and time ( ISO 8601 format) when the invoice was emailed to the customer

invoice_url

string

The URL for the invoice

note

string

The text of an optional note that a merchant can attach to the draft order

note_attributes

string

The extra information that's added to the order. The information appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys

order_id

long

The ID of the order that's created and associated with the draft order after the draft order is completed

payment_terms

string

The terms and conditions under which a payment should be processed. amount : The amount that is owed according to the payment terms. currency : The presentment currency for the payment. payment_terms_name : The name of the selected payment terms template for the draft order. payment_terms_type : The type of selected payment terms template for the draft order. due_in_days : The number of days between the invoice date and due date that is defined in the selected payment terms template. payment_schedules : An array of schedules associated to the payment terms. amount : The amount that is owed according to the payment terms. currency : The presentment currency for the payment. issued_at : The date and time when the payment terms were initiated. due_at : The date and time when the payment is due. Calculated based on issued_at and due_in_days or a customized fixed date if the type is fixed. completed_at : The date and time when the purchase is completed. Returns null initially and updates when the payment is captured. expected_payment_method : The name of the payment method gateway

presentment_currency

string

The three letter code ( ISO 4217 format) for the currency used for the payment

shipping_address_address1

string

The street address of the shipping address

shipping_address_address2

string

An optional additional field for the street address of the shipping address

shipping_address_city

string

The city of the shipping address

shipping_address_company

string

The company of the person associated with the shipping address

shipping_address_country

string

The name of the country of the shipping address

shipping_address_country_code

string

The two-letter code for the country of the shipping address

shipping_address_first_name

string

The first name of the person associated with the payment method

shipping_address_last_name

string

The last name of the person associated with the payment method

shipping_address_latitude

bigdecimal

The latitude of the shipping address

shipping_address_longitude

bigdecimal

The longitude of the shipping address

shipping_address_name

string

The full name of the person associated with the payment method

shipping_address_phone

string

The phone number at the shipping address

shipping_address_province

string

The name of the state or province of the shipping address

shipping_address_province_code

string

The alphanumeric abbreviation of the state or province of the shipping address

shipping_address_zip

string

The zip or postal code of the shipping address

shipping_line_custom

boolean

Whether this is a regular shipping line or custom shipping line

shipping_line_handle

string

The handle of the shipping rate which was selected and applied. Required for regular shipping lines

shipping_line_price

bigdecimal

The price of the shipping method. Required for custom shipping lines

shipping_line_title

string

The title of the shipping method. Required for custom shipping lines. (maximum: 255 characters)

status

string

The status of a draft order as it transitions into an order. When a draft order is created it is set to open status. The invoice can then be sent to the customer, and status changes to invoice_sent . The draft order can then be paid, set to pending, or paid by credit card. In each case, the draft order is set to completed and an order is created. After a draft order is set to completed the only further modifications that can be made are adding tags or metafields. Valid values: open : Draft order is open. invoice_sent : Invoice has been sent for the draft order. completed : Draft order has been completed and turned into an order

subtotal_price

bigdecimal

The price of the order before shipping and taxes

subtotal_price_set_presentment_money_amount

bigdecimal

The price of the order before shipping and taxes. Presentment Money Amount

subtotal_price_set_presentment_money_currency_code

string

The price of the order before shipping and taxes. Presentment Money Currency code

subtotal_price_set_shop_money_amount

bigdecimal

The price of the order before shipping and taxes. Shop money Amount

subtotal_price_set_shop_money_currency_code

string

The price of the order before shipping and taxes. Shop money Currency code

tags

string

A comma-seperated list of additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length. For example, tags: "tag1","tag2","tag3"

tax_exempt

boolean

Whether taxes are exempt for the draft order. If set to false , then Shopify refers to the taxable field for each line_item . If a customer is applied to the draft order, then Shopify uses the customer's tax_exempt field instead

taxes_included

boolean

Whether taxes are included in the order subtotal. Valid values: true or false

total_additional_fees_set_presentment_money_amount

bigdecimal

Total additional fees. Presentment Money Amount

total_additional_fees_set_presentment_money_currency_code

string

Total additional fees. Presentment Money Currency code

total_additional_fees_set_shop_money_amount

bigdecimal

Total additional fees. Shop money Amount

total_additional_fees_set_shop_money_currency_code

string

Total additional fees. Shop money Currency code

total_discounts_set_presentment_money_amount

bigdecimal

Total discounts. Presentment Money Amount

total_discounts_set_presentment_money_currency_code

string

Total discounts. Presentment Money Currency code

total_discounts_set_shop_money_amount

bigdecimal

Total discounts. Shop money Amount

total_discounts_set_shop_money_currency_code

string

Total discounts. Shop money Currency code

total_duties_set_presentment_money_amount

bigdecimal

Total duties. Presentment Money Amount

total_duties_set_presentment_money_currency_code

string

Total duties. Presentment Money Currency code

total_duties_set_shop_money_amount

bigdecimal

Total duties. Shop money Amount

total_duties_set_shop_money_currency_code

string

Total duties. Shop money Currency code

total_line_items_price_set_presentment_money_amount

bigdecimal

Total line items price. Presentment Money Amount

total_line_items_price_set_presentment_money_currency_code

string

Total line items price. Presentment Money Currency code

total_line_items_price_set_shop_money_amount

bigdecimal

Total line items price. Shop money Amount

total_line_items_price_set_shop_money_currency_code

string

Total line items price. Shop money Currency code

total_price

bigdecimal

The sum of all the prices of all the items in the order, including taxes and discounts

total_price_set_presentment_money_amount

bigdecimal

The sum of all the prices of all the items in the order, including taxes and discounts. Presentment Money Amount

total_price_set_presentment_money_currency_code

string

The sum of all the prices of all the items in the order, including taxes and discounts. Presentment Money Currency code

total_price_set_shop_money_amount

bigdecimal

The sum of all the prices of all the items in the order, including taxes and discounts. Shop money Amount

total_price_set_shop_money_currency_code

string

The sum of all the prices of all the items in the order, including taxes and discounts. Shop money Currency code

total_shipping_price_set_presentment_money_amount

bigdecimal

Total shipping price. Presentment Money Amount

total_shipping_price_set_presentment_money_currency_code

string

Total shipping price. Presentment Money Currency code

total_shipping_price_set_shop_money_amount

bigdecimal

Total shipping price. Shop money Amount

total_shipping_price_set_shop_money_currency_code

string

Total shipping price. Shop money Currency code

total_tax

bigdecimal

The sum of all the taxes applied to the order

total_tax_set_presentment_money_amount

bigdecimal

The sum of all the taxes applied to the order. Presentment Money Amount

total_tax_set_presentment_money_currency_code

string

The sum of all the taxes applied to the order. Presentment Money Currency code

total_tax_set_shop_money_amount

bigdecimal

The sum of all the taxes applied to the order. Shop money Amount

total_tax_set_shop_money_currency_code

string

The sum of all the taxes applied to the order. Shop money Currency code

created_at

timestamp

The date and time ( ISO 8601 format) when the order was created in Shopify

updated_at

timestamp

The date and time ( ISO 8601 format) when the order was last modified

id

long

An ID for the fulfillment event

address1

string

The street address where the fulfillment event occurred

address2

string

An optional additional field for the street address of the billing address

city

string

The city where the fulfillment event occurred

country

string

The country where the fulfillment event occurred

estimated_delivery_at

timestamp

The estimated delivery date based on the fulfillment's tracking number, as long as it's provided by one of the following carriers: USPS, FedEx, UPS, or Canada Post (Canada only). Value is null if no tracking number is available or if the tracking number is from an unsupported carrier. This property is available only when carrier calculated rates are in use.'

fulfillment_id

long

An ID for the fulfillment that's associated with the fulfillment event

happened_at

timestamp

The date and time ( ISO 8601 format) when the fulfillment event occurred

latitude

bigdecimal

A geographic coordinate specifying the latitude of the fulfillment event

longitude

bigdecimal

A geographic coordinate specifying the longitude of the fulfillment event

message

string

An arbitrary message describing the status. Can be provided by a shipping carrier

order_id

long

The ID of the order that's associated with the fulfillment event

province

string

The province where the fulfillment event occurred

shop_id

long

An ID for the shop that's associated with the fulfillment event

status

string

The status of the fulfillment event. Valid values: attempted_delivery : Delivery of the shipment was attempted, but unable to be completed. carrier_picked_up : A carrier picked up the shipment. confirmed : The carrier is aware of the shipment, but hasn't received it yet. delayed : The shipment is delayed. delivered : The shipment was successfully delivered. failure : Something went wrong when pulling tracking information for the shipment. For example, the tracking number was invalid or the shipment was canceled. in_transit : The shipment is being transported between shipping facilities on the way to its destination. label_printed : A label for the shipment was purchased and printed. label_purchased : A label for the shipment was purchased, but not printed. out_for_delivery : The shipment is being delivered to its final destination. picked_up : The shipment was successfully picked up. ready_for_pickup : The shipment is ready for pickup

zip

string

The zip code of the location where the fulfillment event occurred

created_at

timestamp

The date and time ( ISO 8601 format) when the fulfillment event was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the fulfillment event was updated

id

long

An ID for the fulfillment order

assigned_location_address1

string

The customer's mailing address

assigned_location_address2

string

An additional field for the customer's mailing address

assigned_location_city

string

The customer's city, town, or village

assigned_location_country_code

string

The two-letter country code corresponding to the customer's country

assigned_location_id

long

The unique identifier for the address

assigned_location_location_id

long

Location id

assigned_location_name

string

The customer's first and last names

assigned_location_phone

string

The customer's phone number at this address

assigned_location_province

string

The customer's region name. Typically a province, a state, or a prefecture

assigned_location_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

channel_id

long

Channel id

delivery_method

string

Delivery method

destination_address1

string

The street address of the assigned location

destination_address2

string

An optional additional field for the street address of the assigned location

destination_city

string

The city of the destination

destination_company

string

The company of the destination

destination_country

string

The country of the destination

destination_email

string

The email of the customer at the destination

destination_first_name

string

The first name of the customer at the destination

destination_id

long

The ID of the fulfillment order destination

destination_last_name

string

The last name of the customer at the destination

destination_phone

string

The phone number of the customer at the destination

destination_province

string

The province of the destination

destination_zip

string

The ZIP code of the destination

fulfill_at

timestamp

The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, a scheduled fulfillment order is automatically transitioned to open . For example, the fulfill_at date for a subscription order might be the 1st of each month, a pre-order fulfill_at date would be nil , and a standard order fulfill_at date would be the order creation date. For more information about fulfillment statuses, refer to the status property

fulfill_by

string

The latest date and time by which all items in the fulfillment order need to be fulfilled

international_duties_incoterm

string

The method of duties payment. Valid values:

order_id

long

The ID of the order that's associated with the fulfillment order

order_name

string

Order name

order_processed_at

timestamp

The date and time (ISO 8601 format) when the order was processed

request_status

string

The request status of the fulfillment order. Valid values: unsubmitted : The initial request status for newly-created fulfillment orders. This is the only valid request status for fulfillment orders that aren't assigned to a fulfillment service. submitted : The merchant requested fulfillment for this fulfillment order. accepted : The fulfillment service accepted the merchant's fulfillment request. rejected : The fulfillment service rejected the merchant's fulfillment request. cancellation_requested : The merchant requested a cancellation of the fulfillment request for this fulfillment order. cancellation_accepted : The fulfillment service accepted the merchant's fulfillment cancellation request. cancellation_rejected : The fulfillment service rejected the merchant's fulfillment cancellation request. closed : The fulfillment service closed the fulfillment order without completing it

shop_id

long

The ID of the shop that's associated with the fulfillment order

status

string

The status of the fulfillment order. Valid values: open : The fulfillment order is ready for fulfillment. in_progress : The fulfillment order is being processed. scheduled : The fulfillment order is deferred and will be ready for fulfillment after the datetime specified in fulfill_at . cancelled : The fulfillment order has been cancelled by the merchant. on_hold : The fulfillment order is on hold. The fulfillment process can't be initiated until the hold on the fulfillment order is released. incomplete : The fulfillment order cannot be completed as requested. closed : The fulfillment order has been completed and closed

supported_actions

string

The actions that can be performed on this fulfillment order

created_at

timestamp

The date and time ( ISO 8601 format) when the fulfillment order was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the fulfillment order was last updated

id

long

The unique identifier of the location associated with the fulfillment service

name

string

The name of the fulfillment service as seen by merchants

callback_url

string

The callback URL that the fulfillment service has registered for requests. The following considerations apply: Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders, if tracking_support is set to true . Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels, if inventory_management is set to true . Shopify uses the callback_url/fulfillment_order_notification endpoint to send fulfillment and cancellation requests if the fulfillment service has opted in to the fulfillment order based workflow for managing fulfillments ( fulfillment_orders_opt_in is set to true ). The callback_url field is required if inventory_management , tracking_support , or fulfillment_orders_opt_in is set to true

email

string

Email

fulfillment_orders_opt_in

boolean

Whether the fulfillment service uses the fulfillment order based workflow for managing fulfillments. As of 2022-07 API version , the fulfillment order based workflow is the only way to manage fulfillments, and fulfillment_orders_opt_in must be set to true . As the migration is now finished, the fulfillment_orders_opt_in property is deprecated and is always set to true on correctly functioning fulfillment services

handle

string

Human-readable unique identifier for this fulfillment service

include_pending_stock

boolean

Include pending stock

inventory_management

boolean

Whether the fulfillment service tracks product inventory and provides updates to Shopify. Valid values: true and false

location_id

long

The unique identifier of the location associated with the fulfillment service

provider_id

long

A unique identifier for the fulfillment service provider

service_name

string

Service name

tracking_support

boolean

Whether the fulfillment service provides tracking numbers for packages. Valid values: true and false

id

long

The ID for the fulfillment

name

string

The uniquely identifying fulfillment name, consisting of two parts separated by a . . The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1 , #1001.2 )

location_id

long

The unique identifier of the location that the fulfillment was processed at. To find the ID of the location, use the Location resource

order_id

long

The unique numeric identifier for the order

origin_address_address1

string

(string) The street address of the fulfillment location

origin_address_address2

string

(string) The second line of the address. Typically the number of the apartment, suite, or unit

origin_address_city

string

(string) The city of the fulfillment location

origin_address_country_code

string

(string) (required) The two-letter country code ( format) of the fulfillment location

origin_address_province_code

string

(string) The province of the fulfillment location

origin_address_zip

string

(string) The zip code of the fulfillment location

receipt_authorization

long

The authorization code

receipt_testcase

boolean

Whether the fulfillment was a testcase

service

string

The fulfillment service associated with the fulfillment

shipment_status

string

The current shipment status of the fulfillment. Valid values: label_printed : A label for the shipment was purchased and printed. label_purchased : A label for the shipment was purchased, but not printed. attempted_delivery : Delivery of the shipment was attempted, but unable to be completed. ready_for_pickup : The shipment is ready for pickup at a shipping depot. confirmed : The carrier is aware of the shipment, but hasn't received it yet. in_transit : The shipment is being transported between shipping facilities on the way to its destination. out_for_delivery : The shipment is being delivered to its final destination. delivered : The shipment was succesfully delivered. failure : Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled

status

string

The status of the fulfillment. Valid values: pending : Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to 'open' or 'success'. open : The fulfillment has been acknowledged by the service and is in processing. success : The fulfillment was successful. cancelled : The fulfillment was cancelled. error : There was an error with the fulfillment request. failure : The fulfillment request failed

tracking_company

string

The name of the tracking company. For the tracking company names from the list below Shopify automatically builds tracking URLs for all of the provided tracking numbers, which makes the tracking numbers clickable in the interface. Additionally, for the tracking companies listed on the Shipping Carriers help page Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process. Note Send the tracking company name exactly as written in the list below (capitalization matters). Supported tracking companies The following tracking companies display for shops located in any country: 4PX AGS Amazon Logistics UK Amazon Logistics US An Post Anjun Logistics APC Asendia USA Australia Post Bonshaw BPost BPost International Canada Post Canpar CDL Last Mile China Post Chronopost Chukou1 Colissimo Comingle Coordinadora Correios Correos CTT CTT Express Cyprus Post Delnext Deutsche Post DHL eCommerce DHL eCommerce Asia DHL Express DPD DPD Local DPD UK DTD Express DX Eagle Estes Evri FedEx First Global Logistics First Line FSC Fulfilla GLS Guangdong Weisuyi Information Technology (WSE) Heppner Internationale Spedition GmbH & Co. Iceland Post IDEX Israel Post Japan Post (EN) Japan Post (JA) La Poste Lasership Latvia Post Lietuvos Paštas Logisters Lone Star Overnight M3 Logistics Meteor Space Mondial Relay New Zealand Post NinjaVan North Russia Supply Chain (Shenzhen) Co. OnTrac Packeta Pago Logistics Ping An Da Tengfei Express Pitney Bowes Portal PostNord Poste Italiane PostNL PostNord DK PostNord NO PostNord SE Purolator Qxpress Qyun Express Royal Mail Royal Shipments Sagawa (EN) Sagawa (JA) Sendle SF Express SFC Fulfillment SHREE NANDAN COURIER Singapore Post Southwest Air Cargo StarTrack Step Forward Freight Swiss Post TForce Final Mile Tinghao TNT Toll IPEC United Delivery Service UPS USPS Venipak We Post Whistl Wizmo WMYC Xpedigo XPO Logistics Yamato (EN) Yamato (JA) YiFan Express YunExpress The following tracking companies are displayed for shops located in specific countries: Australia : Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics Austria : Österreichische Post Bulgaria : Speedy Canada : Intelcom, BoxKnight, Loomis, GLS China : China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC Czechia : Zásilkovna Germany : Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS Spain : SEUR France : Colissimo, Mondial Relay, Colis Privé, GLS United Kingdom : Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells Greece : ACS Courier Hong Kong SAR : SF Express Ireland : Fastway, DPD Ireland India : DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart Italy : BRT, GLS Italy Japan : エコ配, 西濃運輸, 西濃スーパーエキスプレス, 福山通運, 日本通運, 名鉄運輸, 第一貨物 Netherlands : DHL Parcel, DPD Norway : Bring Poland : Inpost Turkey : PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo United States : GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo South Africa : Fastway, Skynet

tracking_number

string

A tracking number provided by the shipping company. If multiple tracking numbers are set on this fulfillment, only the first one will be returned in the tracking_number field. Use the tracking_numbers array field to access all tracking numbers associated with this fulfillment. Note With the REST API, you can set only one tracking number and one tracking URL per fulfillment. If you send multiple shipments with one fulfillment, you may want to specify tracking numbers and tracking URLs for all of them. You can do it with the equivalent GraphQL FulfillmentCreateV2 and fulfillmentTrackingInfoUpdateV2 mutations

tracking_numbers

string

A list of tracking numbers provided by the shipping company. Note With the REST API, you can set only one tracking number and one tracking URL per fulfillment. If you send multiple shipments with one fulfillment, you may want to specify tracking numbers and tracking URLs for all of them. You can do it with the equivalent GraphQL FulfillmentCreateV2 and fulfillmentTrackingInfoUpdateV2 mutations. The tracking numbers are clickable in the interface if one of the following applies (the highest in the list has the highest priority): Tracking URL provided in the url field. Shopify-known tracking company name specified in the company field. Shopify will build the tracking url automatically based on the tracking number specified. The tracking number has a Shopify-known format. Shopify will guess the tracking provider and build the tracking url based on the tracking number format. Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. This can result in an invalid tracking URL. It is highly recommended that you send the tracking company and the tracking URL

tracking_url

string

The URL to track the fulfillment. If multiple tracking urls are set on this fulfillment, only the first one will be returned in the tracking_url field. Use the tracking_urls array field for accessing all tracking URLs associated with this fulfillment. Note With the REST API, you can set only one tracking number and one tracking URL per fulfillment. If you send multiple shipments with one fulfillment, you may want to specify tracking numbers and tracking URLs for all of them. You can do it with the equivalent GraphQL FulfillmentCreateV2 and fulfillmentTrackingInfoUpdateV2 mutations

tracking_urls

string

The URLs of tracking pages for the fulfillment. The tracking URLs are displayed in the merchant's admin on the order page. The tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer. When accounts are enabled, the tracking URLs are also displayed in the customer's order history. Note With the REST API, you can set only one tracking number and one tracking URL per fulfillment. If you send multiple shipments with one fulfillment, you may want to specify tracking numbers and tracking URLs for all of them. You can do it with the equivalent GraphQL FulfillmentCreateV2 and fulfillmentTrackingInfoUpdateV2 mutations

created_at

timestamp

The date and time when the fulfillment was created. The API returns this value in ISO 8601 format

updated_at

timestamp

The date and time ( ISO 8601 format ) when the fulfillment was last modified

id

long

The ID of the gift card

api_client_id

long

The ID of the client that issued the gift card

balance

bigdecimal

The balance of the gift card

currency

string

The currency of the gift card

customer_id

long

The ID of the customer associated with this gift card

disabled_at

timestamp

The date and time ( ISO 8601 format) when the gift card was disabled

expires_on

date

The date ( YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date

initial_value

bigdecimal

The initial value of the gift card when it was created

last_characters

string

The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved

line_item_id

long

The ID of the line item that initiated the creation of this gift card, if it was created by an order

message

string

Message

note

string

An optional note that a merchant can attach to the gift card that isn't visible to customers

notify

string

Notify

order_id

long

The ID of the order that initiated the creation of this gift card, if it was created by an order

recipient_id

long

Recipient id

send_on

string

Send on

template_suffix

string

The suffix of the Liquid template that's used to render the gift card online. For example, if the value is birthday , then the gift card is rendered using the template gift_card.birthday.liquid . When the value is null , the default gift_card.liquid template is used

user_id

long

The ID of the user that issued the gift card, if it was issued by a user

created_at

timestamp

The date and time ( ISO 8601 format) when the gift card was created

updated_at

timestamp

The date and time ( ISO 8601 format) when the gift card was last modified

id

long

The ID of the inventory item

cost

bigdecimal

The unit cost of the inventory item. The shop's default currency is used

country_code_of_origin

string

The country code ( ISO 3166-1 alpha-2 ) of where the item came from

harmonized_system_code

long

The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code ('countryHarmonizedSystemCode') is not available

province_code_of_origin

string

The province code ( ISO 3166-2 alpha-2 ) of where the item came from. The province code is only used if the shipping provider for the inventory item is Canada Post

requires_shipping

boolean

Whether a customer needs to provide a shipping address when placing an order containing the inventory item

sku

string

The unique SKU (stock keeping unit) of the inventory item. Case-sensitive string

tracked

boolean

Whether inventory levels are tracked for the item. If true, then the inventory quantity changes are tracked by Shopify

created_at

timestamp

The date and time ( ISO 8601 format ) when the inventory item was created

updated_at

timestamp

The date and time ( ISO 8601 format ) when the inventory item was last modified

available

boolean

The available quantity of an inventory item at the inventory level's associated location. Returns null if the inventory item is not tracked

inventory_item_id

long

The ID of the inventory item associated with the inventory level. To find the ID of an inventory item, use the Inventory Item resource

location_id

long

The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource

updated_at

timestamp

The date and time ( ISO 8601 format ) when the inventory level was last modified

id

long

The ID of the location

name

string

The name of the location

active

boolean

Whether the location is active. If true , then the location can be used to sell products, stock inventory, and fulfill orders. Merchants can deactivate locations from the Shopify admin. Deactivated locations don't contribute to the shop's location limit

address1

string

The location's street address

address2

string

The optional second line of the location's street address

city

string

The city the location is in

country

string

The country the location is in

country_code

string

The two-letter code ( ISO 3166-1 alpha-2 format) corresponding to country the location is in

country_name

string

The localized name of the location's country

legacy

boolean

Whether this is a fulfillment service location. If true , then the location is a fulfillment service location. If false , then the location was created by the merchant and isn't tied to a fulfillment service

localized_country_name

string

The localized name of the location's country

localized_province_name

string

The localized name of the location's region. Typically a province, state, or district

phone

string

The phone number of the location. This value can contain special characters, such as - or +

province

string

The province, state, or district of the location

province_code

string

The province, state, or district code ( ISO 3166-2 alpha-2 format ) of the location

zip

string

The zip or postal code

created_at

timestamp

The date and time ( ISO 8601 format ) when the location was created

updated_at

timestamp

The date and time ( ISO 8601 format ) when the location was last updated

location_id

long

Location id

location_name

string

Location name

message

string

A human-readable string with the reason why the fulfillment order, or some of its line items, can't be moved to the location

movable

boolean

Whether the fulfillment order can be moved to the location

id

long

Marketing event id

breadcrumb_id

string

Breadcrumb id

budget

bigdecimal

The budget of the ad campaign

budget_type

string

The type of the budget. Required if budget is specified. Valid values: daily , lifetime .'

currency

string

The currency for the budget. Required if budget is specified

description

string

A description of the marketing event

ended_at

timestamp

For events with a duration, the time when the event actually ended

event_type

string

The type of marketing event. Valid values: ad , post , message , retargeting , transactional , affiliate , loyalty , newsletter , abandoned_cart . Note If there are values that you'd like to use for event_type that are not in the list above, then please share your request in the Shopify Community APIs and SDKs discussion board providing as much detail as possible. Our approach is to be more structured than using freeform text, but to still allow for categorization of most types of marketing actions

manage_url

string

A link to manage the marketing event. In most cases, this links to the app that created the event

marketing_activity_id

string

marketing_activity_id

marketing_channel

string

The channel that your marketing event will use. Valid values: search , display , social , email , referral

paid

boolean

Whether the event is paid or organic

preview_url

string

A link to the live version of the event, or to a rendered preview in the app that created it

referring_domain

string

The destination domain of the marketing event. Required if the marketing_channel is set to search or social

remote_id

long

An optional remote identifier for a marketing event. The remote identifier lets Shopify validate engagement data

scheduled_to_end_at

timestamp

For events with a duration, the time when the event was scheduled to end

started_at

timestamp

The time when the marketing action was started

utm_campaign

string

UTM campaign

utm_medium

string

UTM medium

utm_source

string

UTM source

id

long

Unique numeric identifier for the mobile platform application

app_clip_application_id

string

iOS App ID of the app clip

application_id

long

iOS App ID or Android application ID of the application

enabled_app_clips

boolean

Whether the application supports iOS app clips

enabled_shared_webcredentials

boolean

Whether the application supports iOS shared web credentials

enabled_universal_or_app_links

boolean

Whether the application supports iOS universal links and Android App Links. If true, then URLs can be set up to link directly to the application. If false, then URLs can't link directly to the application

platform

string

The platform of the application

sha256_cert_fingerprints

string

The SHA256 fingerprints of the app's signing certificate. (Android only)

created_at

timestamp

Created at

updated_at

timestamp

Updated at

id

long

The ID of the order, used for API purposes. This is different from the order_number property, which is the ID used by the shop owner and customer.'

name

string

The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings . This is different from the id property, which is the ID of the order used by the API. This field can also be set by the API to be any string value

app_id

long

The ID of the app that created the order

billing_address_address1

string

The street address of the billing address

billing_address_address2

string

An optional additional field for the street address of the billing address

billing_address_city

string

The city, town, or village of the billing address

billing_address_company

string

The company of the person associated with the billing address

billing_address_country

string

The name of the country of the billing address

billing_address_country_code

string

The two-letter code ( format) for the country of the billing address

billing_address_first_name

string

The first name of the person associated with the payment method

billing_address_last_name

string

The last name of the person associated with the payment method

billing_address_latitude

bigdecimal

The latitude of the billing address

billing_address_longitude

bigdecimal

The longitude of the billing address

billing_address_name

string

The full name of the person associated with the payment method

billing_address_phone

string

The phone number at the billing address

billing_address_province

string

The name of the region (for example, province, state, or prefecture) of the billing address

billing_address_province_code

string

The alphanumeric abbreviation of the region of the billing address

billing_address_zip

string

The postal code (for example, zip, postcode, or Eircode) of the billing address

browser_ip

string

The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported

buyer_accepts_marketing

boolean

Whether the customer consented to receive email updates from the shop

cancel_reason

string

The reason why the order was canceled. Valid values: customer : The customer canceled the order. fraud : The order was fraudulent. inventory : Items in the order were not in inventory. declined : The payment was declined. other : A reason not in this list

cancelled_at

timestamp

The date and time when the order was canceled. Returns null if the order isn't canceled

cart_token

string

A unique value when referencing the cart that's associated with the order

checkout_id

long

Checkout id

checkout_token

string

A unique value when referencing the checkout that's associated with the order

client_details_accept_language

string

The languages and locales that the browser understands

client_details_browser_height

bigdecimal

The browser screen height in pixels, if available

client_details_browser_ip

string

The browser IP address

client_details_browser_width

bigdecimal

The browser screen width in pixels, if available

client_details_session_hash

string

A hash of the session

client_details_user_agent

string

Details of the browsing client, including software and operating versions

closed_at

timestamp

The date and time ( ISO 8601 format) when the order was closed. Returns null if the order isn't closed

confirmation_number

string

A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. This value isn't guaranteed to be unique

confirmed

boolean

Whether inventory has been reserved for the order

contact_email

string

Contact email

currency

string

The three-letter code ( ISO 4217 format) for the shop currency

current_subtotal_price

bigdecimal

The sum of the prices for all line items after discounts and returns in the shop currency

current_subtotal_price_set_presentment_money_amount

bigdecimal

The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. Presentment Money Amount

current_subtotal_price_set_presentment_money_currency_code

string

The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. Presentment Money Currency code

current_subtotal_price_set_shop_money_amount

bigdecimal

The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. Shop money Amount

current_subtotal_price_set_shop_money_currency_code

string

The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. Shop money Currency code

current_total_additional_fees_set_presentment_money_amount

bigdecimal

The current total additional fees on the order in shop and presentment currencies. Presentment Money Amount

current_total_additional_fees_set_presentment_money_currency_code

string

The current total additional fees on the order in shop and presentment currencies. Presentment Money Currency code

current_total_additional_fees_set_shop_money_amount

bigdecimal

The current total additional fees on the order in shop and presentment currencies. Shop money Amount

current_total_additional_fees_set_shop_money_currency_code

string

The current total additional fees on the order in shop and presentment currencies. Shop money Currency code

current_total_discounts

bigdecimal

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds

current_total_discounts_set_presentment_money_amount

bigdecimal

The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Amount

current_total_discounts_set_presentment_money_currency_code

string

The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Currency code

current_total_discounts_set_shop_money_amount

bigdecimal

The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Amount

current_total_discounts_set_shop_money_currency_code

string

The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Currency code

current_total_duties_set_presentment_money_amount

bigdecimal

The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Amount

current_total_duties_set_presentment_money_currency_code

string

The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Currency code

current_total_duties_set_shop_money_amount

bigdecimal

The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Amount

current_total_duties_set_shop_money_currency_code

string

The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Currency code

current_total_price

bigdecimal

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds

current_total_price_set_presentment_money_amount

bigdecimal

The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Amount

current_total_price_set_presentment_money_currency_code

string

The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Currency code

current_total_price_set_shop_money_amount

bigdecimal

The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Amount

current_total_price_set_shop_money_currency_code

string

The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Currency code

current_total_tax

bigdecimal

The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds

current_total_tax_set_presentment_money_amount

bigdecimal

The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Amount

current_total_tax_set_presentment_money_currency_code

string

The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Presentment Money Currency code

current_total_tax_set_shop_money_amount

bigdecimal

The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Amount

current_total_tax_set_shop_money_currency_code

string

The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. Shop money Currency code

customer_created_at

timestamp

The date and time ( ISO 8601 format) when the customer was created

customer_currency

string

The three-letter code ( ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders

customer_default_address_address1

string

The first line of the customer's mailing address

customer_default_address_address2

string

An additional field for the customer's mailing address

customer_default_address_city

string

The customer's city, town, or village

customer_default_address_company

string

The customer's company

customer_default_address_country

string

The customer's country

customer_default_address_country_code

string

The two-letter country code corresponding to the customer's country

customer_default_address_country_name

string

The customer's normalized country name

customer_default_address_customer_id

long

Customer default address customer id

customer_default_address_default

boolean

Returns true for each default address

customer_default_address_first_name

string

The customer's first name

customer_default_address_id

long

A unique identifier for the address

customer_default_address_last_name

string

The customer's last name

customer_default_address_name

string

Default address name

customer_default_address_phone

string

The customer's phone number at this address

customer_default_address_province

string

The customer's region name. Typically a province, a state, or a prefecture

customer_default_address_province_code

string

The alphanumeric code for the customer's region

customer_default_address_zip

string

The customer's postal code, also known as zip, postcode, Eircode, etc

customer_email

string

The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error

customer_email_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by email. If no date is provided, then the date and time when the consent information was sent is used

customer_email_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by email

customer_email_marketing_consent_state

string

The current email marketing state for the customer

customer_first_name

string

The customer's first name

customer_id

long

Customer id

customer_last_name

string

The customer's last name

customer_locale

string

The two or three-letter language code, optionally followed by a region modifier

customer_multipass_identifier

string

A unique identifier for the customer that's used with Multipass login

customer_note

string

A note about the customer

customer_phone

string

The unique phone number (<a href="https://en.wikipedia.org/wiki/E.164">E.164 format ) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: 6135551212 +16135551212 (613)555-1212 +1 613-555-1212

customer_sms_marketing_consent_consent_collected_from

string

The source for whether the customer has consented to receive marketing material by SMS

customer_sms_marketing_consent_consent_updated_at

timestamp

The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used

customer_sms_marketing_consent_opt_in_level

string

The marketing subscription opt-in level, as described in the , that the customer gave when they consented to receive marketing material by SMS

customer_sms_marketing_consent_state

string

The current SMS marketing state for the customer

customer_state

string

The state of the customer's account with a shop. Default value: disabled . Valid values: disabled : The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. invited : The customer has received an email invite to create an account. enabled : The customer has created an account. declined : The customer declined the email invite to create an account

customer_tags

string

Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters

customer_tax_exempt

boolean

Whether the customer is exempt from paying taxes on their order. If true , then taxes won't be applied to an order at checkout. If false , then taxes will be applied at checkout

customer_updated_at

timestamp

The date and time ( ISO 8601 format) when the customer information was last updated

customer_verified_email

boolean

Whether the customer has verified their email address

device_id

long

Device id

discount_codes

string

Discount codes

duties_included

boolean

Returns true if duties are included in the prices of products in the cart. Returns false if not

email

string

The customer's email address

estimated_taxes

boolean

Whether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. This property returns false when taxes on the order are finalized and aren't subject to any changes

financial_status

string

The status of payments associated with the order. Can only be set when the order is created. Valid values: pending : The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully. authorized : The payments have been authorized. partially_paid : The order has been partially paid. paid : The payments have been paid. partially_refunded : The payments have been partially refunded. refunded : The payments have been refunded. voided : The payments have been voided

fulfillment_status

string

The order's status in terms of fulfilled line items. You can use the FulfillmentOrder resource for a more granular view. Valid values: fulfilled : Every line item in the order has been fulfilled. null : None of the line items in the order have been fulfilled. partial : At least one line item in the order has been fulfilled. restocked : Every line item in the order has been restocked and the order canceled

landing_site

string

The URL for the page where the buyer landed when they entered the shop

landing_site_ref

string

Landing site ref

location_id

long

The ID of one of the locations that was assigned to fulfill the order when the order was created. Orders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The Order.location_id field will only point to one of these locations. Use the FulfillmentOrder resource for up-to-date fulfillment location information

merchant_of_record_app_id

long

The application acting as Merchant of Record for the order

note

string

An optional note that a shop owner can attach to the order

note_attributes

string

Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys

number

long

The order's position in the shop's count of orders. Numbers are sequential and start at 1

order_number

long

The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001

order_status_url

string

The URL pointing to the order status web page , if applicable

original_total_additional_fees_set_presentment_money_amount

bigdecimal

Original total additional fees on the order in shop and presentment currencies. Presentment Money Amount

original_total_additional_fees_set_presentment_money_currency_code

string

Original total additional fees on the order in shop and presentment currencies. Presentment Money Currency code

original_total_additional_fees_set_shop_money_amount

bigdecimal

Original total additional fees on the order in shop and presentment currencies. Shop money Amount

original_total_additional_fees_set_shop_money_currency_code

string

Original total additional fees on the order in shop and presentment currencies. Shop money Currency code

original_total_duties_set_presentment_money_amount

bigdecimal

The original total duties charged on the order in shop and presentment currencies. Presentment Money Amount

original_total_duties_set_presentment_money_currency_code

string

The original total duties charged on the order in shop and presentment currencies. Presentment Money Currency code

original_total_duties_set_shop_money_amount

bigdecimal

The original total duties charged on the order in shop and presentment currencies. Shop money Amount

original_total_duties_set_shop_money_currency_code

string

The original total duties charged on the order in shop and presentment currencies. Shop money Currency code

payment_gateway_names

string

The list of payment gateways used for the order

payment_terms

string

The terms and conditions under which a payment should be processed. amount : The amount that is owed according to the payment terms. currency : The presentment currency for the payment. payment_terms_name : The name of the selected payment terms template for the order. payment_terms_type : The type of selected payment terms template for the order. due_in_days : The number of days between the invoice date and due date that is defined in the selected payment terms template. payment_schedules : An array of schedules associated to the payment terms. amount : The amount that is owed according to the payment terms. currency : The presentment currency for the payment. issued_at : The date and time when the payment terms were initiated. due_at : The date and time when the payment is due. Calculated based on issued_at and due_in_days or a customized fixed date if the type is fixed. completed_at : The date and time when the purchase is completed. Returns null initially and updates when the payment is captured. expected_payment_method : The name of the payment method gateway

phone

string

The customer's phone number for receiving SMS notifications

po_number

string

The purchase order number associated to this order

presentment_currency

string

The presentment currency that was used to display prices to the customer

reference

string

Reference

referring_site

string

The website where the customer clicked a link to the shop

shipping_address_address1

string

The street address of the shipping address

shipping_address_address2

string

An optional additional field for the street address of the shipping address

shipping_address_city

string

The city, town, or village of the shipping address

shipping_address_company

string

The company of the person associated with the shipping address

shipping_address_country

string

The name of the country of the shipping address

shipping_address_country_code

string

The two-letter code ( format) for the country of the shipping address

shipping_address_first_name

string

The first name of the person associated with the shipping address

shipping_address_last_name

string

The last name of the person associated with the shipping address

shipping_address_latitude

bigdecimal

The latitude of the shipping address

shipping_address_longitude

bigdecimal

The longitude of the shipping address

shipping_address_name

string

The full name of the person associated with the payment method

shipping_address_phone

string

The phone number at the shipping address

shipping_address_province

string

The name of the region (for example, province, state, or prefecture) of the shipping address

shipping_address_province_code

string

The alphanumeric abbreviation of the region of the shipping address

shipping_address_zip

string

The postal code (for example, zip, postcode, or Eircode) of the shipping address

source_identifier

string

The ID of the order placed on the originating platform. This value doesn't correspond to the Shopify ID that's generated from a completed draft

source_name

string

The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. You can register the channels that your app is managing by completing this Google Form . After you've submited your request, you need to wait for your request to be processed by Shopify. You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension. You can specify a handle as the source_name value in your request

source_url

string

A valid URL to the original order on the originating surface. This URL is displayed to merchants on the Order Details page. If the URL is invalid, then it won't be displayed

subtotal_price

bigdecimal

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips

subtotal_price_set_presentment_money_amount

bigdecimal

The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips. Presentment Money Amount

subtotal_price_set_presentment_money_currency_code

string

The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips. Presentment Money Currency code

subtotal_price_set_shop_money_amount

bigdecimal

The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips. Shop money Amount

subtotal_price_set_shop_money_currency_code

string

The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips. Shop money Currency code

tags

string

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length

tax_exempt

boolean

Whether the customer is exempt from paying taxes on their order. If true , then taxes won't be applied to an order at checkout. If false , then taxes will be applied at checkout

taxes_included

boolean

Whether taxes are included in the order subtotal

test

boolean

Whether this is a test order

token

string

A unique value when referencing the order

total_discounts

bigdecimal

The total discounts applied to the price of the order in the shop currency

total_discounts_set_presentment_money_amount

bigdecimal

The total discounts applied to the price of the order in shop and presentment currencies. Presentment Money Amount

total_discounts_set_presentment_money_currency_code

string

The total discounts applied to the price of the order in shop and presentment currencies. Presentment Money Currency code

total_discounts_set_shop_money_amount

bigdecimal

The total discounts applied to the price of the order in shop and presentment currencies. Shop money Amount

total_discounts_set_shop_money_currency_code

string

The total discounts applied to the price of the order in shop and presentment currencies. Shop money Currency code

total_line_items_price

bigdecimal

The sum of all line item prices in the shop currency

total_line_items_price_set_presentment_money_amount

bigdecimal

The total of all line item prices in shop and presentment currencies. Presentment Money Amount

total_line_items_price_set_presentment_money_currency_code

string

The total of all line item prices in shop and presentment currencies. Presentment Money Currency code

total_line_items_price_set_shop_money_amount

bigdecimal

The total of all line item prices in shop and presentment currencies. Shop money Amount

total_line_items_price_set_shop_money_currency_code

string

The total of all line item prices in shop and presentment currencies. Shop money Currency code

total_outstanding

bigdecimal

The total outstanding amount of the order in the shop currency

total_price

bigdecimal

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive

total_price_set_presentment_money_amount

bigdecimal

The total price of the order in shop and presentment currencies. Presentment Money Amount

total_price_set_presentment_money_currency_code

string

The total price of the order in shop and presentment currencies. Presentment Money Currency code

total_price_set_shop_money_amount

bigdecimal

The total price of the order in shop and presentment currencies. Shop money Amount

total_price_set_shop_money_currency_code

string

The total price of the order in shop and presentment currencies. Shop money Currency code

total_shipping_price_set_presentment_money_amount

bigdecimal

The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true , then total_shipping_price_set includes taxes. Presentment Money Amount

total_shipping_price_set_presentment_money_currency_code

string

The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true , then total_shipping_price_set includes taxes. Presentment Money Currency code

total_shipping_price_set_shop_money_amount

bigdecimal

The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true , then total_shipping_price_set includes taxes. Shop money Amount

total_shipping_price_set_shop_money_currency_code

string

The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true , then total_shipping_price_set includes taxes. Shop money Currency code

total_tax

bigdecimal

The sum of all the taxes applied to the order in the shop currency. Must be positive

total_tax_set_presentment_money_amount

bigdecimal

The total tax applied to the order in shop and presentment currencies. Presentment Money Amount

total_tax_set_presentment_money_currency_code

string

The total tax applied to the order in shop and presentment currencies. Presentment Money Currency code

total_tax_set_shop_money_amount

bigdecimal

The total tax applied to the order in shop and presentment currencies. Shop money Amount

total_tax_set_shop_money_currency_code

string

The total tax applied to the order in shop and presentment currencies. Shop money Currency code

total_tip_received

bigdecimal

The sum of all the tips in the order in the shop currency

total_weight

bigdecimal

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order

user_id

long

The ID of the user logged into Shopify POS who processed the order, if applicable

processed_at

timestamp

The date and time ( ISO 8601 format) when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports. If you're importing orders from an app or another platform, then you can set processed_at to a date and time in the past to match when the original order was created

created_at

timestamp

The autogenerated date and time ( ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed

updated_at

timestamp

The date and time ( ISO 8601 format) when the order was last modified. Filtering orders by updated_at is not an effective method for fetching orders because its value can change when no visible fields of an order have been updated. Use the Webhook and Event APIs to subscribe to order events instead

id

long

A unique numeric identifier for the order risk

cause_cancel

boolean

Whether this order risk is severe enough to force the cancellation of the order. If true , then this order risk is included in the Order canceled message that's shown on the details page of the canceled order. Note: Setting this property to true does not cancel the order. Use this property only if your app automatically cancels the order using the Order resource. If your app doesn't automatically cancel orders based on order risks, then leave this property set to false

checkout_id

long

The ID of the checkout that the order risk belongs to

display

boolean

Whether the order risk is displayed on the order details page in the Shopify admin. If false , then this order risk is ignored when Shopify determines your app's overall risk level for the order. It's not advised to create order risks with a display set to false . This property can't be changed after an order risk is created. This property might be removed in future API versions

merchant_message

string

The message that's displayed to the merchant to indicate the results of the fraud check. The message is displayed only if display is set to true

message

string

The message that's displayed to the merchant to indicate the results of the fraud check. The message is displayed only if display is set to true

order_id

long

The ID of the order that the order risk belongs to

recommendation

string

The recommended action given to the merchant. Valid values: cancel : There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate : There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept : There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud

score

bigdecimal

For internal use only . A number between 0 and 1 that's assigned to the order. The closer the score is to 1, the more likely it is that the order is fraudulent. Note There is no guarantee of stability in risk scores. Scores are not probabilities. The relationship between scores and the probability of fraud can vary over time and between risk providers

source

string

The source of the order risk

id

long

The unique identifier of the payout

amount

bigdecimal

The total amount of the payout, in a decimal formatted string

currency

string

The ISO 4217 currency code of the payout

date

date

Date

status

string

The transfer status of the payout. The value will be one of the following: scheduled : The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank. in_transit : The payout has been submitted to the bank for processing. paid : The payout has been successfully deposited into the bank. failed : The payout has been declined by the bank. canceled : The payout has been canceled by Shopify

summary_adjustments_fee_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_adjustments_gross_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_charges_fee_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_charges_gross_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_refunds_fee_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_refunds_gross_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_reserved_funds_fee_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_reserved_funds_gross_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_retried_payouts_fee_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

summary_retried_payouts_gross_amount

bigdecimal

The total amount of the payout, in a decimal formatted string

title

string

The name of the policy

body

string

A description of the policy

handle

string

A unique identifer for the policy used to build the policy's URL

url

string

The public URL of the policy

created_at

timestamp

The date and time ( ISO 8601 format ) when the policy was created

updated_at

timestamp

The date and time ( ISO 8601 format ) when the policy was last modified