This integration is powered by Singer's Shopify tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Shopify integration summary
Stitch’s Shopify integration replicates data using the Shopify REST Admin API (v2022-07). Refer to the Schema section for a list of objects available for replication.
Shopify feature snapshot
A high-level look at Stitch's Shopify (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on January 2, 2019 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Shopify
Shopify setup requirements
To set up Shopify in Stitch, you need:
-
Admin access in Shopify. This is required to allow Stitch to replicate data.
Note: If you’re on a Shopify Plus plan, the permissions required may differ. Store owners can grant users permissions to export orders, draft orders, products, inventory, and customer data. In general, view-level permissions should be sufficient.
Refer to the Shopify Staff permissions documentation for more information.
Step 1: Add Shopify as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Shopify icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Shopify” would create a schema called
stitch_shopify
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Shopify Shop field, enter the name of the shop you want to connect to Stitch. For example: If the shop URL was
stitch-data.shopify.com
, you’d enterstitch-data
into this field.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Shopify integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Shopify’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Shopify integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access Shopify
- Next, you’ll be prompted to sign into your Shopify account. Enter your Shopify credentials.
- Click Log in.
- After the authorization process is successfully completed, you’ll be directed back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Shopify integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Shopify, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Shopify replication
Replicating order refunds
To extract order refund data, Stitch queries every order in your account. If you have the order_refunds
table selected for replication, the process can potentially be very slow depending on how many orders and refunds exist in your Shopify account. As tables are extracted one at a time, this could cause extraction to not proceed for days at a time. To ensure timely replication of your other selected tables, consider creating a separate integration for only the order_refunds
table.
Note: Creating a separate integration for your order_refunds
table may negatively affect your Shopify API quota.
Shopify table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Shopify integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
abandoned_checkouts
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The abandoned_checkouts
table contains info about abandoned checkouts. Shopify considers a checkout to be abandoned when a customer has entered billing and shipping details, but hasn’t completed the purchase.
id
The abandoned checkout ID. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at
The date and time in ISO 8601 format when the checkout was last updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
abandoned_checkout_url
The recovery URL that is sent to a customer so they can recover their checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_address
The customer’s billing address details.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_accepts_marketing
Indicates whether the customer wants to receive email updates from the shop. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_accepts_sms_marketing
Indicates whether the customer wants to receive SMS updates from the shop. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cart_token
The ID of the cart that is attached to the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
closed_at
The date and time in ISO 8601 format when the checkout was closed.
If the checkout wasn’t closed, this value will be |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
completed_at
The date and time in ISO 8601 format when the checkout was completed.
For abandoned checkouts, this value will always be |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
The date and time in ISO 8601 format when the checkout was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency
The three-letter ISO 4217 code of the shop’s default currency at the time of checkout. For the currency the customer used at checkout, see |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer
Details about the customer associated with the abandoned checkout.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id
The ID of the customer associated with the abandoned checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_locale
The two or three-letter language code, optionally followed by a region modifier. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device_id
The ID of the Shopify POS device that created the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_codes
The discount codes applied to the checkout.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email
The customer’s email address. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway
The payment gateway used by the checkout. For abandoned checkouts, this value will always be |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
landing_site
The URL for the page where the customer entered the shop. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
line_items
A list of line items in the checkout.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location_id
The ID of the physical location where the checkout was processed. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
The order name as represented by a number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
note_attributes
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
note
An optional note attached to the order. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
phone
The customer’s phone number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
presentment_currency
The three-letter ISO 4217 code of the currency that the customer used at checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
referring_site
The website that referred the customer to the shop. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_address
Details about the shipping address associated with the checkout.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_lines
Details about the shipping methods associated with the order.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sms_marketing_phone
The phone number used to opt in to SMS marketing during checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
The channel where the checkout originated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_identifier
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_name
Where the checkout originated. Possible values are:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_url
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtotal_price
The price of the checkout before shipping and taxes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_lines
Details about the taxes applicable to the checkout.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taxes_included
Indicates if taxes are included in the price. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token
A unique ID for the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_discounts
The total amount of discounts to be applied. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_duties
The total duties of the checkout in presentment currency. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_line_items_price
The sum of the prices of all line items in the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_price
The sum of the prices of all line items in the checkout, discounts, shipping costs, and taxes |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_tax
The sum of all the taxes applied to the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_weight
The sum of all the weights in grams of the line items in the checkout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_id
The ID of the user who created the checkout. |
collects
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The collects
table contains info about collects, which are used to manage relationships between products and custom collections. For every product in a custom collection, there’s a collect that tracks the ID of both the product and the custom collection.
id
The collect ID. |
updated_at
The date and time in ISO 8601 format when the collect was last updated. |
collection_id
The ID of the custom collection containing the product. Reference: |
created_at
The date and time in ISO 8601 format when the collect was created. |
featured
Indicates whether the collect is featured. |
position
The position of the product in a manually sorted custom collection. |
product_id
The ID of the product in the custom collection. Reference: |
sort_value
The same value as |
customers
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The customers
table contains info about the shop’s customers. This includes their contact details, order history, and email marketing preferences.
Customer metafield data
To replicate customer metafield data, you must set this table and the metafields
table to replicate.
id
The customer ID. Reference: |
|||||||||||||||||
updated_at
The date and time in ISO 8601 format when the customer was last updated. |
|||||||||||||||||
accepts_marketing
Indicates if the customer has consented to receive marketing emails. |
|||||||||||||||||
accepts_marketing_updated_at
An ISO 8601-formated date of when the customer consented to receive marketing emails. |
|||||||||||||||||
addresses
A list of the 10 most recently updated addresses for the customer.
|
|||||||||||||||||
created_at
The date and time in ISO 8601 format when the customer was created. |
|||||||||||||||||
default_address
Details about the default address for the customer.
|
|||||||||||||||||
email
The customer’s email address. |
|||||||||||||||||
email_marketing_consent
The marketing consent information when the customer consented to receiving marketing material by email.
|
|||||||||||||||||
first_name
The customer’s first name. |
|||||||||||||||||
last_name
The customer’s last name. |
|||||||||||||||||
last_order_id
The ID of the customer’s last order. Reference: |
|||||||||||||||||
last_order_name
The name of the customer’s last order. |
|||||||||||||||||
multipass_identifier
The ID of the customer’s Multipass login. |
|||||||||||||||||
note
A note about the customer. |
|||||||||||||||||
orders_count
The number of orders associated with the customer. |
|||||||||||||||||
phone
The phone number for the customer, in E.164 format. |
|||||||||||||||||
state
The state of the customer’s account with a shop. Possible values are:
|
|||||||||||||||||
tags
Tags that the shop owner has attached to the customer. |
|||||||||||||||||
tax_exempt
Indicates if the customer is exempt from paying taxes on their order. If |
|||||||||||||||||
total_spent
The total amount of money that the customer has spent across their order history. |
|||||||||||||||||
verified_email
Indicates if the customer has verified their email address. |
custom_collections
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The custom_collections
table contains info about custom collections. A custom collection is a grouping of products that a merchant creates to make their store easier to browse.
id
The custom collection ID. Reference: |
|||||
updated_at
The date and time in ISO 8601 format when the custom collection was last updated. |
|||||
body_html
The description of the custom collection in HTML format. |
|||||
handle
A human-readable string for the custom collection, automatically generated from its title. |
|||||
image
Details about images associated with the custom collection.
|
|||||
published_at
The date and time in ISO 8601 format when the custom collection was published.
This will be |
|||||
published_scope
Indicates if the collection is published to the Point of Sale channel. Possible values are:
|
|||||
sort_order
The order in which products in the custom collection appear. Possible values are:
|
|||||
template_suffix
The suffix of the Liquid template being used. For example: If the value is |
|||||
title
The name of the custom collection. |
events
Replication Method : |
Key-based Incremental |
Replication Key |
created_at |
Primary Key |
id |
API endpoint : |
The events
table contains info about events in the shop.
id
The event ID. |
created_at
The date and time in ISO 8601 format when the event was created. |
body
A text field containing information about the event. |
path
The relative URL to the resource the event is for. |
message
The description of the event. It can contain HTML formatting. |
subject_id
The ID of the resource that generated the event. |
subject_type
The type of the resource that generated the event |
verb
The type of event that occurred. |
author
The author of the event. |
description
The description of the event. |
arguments
A certain event and its resources. |
inventory_items
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The inventory_items
table contains info about items in a shop.
id
The inventory item ID. |
||
updated_at
The date and time in ISO 8601 format when the inventory item was last updated. |
||
admin_graphql_api_id
|
||
created_at
The date and time in ISO 8601 format when the inventory item was created. |
||
sku
The unique SKU (stock keeping unit) of the inventory item. |
||
requires_shipping
Whether a customer needs to provide a shipping address when placing an order containing the inventory item. |
||
cost
The unit cost of the inventory item. |
||
country_code_of_origin
The ISO 3166-1 alpha-2 country code of where the item came from. |
||
province_code_of_origin
The ISO 3166-2 alpha-2 province code of where the item came from. |
||
harmonized_system_code
The general Harmonized System (HS) code for the inventory item. |
||
tracked
Whether inventory levels are tracked for the item. |
||
country_harmonized_system_codes
The country-specific Harmonized System (HS) codes for the item.
|
inventory_levels
Replication Method : |
Key-based Incremental |
Replication Key |
created_at |
Primary Key |
inventory_item_id : location_id |
API endpoint : |
The inventory_levels
table contains info about quantities of an inventory item for a location.
inventory_item_id
The ID of the inventory item associated with the inventory level. |
location_id
The ID of the location that the inventory level belongs to. |
created_at
The date and time in ISO 8601 format when the inventory level was modified. |
admin_graphql_api_id
|
available
The available quantity of an inventory item at the inventory level’s associated location. |
locations
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The locations
table contains info about .
id
The event ID. |
updated_at
The date and time in ISO 8601 format when the location was last updated. |
admin_graphql_api_id
|
created_at
The date and time in ISO 8601 format when the location was created. |
country_code
The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in. |
name
The name of the location. |
address1
The location’s street address. |
address2
The second line of the location’s street address. |
city
The city the location is in. |
province_code
The province, state, or district code (ISO 3166-2 alpha-2 format) of the location. |
zip
The zip or postal code. |
localized_province_name
|
localized_country_name
The localized name of the location’s country. |
province
The localized name of the location’s region. |
phone
The phone number of the location. |
legacy
Whether this is a fulfillment service location. |
country
The country the location is in. |
active
Whether the location is active. |
metafields
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The metafields
table contains info about resource metafields. These are arbitrary fields used to store additional information about resources.
Metafield replication and resource types
By default, this table will include only shop-level metafield data. To replicate the metafields for a given resource type, this table and the table for the resource must be set to replicate.
For example: To replicate metafield data for Orders, the orders
table must also be set to replicate.
Metafield data is available for customers
, products
, and orders
.
id
The metafield ID. |
updated_at
The date and time in ISO 8601 format when the metafield was last updated. |
created_at
The date and time in ISO 8601 format when the customer was created. |
description
A description of the info that the metafield contains. |
key
The name of the metafield. |
namespace
A container for a set of metafields. |
owner_id
The ID of the resource that the metafield is attached to. |
owner_resource
The type of resource that the metafield is attached to. Possible values are:
|
type
The type of data that the metafield stores. |
value
The information to be stored as metadata. |
value_type
The metafield’s information type. Possible values are:
|
orders
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The orders
table contains info about a shop’s completed orders.
Order metafield data
To replicate order metafield data, you must set this table and the metafields
table to replicate.
id
The order ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
app_id
The ID of the app that created the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_address
Details about the mailing address associated with the payment method. This address is an optional field that won’t be available on orders that don’t require a payment method.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
browser_ip
The IP address of the browser used by the customer when they placed the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_accepts_marketing
Indicates whether the customer consented to receive email updates from the shop. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancel_reason
The reason why the order was canceled. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancelled_at
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cart_token
The ID for the cart associated with the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
checkout_id
The checkout ID associated with the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
checkout_token
The checkout token associated with the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_details
Details about the browser the customer used when the order was placed.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
closed_at
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
confirmed
Indicates if the order has been confirmed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contact_email
The contact email associated with the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency
The three-letter ISO 4217 code for the currency used for the payment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer
Details about the customer associated with the abandoned checkout.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_locale
The two or three-letter language code, optionally followed by a region modifier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device_id
The ID of the Shopify POS device that created the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_applications
Details about the discount applications associated with the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_codes
The discount codes applied to the checkout.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email
The customer’s email address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email_marketing_consent
The marketing consent information when the customer consented to receiving marketing material by email.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financial_status
The order’s financial status. Possible falues are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fulfillment_status
The order’s fulfillment status. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fulfillments
Details about the fulfillments associated with the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway
The payment gateway used by the checkout. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
landing_site
The URL for the page where the customer entered the shop. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
line_items
Details about the line items in the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location_id
The ID of the physical location where the order was processed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
The order name as represented by a number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
note
An optional note the shop owner attached to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
note_attributes
Additional info added to the order, as it appears in the Additional details section of an order page.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
number
An identifier unique to the shop. Numbers are sequential and start at |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_adjustments
A list of order adjustments attached to the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_number
A unique identifier for the order, used by the shop owner and customer. This is different from the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_status_url
The URL of the order’s status page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_details
Details about the payment used for the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_gateway_names
The list of payment gateways used for the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
phone
The customer’s phone number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
processed_at
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
processing_method
Indicates how the payment was processed. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
referring_site
The website where the customer clicked a link to the shop. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refunds
A list of refunds applied to the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_address
Details about the shipping address associated with the order.
|