Get central access to all your Shopify data
Automate your data workflows
Become a truly data-driven Shopify seller
The Shopify API data connector from Pipes
The e-commerce platform Shopify enables you to access your Shopify seller data with their API. With the Shopify API data connector from Pipes you are able to access the Shopify API without writing a single line of code. Connect your Shopify account to your central database with just a few clicks and retrieve all the data about the following sections automatically on a regular basis.
Below you find the information that each section of the Shopify API can provide:
Customers APIs
The Shopify Customer APIs provide you with all data about your customer e.g. customer contact information, addresses, order history and more.
Events APIs
The Shopify Events APIs deliver you events like create dates, destroy dates, status updates and more for the following categories: Articles, Blogs, Custom collections, Comments, Orders, Pages, Price rules, Products and Smart collections.
Products APIs
With Shopify’s Product APIs you are able to retrieve a list of your products, product information and descriptions, product images and more.
Marketing Event Section
Through the Marketing Event Section of the Shopify API you get all data about your marketing campaigns created with Shopify. Get all tracking information and campaign performance data of your Shopify marketing actions.
Order APIs
Shopify’s Order APIs contain records of purchases with all relevant information about the customer, its shopping cart and the corresponding payment status, possible refunds and additional details. Even all tracked abandoned checkouts including the belonging URLs to the initial carts are retrievable.
Shopify Payments APIs
The Shopify Payments APIs deliver status, dates, amounts, fees and more about all your financial transactions (charge, refund, dispute, payout etc.) related to your Shopify business.
Shipping & Fulfilment APIs
The Shopify Payments APIs deliver status, dates, amounts, fees and more about all your financial transactions (charge, refund, dispute, payout etc.) related to your Shopify business.
For a detailed look at the available Shopify information, check out the full Shopify API documentation here. If you’re missing data, a specific metric or a report Shopify provides please let us know and we make it available for you through our Shopify data connector.
How Pipes works
See how easy it is to connect your Shopify shop to your central data warehouse with Pipes. Three simple steps in less than three minutes.
Connect Your
Data Warehouse
Connect Your
Sources
Create Your
Pipelines
Play Video
Watch this 3 min video to learn how the Shopify connector works
The pre-built Shopify API data templates from Pipes
For quick and easy setup of Shopify data pipelines, Pipes provides pre-built Shopify reports and data templates. These data schemas are bundles of meaningfully related metrics on a Shopify business. Just pick the data template with the metrics you want, set a replication frequency, and create and run your data pipeline. Below are the available Shopify reports and data templates and the metrics they contain.
Shopify API data templates:
| Parameter | Description |
| id | The ID for the checkout |
| abandoned_checkout_url | The recovery URL that’s sent to a customer so they can recover their checkout |
| billing_address_address1 | The customer’s mailing address |
| billing_address_address2 | An additional field for the customer’s mailing address |
| billing_address_city | The customer’s city, town, or village |
| billing_address_company | The customer’s company |
| billing_address_country | The customer’s country |
| billing_address_country_code | The two-letter country code corresponding to the customer’s country |
| billing_address_first_name | The customer’s first name |
| billing_address_last_name | The customer’s last name |
| billing_address_latitude | The latitude of the billing address |
| billing_address_longitude | The longitude of the billing address |
| billing_address_name | The customer’s first and last names |
| billing_address_phone | The customer’s phone number at this address |
| billing_address_province | The customer’s region name. Typically a province, a state, or a prefecture |
| billing_address_province_code | The two-letter code for the customer’s region |
| billing_address_zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| buyer_accepts_marketing | 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 |
| cart_token | The ID for the cart that’s attached to the checkout |
| closed_at | 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 | The date and time (ISO 8601 format) when the checkout was completed. For abandoned checkouts, this value is always null |
| currency | 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_accepts_marketing | Whether the customer has consented to receive marketing material via email |
| customer_accepts_marketing_updated_at | The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. Set this value whenever the customer consents or objects to marketing materials |
| customer_created_at | The date and time (ISO 8601 format) when the customer was created |
| customer_currency | 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 | The customer’s mailing address |
| customer_default_address_address2 | An additional field for the customer’s mailing address |
| customer_default_address_city | The customer’s city, town, or village |
| customer_default_address_company | The customer’s company |
| customer_default_address_country | The customer’s country |
| customer_default_address_country_code | The two-letter country code corresponding to the customer’s country |
| customer_default_address_country_name | The customer’s normalized country name |
| customer_default_address_customer_id | The customer’s id |
| customer_default_address_default | |
| customer_default_address_first_name | The customer’s first name |
| customer_default_address_id | The id of the address |
| customer_default_address_last_name | The customer’s last name |
| customer_default_address_name | The customer’s first and last names |
| customer_default_address_phone | The customer’s phone number at this address |
| customer_default_address_province | The customer’s region name. Typically a province, a state, or a prefecture |
| customer_default_address_province_code | The two-letter code for the customer’s region |
| customer_default_address_zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| customer_email | The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error |
| customer_first_name | The customer’s first name |
| customer_id | A unique identifier for the customer |
| customer_last_name | The customer’s last name |
| customer_last_order_id | The ID of the customer’s last order |
| customer_last_order_name | The name of the customer’s last order. This is directly related to the name field on the Order resource |
| customer_locale | The two or three-letter language code, optionally followed by a region modifier. Example values: en, en-CA |
| customer_marketing_opt_in_level | The marketing subscription opt-in level (as described by the MAAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be set to null |
| customer_multipass_identifier | A unique identifier for the customer that’s used with Multipass login |
| customer_note | A note about the customer |
| customer_orders_count | The number of orders associated with this customer |
| customer_phone | The unique phone number (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: |
| customer_state | The state of the customer’s account with a shop. Default value: disabled |
| customer_tags | 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 | 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 | The total amount of money that the customer has spent across their order history |
| customer_updated_at | The date and time (ISO 8601 format) when the customer information was last updated |
| customer_verified_email | Whether the customer has verified their email address |
| device_id | The ID of the Shopify POS device that created the checkout |
| The customer’s email address | |
| gateway | The payment gateway used by the checkout. For abandoned checkouts, this value is always null |
| landing_site | The URL for the page where the customer entered the shop |
| location_id | The ID of the physical location where the checkout was processed |
| name | |
| note | The text of an optional note that a shop owner can attach to the order |
| phone | The customer’s phone number for receiving SMS notifications |
| presentment_currency | 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 | The website that referred the customer to the shop |
| shipping_address_address1 | The customer’s mailing address |
| shipping_address_address2 | An additional field for the customer’s mailing address |
| shipping_address_city | The customer’s city, town, or village |
| shipping_address_company | The customer’s company |
| shipping_address_country | The customer’s country |
| shipping_address_country_code | The two-letter country code corresponding to the customer’s country |
| shipping_address_first_name | The customer’s first name |
| shipping_address_last_name | The customer’s last name |
| shipping_address_latitude | The mailing address associated with the payment method. The latitude of the shipping address |
| shipping_address_longitude | The mailing address associated with the payment method. The longitude of the shipping address |
| shipping_address_name | The customer’s first and last names |
| shipping_address_phone | The customer’s phone number at this address |
| shipping_address_province | The customer’s region name. Typically a province, a state, or a prefecture |
| shipping_address_province_code | The two-letter code for the customer’s region |
| shipping_address_zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| source | |
| source_identifier | |
| source_name | Where the checkout originated. Valid values: web, pos, iphone, android |
| source_url | |
| subtotal_price | The price of the checkout in presentment currency before shipping and taxes |
| taxes_included | Whether taxes are included in the price |
| token | A unique ID for a checkout |
| total_discounts | The total amount of discounts to be applied in presentment currency |
| total_line_items_price | The sum of the prices of all line items in the checkout in presentment currency |
| total_price | The sum of line item prices, all discounts, shipping costs, and taxes for the checkout in presentment currency |
| total_tax | The sum of all the taxes applied to the checkout in presentment currency |
| 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 |
| created_at | The date and time (ISO 8601 format) when the checkout was created |
| updated_at | The date and time (ISO 8601 format) when the checkout was last modified |
| Parameter | Description |
| id | The ID of the application credit |
| amount | The amount refunded by the application credit |
| description | The description of the application credit |
| test | Whether the application credit is a test transaction. Valid values: true,null |
| Parameter | Description |
| id | The ID of the application charge |
| api_client_id | The ID of the client |
| charge_type | The type of charge (e.g. one-time or reccuring, price or percentage) |
| decorated_return_url | Return URL (incl. individual parameters) where the merchant is redirected after accepting a charge |
| name | The application charge name |
| price | The price of the application charge. The minimum price is 0.50, and maximum price is 10,000 |
| return_url | The URL where the merchant is redirected after accepting a charge |
| status | The status of the application charge |
| test | Whether the application charge is a test transaction. Valid values:true,null |
| created_at | The date and time (ISO 8601 format) when the application charge was created |
| updated_at | The date and time (ISO 8601 format) when the charge was last updated |
| Parameter | Description |
| id | The ID of the recurring application charge |
| activated_on | The date and time (ISO 8601 format) when the customer activated the recurring application charge. The recurring application charge must be activated or the returned value is null |
| api_client_id | |
| billing_on | The date and time (ISO 8601 format) when the customer is billed. The recurring application charge must be accepted or the returned value is null |
| cancelled_on | The date and time (ISO 8601 format) when the merchant canceled their recurring application charge. Returns null when the recurring application charge is not canceled |
| confirmation_url | The URL where the merchant accepts or declines the recurring application charge |
| decorated_return_url | |
| name | The name of the recurring application charge |
| price | The price of the recurring application charge. The maximum price is 10,000 |
| return_url | The URL where the merchant is redirected after accepting the charge |
| status | The status of the recurring charge |
| test | Whether the application charge is a test transaction. Valid values: true,null |
| trial_days | The number of days that the customer is eligible for a free trial |
| trial_ends_on | The date and time (ISO 8601 format) when the free trial ends |
| created_at | The date and time (ISO 8601 format) when the recurring application charge was created |
| updated_at | The date and time (ISO 8601 format) when the recurring application charge was last updated |
| Parameter | Description |
| id | The ID of the usage charge |
| balance_remaining | |
| balance_used | |
| billing_on | |
| description | The name of the usage charge |
| price | The price of the usage charge |
| risk_level | |
| created_at | The date and time (ISO 8601 format) when the usage charge was created |
| Parameter | Description |
| id | The ID of the article |
| author | The name of the author of the article |
| blog_id | The ID of the blog containing the article |
| body_html | The text of the body of the article, complete with HTML markup |
| handle | 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 | Alternative text for an image to enable web crawlers to index the page |
| image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| image_height | Height dimension of the image which is determined on upload |
| image_src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| image_width | Width dimension of the image which is determined on upload |
| published_at | The date and time (ISO 8601 format) when the article was published |
| summary_html | A summary of the article, complete with HTML markup. The summary isused by the online store theme to display the article on other pages, such as the home page or the main blog page |
| tags | A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values |
| template_suffix | 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 |
| title | The title of the article |
| user_id | A unique numeric identifier for the author of the article |
| created_at | The date and time (ISO 8601 format) when the article was created |
| updated_at | The date and time (ISO 8601 format) when the article was last updated |
| Parameter | Description |
| attachment | A base64-encoded image |
| content_type | The MIME representation of the content, consisting of the type and subtype of the asset |
| key | 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 directory, so its key is assets/bg-body-green.gif |
| public_url | The public-facing URL of the asset |
| size | The asset size in bytes |
| theme_id | The ID for the theme that an asset belongs to |
| value | The text content of the asset, such as the HTML and Liquid markup of a template file |
| created_at | The date and time (ISO 8601 format) when the asset was created |
| updated_at | The date and time (ISO 8601 format) when an asset was last updated |
| Parameter | Description |
| author | The author of an article |
| Parameter | Description |
| id | A unique numeric identifier for the blog |
| commentable | Indicates whether readers can post comments to the blog and if comments are moderated or not. Possible values are: |
| feedburner | Feedburner is a web feed management provider and can be enabled to provide custom RSS feeds for Shopify bloggers. This property will default to blank or “null” unless feedburner is enabled through the shop admin |
| feedburner_location | URL to the feedburner location for blogs that have enabled feedburner through their store admin. This property will default to blank or “null” unless feedburner is enabled through the shop admin |
| handle | A human-friendly unique string for a blog automatically generated from its title. This handle is used by the Liquid templating language to refer to the blog |
| tags | Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3 |
| template_suffix | 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” |
| title | The title of the blog |
| created_at | The date and time when the blog was created. The API returns this value in ISO 8601 format |
| updated_at | 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 |
| Parameter | Description |
| id | The ID of the carrier service |
| active | Whether this carrier service is active |
| callback_url | The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL |
| carrier_service_type | Distinguishes between API or legacy carrier services |
| format | The format of the data returned by the URL endpoint. Valid values: json and xml. Default value: json |
| name | The name of the shipping service as seen by merchants and their customers |
| service_discovery | Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples |
| Parameter | Description |
| body_html | The description of the collection, complete with HTML formatting |
| collection_id | Identifies which collection this listing is for |
| default_product_image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| default_product_image_height | Height dimension of the image which is determined on upload |
| default_product_image_id | A unique numeric identifier for the product image |
| default_product_image_position | The order of the product image in the list. The first product image is at position 1 and is the “main” image for the product |
| default_product_image_product_id | The id of the product associated with the image |
| default_product_image_src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| default_product_image_updated_at | The date and time when the product image was last modified. The API returns this value in ISO 8601 format |
| default_product_image_width | Width dimension of the image which is determined on upload |
| handle | A human-friendly unique string for the Collection automatically generated from its title |
| image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| image_src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| published_at | The date and time when the collection was published. The API returns this in ISO_8601 |
| sort_order | The order in which products in the collection appear. Valid values are: |
| title | The name of the collection |
| updated_at | The date and time when the collection was last modified. The API returns this in ISO_8601 |
| Parameter | Description |
| id | A unique numeric identifier for the collect |
| collection_id | The ID of the custom collection containing the product |
| position | 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 | The unique numeric identifier for the product in the custom collection |
| sort_value | 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 | The date and time (ISO 8601 format) when the collect was created |
| updated_at | The date and time (ISO 8601 format) when the collect was last updated |
| Parameter | Description |
| id | A unique numeric identifier for the comment |
| article_id | A unique numeric identifier for the article that the comment belongs to |
| author | The name of the author of the comment |
| blog_id | A unique numeric identifier for the blog containing the article that the comment belongs to |
| body | The basic Textile markup of a comment |
| body_html | The text of the comment, complete with HTML markup |
| The email address of the author of the comment | |
| ip | The IP address from which the comment was posted |
| published_at | The date and time (ISO 8601 format) when the comment was published |
| status | The status of the comment |
| user_agent | The user agent string provided by the software used to create the comment (usually a browser) |
| created_at | The date and time (ISO 8601 format) when the comment was created |
| updated_at | 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 |
| Parameter | Description |
| id | The ID for the country. The ID for a country is unique across all Shopify stores. The ID for a country in one shop will be different from the same country in another shop |
| code | The two-letter country code (ISO 3166-1 alpha-2 format) |
| name | The full name of the country in English |
| tax | The national sales tax rate applied to orders made by customers from that country |
| tax_name |
| Parameter | Description |
| currency | The three-letter code (ISO 4217 format) for the currency associated with this setting |
| enabled | Is the currency enabled on a shop |
| rate_updated_at | The date and time (ISO 8601 format) when the conversion rate associated with this currency was last updated. Conversion rates are checked every 15 minutes, but typically only updated a few times a day |
| Parameter | Description |
| id | The ID for the custom collection |
| body_html | The description of the custom collection, complete with HTML markup. Many templates display this on their custom collection pages |
| handle | A human-friendly unique string for the custom collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the custom collection. (limit: 255 characters) |
| image_alt | Alternative text for an image to enable web crawlers to index the page |
| image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| image_height | Height dimension of the image which is determined on upload |
| image_src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| image_width | Width dimension of the image which is determined on upload |
| published_at | The time and date (ISO 8601 format) when the collection was made visible. Returns null for a hidden custom collection |
| published_scope | Whether the collection is published to the Point of Sale channel |
| sort_order | The order in which products in the custom collection appear |
| template_suffix | 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 |
| title | The name of the custom collection. (limit: 255 characters) |
| updated_at | The date and time (ISO 8601 format) when the custom collection was last modified |
| Parameter | Description |
| id | A unique identifier for the customer |
| accepts_marketing | Whether the customer has consented to receive marketing material via email |
| accepts_marketing_updated_at | The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. Set this value whenever the customer consents or objects to marketing materials |
| currency | 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 | The default address for the customer. The customer’s mailing address |
| default_address_address2 | The default address for the customer. An additional field for the customer’s mailing address |
| default_address_city | The default address for the customer. The customer’s city, town, or village |
| default_address_company | The default address for the customer. The customer’s company |
| default_address_country | The default address for the customer. The customer’s country |
| default_address_country_code | The default address for the customer. The two-letter country code corresponding to the customer’s country |
| default_address_country_name | The default address for the customer. The customer’s normalized country name |
| default_address_default | The default address for the customer. Whether this address is the default address for the customer |
| default_address_first_name | The default address for the customer. The customer’s first name |
| default_address_id | The default address for the customer. A unique identifier for the address |
| default_address_last_name | The default address for the customer. The customer’s last name |
| default_address_name | The default address for the customer. The customer’s first and last names |
| default_address_phone | The default address for the customer. The customer’s phone number at this address |
| default_address_province | The default address for the customer. The customer’s region name. Typically a province, a state, or a prefecture |
| default_address_province_code | The default address for the customer. The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada |
| default_address_zip | The default address for the customer. The customer’s postal code, also known as zip, postcode, Eircode, etc |
| The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error | |
| 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 |
| last_order_name | The name of the customer’s last order. This is directly related to the name field on the Order resource |
| marketing_opt_in_level | The marketing subscription opt-in level (as described by the MAAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be set to null. Valid values: single_opt_in, confirmed_opt_in, unknown |
| multipass_identifier | A unique identifier for the customer that’s used with Multipass login |
| note | A note about the customer |
| orders_count | The number of orders associated with this customer |
| phone | The unique phone number (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 |
| state | 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 | 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 | 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 | The total amount of money that the customer has spent across their order history |
| verified_email | Whether the customer has verified their email address |
| created_at | The date and time (ISO 8601 format) when the customer was created |
| updated_at | The date and time (ISO 8601 format) when the customer information was last updated |
| Parameter | Description |
| id | The ID of the customer address |
| address1 | The customer’s mailing address |
| address2 | An additional field for the customer’s mailing address |
| city | The customer’s city, town, or village |
| company | The customer’s company |
| country | The customer’s country |
| country_code | The two-letter country code corresponding to the customer’s country |
| country_name | The customer’s normalized country name |
| customer_id | The ID of the customer |
| default | Is the address the default address of the customer |
| first_name | The customer’s first name |
| last_name | The customer’s last name |
| name | The customer’s first and last names |
| phone | The customer’s phone number at this address |
| province | The customer’s region name. Typically a province, a state, or a prefecture |
| province_code | The two-letter code for the customer’s region |
| zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| Parameter | Description |
| id | A unique identifier for the customer saved search |
| name | The name given by the shop owner to the customer saved search |
| query | The set of conditions that determines which customers are returned by the saved search. For more information, see Customer saved search queries |
| created_at | The date and time (ISO 8601 format) when the customer saved search was created |
| updated_at | The date and time (ISO 8601 format) when the customer saved search was last modified |
| Parameter | Description |
| id | The ID for the discount code |
| code | 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 | The ID for the price rule that this discount code belongs to |
| usage_count | The number of times that the discount code has been redeemed |
| created_at | The date and time (ISO 8601 format) when the discount code was created |
| updated_at | The date and time (ISO 8601 format) when the discount code was updated |
| Parameter | Description |
| id | The ID of the dispute |
| amount | The total amount disputed by the cardholder |
| currency | The ISO 4217 currency code of the dispute amount |
| evidence_due_by | The deadline for evidence submission |
| evidence_sent_on | The date and time (ISO 8601 format) when evidence was sent. Returns null if evidence has not yet been sent finalized_on timestamp The date and time (ISO 8601 format) when this dispute was resolved. Returns null if the dispute is not yet resolved initiated_at timestamp network_reason_code long The reason for the dispute provided by the cardholder’s bank order_id long The ID of the order that the dispute belongs to reason string The reason of the dispute provided by the cardholder’s bank status string The current state of the dispute type string Whether the dispute is still in the inquiry phase or has turned into a chargeback |
| finalized_on | The date and time (ISO 8601 format) when this dispute was resolved. Returns null if the dispute is not yet resolved |
| initiated_at | |
| network_reason_code | The reason for the dispute provided by the cardholder’s bank |
| order_id | The ID of the order that the dispute belongs to |
| reason | The reason of the dispute provided by the cardholder’s bank |
| status | The current state of the dispute |
| type | Whether the dispute is still in the inquiry phase or has turned into a chargeback |
| Parameter | Description |
| id | The ID of the draft order |
| applied_discount_amount | The amount that is deducted from payment_due in presentment currency |
| applied_discount_description | The description of the applied discount |
| applied_discount_title | The title to categorize the applied discount |
| applied_discount_value | The value that was used to calculate the final applied discount amount |
| applied_discount_value_type | The type of value that was used to calculate the final applied discount amount. Valid values: fixed_amount and percentage |
| billing_address_address1 | The mailing address associated with the payment method. The street address of the billing address |
| billing_address_address2 | The mailing address associated with the payment method. An optional additional field for the street address of the billing address |
| billing_address_city | The mailing address associated with the payment method. The city, town, or village of the billing address |
| billing_address_company | The mailing address associated with the payment method. The company of the person associated with the billing address |
| billing_address_country | The mailing address associated with the payment method. The name of the country of the billing address |
| billing_address_country_code | The mailing address associated with the payment method. The two-letter code (ISO 3166-1 format) for the country of the billing address |
| billing_address_first_name | The mailing address associated with the payment method. The first name of the person associated with the payment method |
| billing_address_last_name | The mailing address associated with the payment method. The last name of the person associated with the payment method |
| billing_address_latitude | The mailing address associated with the payment method. The latitude of the billing address |
| billing_address_longitude | The mailing address associated with the payment method. The longitude of the billing address |
| billing_address_name | The mailing address associated with the payment method. The full name of the person associated with the payment method |
| billing_address_phone | The mailing address associated with the payment method. The phone number at the billing address |
| billing_address_province | The mailing address associated with the payment method. The name of the region (province, state, prefecture, …) of the billing address |
| billing_address_province_code | The mailing address associated with the payment method. The two-letter abbreviation of the region of the billing address |
| billing_address_zip | The mailing address associated with the payment method. The postal code (zip, postcode, Eircode, …) of the billing address |
| completed_at | The date and time (ISO 8601 format) when the order is created and the draft order is completed |
| currency | The three letter code (ISO 4217 format) for the currency used for the payment |
| customer_accepts_marketing | Whether the customer has consented to receive marketing material via email |
| customer_accepts_marketing_updated_at | The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. Set this value whenever the customer consents or objects to marketing materials |
| customer_created_at | The date and time (ISO 8601 format) when the customer was created |
| customer_currency | 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 | The customer’s mailing address |
| customer_default_address_address2 | An additional field for the customer’s mailing address |
| customer_default_address_city | The customer’s city, town, or village |
| customer_default_address_company | The customer’s company |
| customer_default_address_country | The customer’s country |
| customer_default_address_country_code | The two-letter country code corresponding to the customer’s country |
| customer_default_address_country_name | The customer’s normalized country name |
| customer_default_address_customer_id | The customer’s id |
| customer_default_address_default | |
| customer_default_address_first_name | The customer’s first name |
| customer_default_address_id | The id of the address |
| customer_default_address_last_name | The customer’s last name |
| customer_default_address_name | The customer’s first and last names |
| customer_default_address_phone | The customer’s phone number at this address |
| customer_default_address_province | The customer’s region name. Typically a province, a state, or a prefecture |
| customer_default_address_province_code | The two-letter code for the customer’s region |
| customer_default_address_zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| customer_email | The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error |
| customer_first_name | The customer’s first name |
| customer_id | A unique identifier for the customer |
| customer_last_name | The customer’s last name |
| customer_last_order_id | The ID of the customer’s last order |
| customer_last_order_name | The name of the customer’s last order. This is directly related to the name field on the Order resource |
| customer_marketing_opt_in_level | The marketing subscription opt-in level (as described by the MAAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be set to null |
| customer_multipass_identifier | A unique identifier for the customer that’s used with ‘ ‘Multipass login |
| customer_note | A note about the customer |
| customer_orders_count | The number of orders associated with this customer |
| customer_phone | The unique phone number (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: |
| customer_state | The state of the customer’s account with a shop. Default value: disabled |
| customer_tags | 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 | 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 | The total amount of money that the customer has spent across their order history |
| customer_updated_at | The date and time (ISO 8601 format) when the customer information was last updated |
| customer_verified_email | Whether the customer has verified their email address |
| The customer’s email address | |
| invoice_sent_at | The date and time (ISO 8601 format) when the invoice was emailed to the customer |
| invoice_url | The URL for the invoice |
| name | Name of the draft order |
| note | The text of an optional note that a shop owner can attach to the draft order |
| note_attributes | Extra information that is added to the order. Appears in the section of an order details page. Each array entry must contain a hash with name and value keys |
| order_id | The ID of the order that ‘s created and associated with the draft order after the draft order is completed |
| shipping_address_address1 | The customer’s mailing address |
| shipping_address_address2 | An additional field for the customer’s mailing address |
| shipping_address_city | The customer’s city, town, or village |
| shipping_address_company | The customer’s company |
| shipping_address_country | The customer’s country |
| shipping_address_country_code | The two-letter country code corresponding to the customer’s country |
| shipping_address_first_name | The customer’s first name |
| shipping_address_last_name | The customer’s last name |
| shipping_address_latitude | The mailing address associated with the payment method. The latitude of the shipping address |
| shipping_address_longitude | The mailing address associated with the payment method. The longitude of the shipping address |
| shipping_address_name | The customer’s first and last names |
| shipping_address_phone | The customer’s phone number at this address |
| shipping_address_province | The customer’s region name. Typically a province, a state, or a prefecture |
| shipping_address_province_code | The two-letter code for the customer’s region |
| shipping_address_zip | The customer’s postal code, also known as zip, postcode, Eircode, etc |
| shipping_line_custom | |
| shipping_line_handle | Handle of the selected shipping rate |
| shipping_line_price | Price of the selected shipping rate |
| shipping_line_title | Title of the selected shipping rate |
| status | 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 |
| subtotal_price | the price of the order before shipping and taxes |
| tags | 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 | 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 | Whether taxes are included in the order subtotal. Valid values are true or false |
| total_price | The sum of all the prices of all the items in the order, taxes and discounts included |
| total_tax | The sum of all the taxes applied to the order |
| created_at | The date and time (ISO 8601 format) when the order was created in Shopify |
| updated_at | The date and time (ISO 8601 format) when the order was last modified |
| Parameter | Description |
| id | The ID of the event |
| arguments | Refers to a certain event and its resources |
| author | |
| body | A text field containing information about the event |
| description | A human readable description of the event |
| message | A human readable description of the event. Can contain some HTML formatting |
| path | A relative URL to the resource the event is for, if applicable |
| 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. Different resources generate different types of event. See the Resources section for a list of possible verbs |
| created_at | The date and time (ISO 8601 format) when the event was created |
| Parameter | Description |
| feedback_generated_at | The time at which the payload is constructed. Used to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival. ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. , If you queue a Feedback API payload for delivery at a later time, do not update this value when the API call is actually made; ensure that the current time is set when building the payload |
| messages | A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app encounters when trying to make use of their Shop and its resources. , Required only when state is requires_action. Disallowed when state is success. , one message up to 100 characters long |
| resource_id | Unique id of the resource |
| resource_type | Type of resource for which feedback is returned. eg. Shop, Product |
| resource_updated_at | |
| state | Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success |
| created_at | DateTime when the resource feedback record was stored by Shopify. ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone |
| updated_at | DateTime when the resource feedback record was last updated by Shopify. ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone |
| Parameter | Description |
| id | An ID for the fulfillment event |
| address1 | The street address where the fulfillment event occurred |
| city | The city where the fulfillment event occurred |
| country | The country where the fulfillment event occurred |
| estimated_delivery_at | 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 | An ID for the fulfillment that’s associated with the fulfillment event |
| happened_at | The date and time (ISO 8601 format) when the fulfillment event occurred |
| latitude | A geographic coordinate specifying the latitude of the fulfillment event |
| longitude | A geographic coordinate specifying the longitude of the fulfillment event |
| message | An arbitrary message describing the status. Can be provided by a shipping carrier |
| order_id | The ID of the order that’s associated with the fulfillment event |
| province | The province where the fulfillment event occurred |
| shop_id | An ID for the shop that’s associated with the fulfillment event |
| status | The status of the fulfillment event |
| zip | The zip code of the location where the fulfillment event occurred |
| created_at | The date and time (ISO 8601 format) when the fulfillment event was created |
| updated_at | The date and time (ISO 8601 format) when the fulfillment event was updated |
| Parameter | Description |
| id | The ID for the fulfillment |
| location_id | The unique identifier of the location that the fulfillment should be processed for. To find the ID of the location, use the Location resource |
| name | 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) |
| order_id | The unique numeric identifier for the order |
| receipt_authorization | |
| receipt_testcase | |
| service | The type of service used |
| shipment_status | The current shipment status of the fulfillment |
| status | The status of the fulfillment |
| tracking_company | The name of the tracking company. , When creating a fulfillment for a supported carrier, send the tracking_company exactly as written in the list above. If the tracking company doesn’t match one of the supported entries, then the shipping status might not be updated properly during the fulfillment process |
| tracking_number | |
| tracking_numbers | A list of tracking numbers, provided by the shipping company. , It is highly recommended that you send the tracking company and the tracking URL as well. If neither one of these is sent, then the tracking company will be determined automatically. This can result in an invalid tracking URL., The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer. When accounts are enabled, it is also displayed in the customer’s order history |
| tracking_url | |
| tracking_urls | The URLs of tracking pages for the fulfillment |
| created_at | The date and time when the fulfillment was created. The API returns this value in ISO 8601 format |
| updated_at | The date and time (ISO 8601 format) when the fulfillment was last modified |
| Parameter | Description |
| id | Id of the fulfillment service |
| Email of the fulfillment service | |
| handle | A human-friendly unique string for the fulfillment service generated from its title |
| include_pending_stock | Include pending stock |
| inventory_management | States if the fulfillment service tracks product inventory and provides updates to Shopify. Valid values are “true” and “false” |
| location_id | The unique identifier of the location tied to the fulfillment service |
| name | The name of the fulfillment service as seen by merchants and their customers |
| provider_id | A unique identifier for the fulfillment service provider |
| requires_shipping_method | States if the fulfillment service requires products to be physically shipped. Valid values are “true” and “false” |
| service_name | Name of the service |
| tracking_support | States if the fulfillment service provides tracking numbers for packages. Valid values are “true” and “false” |
| Parameter | Description |
| id | The ID of the gift card |
| api_client_id | The ID of the app that issued the gift card, if it was issued by an app |
| balance | The balance of the gift card |
| currency | The currency of the gift card |
| customer_id | The ID of a customer who is associated with this gift card |
| disabled_at | The date and time (ISO 8601 format) when the gift card was disabled |
| expires_on | 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 | The initial value of the gift card when it was created |
| last_characters | 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 | The ID of the line item that caused the creation of this gift card, if it was created by an order |
| note | The text of an optional note that a merchant can attach to the gift card. Not visible to customers |
| order_id | The ID of the order that caused the creation of this gift card, if it was created by an order |
| template_suffix | 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 | The ID of the user that issued the gift card, if it was issued by a user |
| created_at | The date and time (ISO 8601 format) when the gift card was created |
| updated_at | The date and time (ISO 8601 format) when the gift card was last modified |
| Parameter | Description |
| id | The ID of the inventory item |
| cost | The unit cost of the inventory item |
| country_code_of_origin | The two-digit code for the country where the inventory item was made |
| harmonized_system_code | The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code is not available |
| province_code_of_origin | The two-digit code for the province where the inventory item was made. Used only if the shipping provider for the inventory item is Canada Post |
| requires_shipping | Whether a customer needs to provide a shipping address when placing an order containing the inventory item |
| sku | The unique SKU (stock keeping unit) of the inventory item |
| tracked | Whether the inventory item is tracked. If true, then inventory quantity changes are tracked by Shopify |
| created_at | The date and time (ISO 8601 format) when the inventory item was created |
| updated_at | The date and time (ISO 8601 format) when the inventory item was last modified |
| Parameter | Description |
| available | The quantity of inventory items available for sale. Returns null if the inventory item is not tracked |
| inventory_item_id | The ID of the inventory item that the inventory level belongs to |
| location_id | The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource |
| updated_at | The date and time (ISO 8601 format) when the inventory level was last modified |
| Parameter | Description |
| available | The quantity of inventory items available for sale. Returns null if the inventory item is not tracked |
| inventory_item_id | The ID of the inventory item that the inventory level belongs to |
| location_id | The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource |
| updated_at | The date and time (ISO 8601 format) when the inventory level was last modified |
| Parameter | Description |
| id | The unique identifier of the transaction |
| amount | The gross amount of the transaction, in a decimal formatted string |
| currency | The ISO 4217 currency code of the transaction |
| fee | The total amount of fees deducted from the transaction amount |
| net | The net amount of the transaction |
| payout_id | The id of the payout the transaction was paid out in |
| payout_status | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout |
| processed_at | The time the transaction was processed |
| source_id | The id of the resource leading to the transaction |
| source_order_id | The id of the Order that this transaction ultimately originated from |
| source_order_transaction_id | The id of the Order Transaction that resulted in this balance transaction |
| source_type | The type of the resource leading to the transaction |
| test | If the transaction was created for a test mode Order or payment |
| type | The type of the balance transaction. The value will be one of the following: |
| Parameter | Description |
| id | The ID for the location |
| active | 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 | The first line of the address |
| address2 | The second line of the address |
| city | The city the location is in |
| country | The country the location is in |
| country_code | The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in |
| country_name | Name of the country the location is in |
| legacy | 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 |
| name | The name of the location |
| phone | The phone number of the location. This value can contain special characters like – and + |
| province | The province the location is in |
| province_code | The two-letter code corresponding to province or state the location is in |
| zip | The zip or postal code |
| created_at | The date and time (ISO 8601 format) when the location was created |
| updated_at | The date and time (ISO 8601 format) when the location was last updated |
| Parameter | Description |
| id | Identifier of the marketing event |
| breadcrumb_id | |
| budget | The budget of the ad campaign |
| budget_type | The type of the budget. Required if budget is specified. Valid values: daily, lifetime.’ |
| currency | The currency for the budget. Required if budget is specified |
| description | A description of the marketing event |
| ended_at | For events with a duration, the time when the event actually ended |
| event_type | The type of marketing event. Valid values: ad, post, message, retargeting, transactional, affiliate, loyalty, newsletter, abandoned_cart. , If there are values that you’d like to use for event_type that are not in the list above, then please post your request here. 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 | A link to manage the marketing event. In most cases, this links to the app that created the event |
| marketing_activity_id | Identifier of the marketing activity |
| marketing_channel | The channel that your marketing event will use. Valid values: search, display, social, email, referral |
| paid | Whether the event is paid or organic |
| preview_url | A link to the live version of the event, or to a rendered preview in the app that created it |
| referring_domain | The destination domain of the marketing event. Required if the marketing_channel is set to search or social |
| remote_id | An optional remote identifier for a marketing event. The remote identifier lets Shopify validate engagement data |
| scheduled_to_end_at | For events with a duration, the time when the event was scheduled to end |
| started_at | The time when the marketing action was started |
| utm_campaign | The UTM parameters used in the links provided in the marketing event |
| utm_medium | The UTM parameters used in the links provided in the marketing event |
| utm_source | The UTM parameters used in the links provided in the marketing event |
| Parameter | Description |
| id | The unique ID of the metafield |
| description | A description of the information that the metafield contains |
| key | The name of the metafield. Maximum length: 30 characters |
| namespace | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. Maximum length: 20 characters |
| owner_id | The unique ID of the resource that the metafield is attached to |
| owner_resource | The type of resource that the metafield is attached to |
| value | The information to be stored as metadata |
| value_type | The metafield’s information type. Valid values: string, integer, json_string |
| created_at | The date and time (ISO 8601 format) when the metafield was created |
| updated_at | The date and time (ISO 8601 format) when the metafield was last updated |
| Parameter | Description |
| id | The unique ID of the metafield |
| description | A description of the information that the metafield contains |
| key | The name of the metafield. Maximum length: 30 characters |
| namespace | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. Maximum length: 20 characters |
| owner_id | The unique ID of the resource that the metafield is attached to |
| owner_resource | The type of resource that the metafield is attached to |
| value | The information to be stored as metadata |
| value_type | The metafield’s information type. Valid values: string, integer, json_string |
| created_at | The date and time (ISO 8601 format) when the metafield was created |
| updated_at | The date and time (ISO 8601 format) when the metafield was last updated |
| Parameter | Description |
| id | A unique numeric identifier for the order risk |
| cause_cancel | Whether this order risk is severe enough to force the cancellation of the order. If true, then this order risk is included in the message that’s shown on the details page of the canceled order. , 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 | The ID of the checkout that the order risk belongs to |
| display | 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., This property can’t be changed after an order risk is created |
| merchant_message | 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 totrue |
| message | 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 totrue |
| order_id | The ID of the order that the order risk belongs to |
| recommendation | The recommended action given to the merchant |
| score | 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 |
| source | The source of the order risk |
| Parameter | Description |
| id | 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.’ |
| app_id | The ID of the app that created the order |
| billing_address_address1 | The mailing address associated with the payment method. The street address of the billing address |
| billing_address_address2 | The mailing address associated with the payment method. An optional additional field for the street address of the billing address |
| billing_address_city | The mailing address associated with the payment method. The city, town, or village of the billing address |
| billing_address_company | The mailing address associated with the payment method. The company of the person associated with the billing address |
| billing_address_country | The mailing address associated with the payment method. The name of the country of the billing address |
| billing_address_country_code | The mailing address associated with the payment method. The two-letter code (ISO 3166-1 format) for the country of the billing address |
| billing_address_first_name | The mailing address associated with the payment method. The first name of the person associated with the payment method |
| billing_address_last_name | The mailing address associated with the payment method. The last name of the person associated with the payment method |
| billing_address_latitude | The mailing address associated with the payment method. The latitude of the billing address |
| billing_address_longitude | The mailing address associated with the payment method. The longitude of the billing address |
| billing_address_name | The mailing address associated with the payment method. The full name of the person associated with the payment method |
| billing_address_phone | The mailing address associated with the payment method. The phone number at the billing address |
| billing_address_province | The mailing address associated with the payment method. The name of the region (province, state, prefecture, …) of the billing address |
| billing_address_province_code | The mailing address associated with the payment method. The two-letter abbreviation of the region of the billing address |
| billing_address_zip | The mailing address associated with the payment method. The postal code (zip, postcode, Eircode, …) of the billing address |
| browser_ip | The IP address of the browser used by the customer when they placed the order |
| buyer_accepts_marketing | Whether the customer consented to receive email updates from the shop |
| cancel_reason | 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 | The date and time ( ISO 8601 format) when the order was canceled |
| cart_token | The ID of the cart that’s associated with the order |
| checkout_id | The ID of the checkout that’s associated with the order |
| checkout_token | The token of the checkout that’s associated with the order |
| client_details_accept_language | The languages and locales that the browser understands |
| client_details_browser_height | The browser screen height in pixels, if available |
| client_details_browser_ip | The browser IP address |
| client_details_browser_width | The browser screen width in pixels, if available |
| client_details_session_hash | A hash of the session |
| client_details_user_agent | Details of the browsing client, including software and operating versions |
| closed_at | The date and time (ISO 8601 format) when the order was closed |
| confirmed | |
| contact_email | Customer email |
| currency | The three-letter code (ISO 4217 format) for the shop currency |
| customer_accepts_marketing | Whether the customer has consented to receive marketing material via email |
| customer_accepts_marketing_updated_at | The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. Set this value whenever the customer consents or objects to marketing materials |
| customer_created_at | The date and time (ISO 8601 format) when the customer was created |
| customer_currency | 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 | The default address for the customer. The customer’s mailing address |
| customer_default_address_address2 | The default address for the customer. An additional field for the customer’s mailing address |
| customer_default_address_city | The default address for the customer. The customer’s city, town, or village |
| customer_default_address_company | The default address for the customer. The customer’s company |
| customer_default_address_country | The default address for the customer. The customer’s country |
| customer_default_address_country_code | The default address for the customer. The two-letter country code corresponding to the customer’s country |
| customer_default_address_country_name | The default address for the customer. The customer’s normalized country name |
| customer_default_address_customer_id | The default address for the customer. A unique identifier for the customer |
| customer_default_address_default | The default address for the customer. Whether this address is the default address for the customer |
| customer_default_address_first_name | The default address for the customer. The customer’s first name |
| customer_default_address_id | The default address for the customer. A unique identifier for the address |
| customer_default_address_last_name | The default address for the customer. The customer’s last name |
| customer_default_address_name | The default address for the customer. The customer’s first and last names |
| customer_default_address_phone | The default address for the customer. The customer’s phone number at this address |
| customer_default_address_province | The default address for the customer. The customer’s region name. Typically a province, a state, or a prefecture |
| customer_default_address_province_code | The default address for the customer. The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada |
| customer_default_address_zip | The default address for the customer. The customer’s postal code, also known as zip, postcode, Eircode, etc |
| customer_email | The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error |
| customer_first_name | The customer’s first name |
| customer_id | A unique identifier for the customer |
| customer_last_name | The customer’s last name |
| customer_last_order_id | The ID of the customer’s last order |
| customer_last_order_name | The name of the customer’s last order. This is directly related to the name field on the Order resource |
| customer_locale | The two or three-letter language code, optionally followed by a region modifier |
| customer_marketing_opt_in_level | The marketing subscription opt-in level (as described by the MAAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be set to null. Valid values: single_opt_in, confirmed_opt_in, unknown |
| customer_multipass_identifier | A unique identifier for the customer that’s used with Multipass login |
| customer_note | A note about the customer |
| customer_orders_count | The number of orders associated with this customer |
| customer_phone | The unique phone number (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_state | 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 | 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 | 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 | The total amount of money that the customer has spent across their order history |
| customer_updated_at | The date and time (ISO 8601 format) when the customer information was last updated |
| customer_verified_email | Whether the customer has verified their email address |
| device_id | The ID of the device that’s associated with the order |
| The customer’s email address | |
| financial_status | 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 have 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 | The order’s status in terms of fulfilled line items. 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 |
| gateway | The payment gateway used. , Use the Transaction resource instead |
| landing_site | The URL for the page where the buyer landed when they entered the shop |
| landing_site_ref | The URL (incl. ref parameter) for the page where the buyer landed when they entered the shop |
| location_id | The ID of the physical location where the order was processed |
| name | The order name as represented by a number. Must start with # |
| note | An optional note that a shop owner can attach to the order |
| note_attributes | Extra information that is added to the order. Appears in the section of an order details page. Each array entry must contain a hash with name and value keys |
| number | For internal use only. An ID unique to the shop. Numbers are sequential and start at 1000 |
| order_number | The ID of the order used by the shop owner and customer. This is different from the id property, which is the ID of the order used by the API |
| order_status_url | The URL pointing to the order status web page, if applicable |
| payment_details_avs_result_code | Information about the payment. The response code from the address verification system (AVS). The code is a single letter. See this chart for the codes and their definitions |
| payment_details_credit_card_bin | Information about the payment. The issuer identification number (IIN), formerly known as the bank identification number (BIN), of the customer’s credit card. This is made up of the first few digits of the credit card number |
| payment_details_credit_card_company | Information about the payment. The name of the company who issued the customer’s credit card |
| payment_details_credit_card_number | Information about the payment. The customer’s credit card number, with most of the leading digits redacted |
| payment_details_cvv_result_code | Information about the payment. The response code from the credit card company indicating whether the customer entered the card security code (card verification value) correctly. The code is a single letter or empty string. See this chart for the codes and their definitions |
| payment_gateway_names | The list of payment gateways used for the order |
| phone | The customer’s phone number for receiving SMS notifications |
| presentment_currency | The presentment currency that was used to display prices to the customer |
| processed_at | 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. By default, it matches the created_at value. 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 |
| processing_method | How the payment was processed. It has the following valid values: – checkout: The order was processed using the Shopify checkout; – direct: The order was processed using a direct payment provider; – manual: The order was processed using a manual payment method; – offsite: The order was processed by an external payment provider to the Shopify checkout; – express: The order was processed using PayPal Express Checkout; – free: The order was processed as a free order using a discount code |
| reference | |
| referring_site | The website where the customer clicked a link to the shop |
| shipping_address_address1 | The mailing address to where the order will be shipped. The street address of the shipping address |
| shipping_address_address2 | The mailing address to where the order will be shipped. An optional additional field for the street address of the shipping address |
| shipping_address_city | The mailing address to where the order will be shipped. The city, town, or village of the shipping address |
| shipping_address_company | The mailing address to where the order will be shipped. The company of the person associated with the shipping address |
| shipping_address_country | The mailing address to where the order will be shipped. The name of the country of the shipping address |
| shipping_address_country_code | The mailing address to where the order will be shipped. The two-letter code (ISO 3166-1 format) for the country of the shipping address |
| shipping_address_first_name | The mailing address to where the order will be shipped. The first name of the person associated with the shipping address |
| shipping_address_last_name | The mailing address to where the order will be shipped. The last name of the person associated with the shipping address |
| shipping_address_latitude | The mailing address to where the order will be shipped. The latitude of the shipping address |
| shipping_address_longitude | The mailing address to where the order will be shipped. The longitude of the shipping address |
| shipping_address_name | The mailing address to where the order will be shipped. The full name of the person associated with the payment method |
| shipping_address_phone | The mailing address to where the order will be shipped. The phone number at the shipping address |
| shipping_address_province | The mailing address to where the order will be shipped. The name of the region (province, state, prefecture, …) of the shipping address |
| shipping_address_province_code | The mailing address to where the order will be shipped. The two-letter abbreviation of the region of the shipping address |
| shipping_address_zip | The mailing address to where the order will be shipped. The postal code (zip, postcode, Eircode, …) of the shipping address |
| source_identifier | |
| source_name | Where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for Shopify channels are protected and cannot be assigned by other API clients: web, pos, shopify_draft_order, iphone, and android. Orders created via the API can be assigned any other string of your choice. If unspecified, then new orders are assigned the value of your app’s ID |
| source_url | |
| subtotal_price | The price of the order in the shop currency after discounts but before shipping, taxes, and tips |
| subtotal_price_set_presentment_money_amo… | |
| subtotal_price_set_presentment_money_cur… | |
| subtotal_price_set_shop_money_amount | |
| subtotal_price_set_shop_money_currency_c… | |
| tags | 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 |
| taxes_included | Whether taxes are included in the order subtotal |
| test | Whether this is a test order |
| token | A unique token for the order |
| total_discounts | The total discounts applied to the price of the order in the shop currency |
| total_discounts_set_presentment_money_am… | |
| total_discounts_set_presentment_money_cu… | |
| total_discounts_set_shop_money_amount | |
| total_discounts_set_shop_money_currency_… | |
| total_line_items_price | The sum of all line item prices in the shop currency |
| total_line_items_price_set_presentment_m… | |
| total_line_items_price_set_presentment_m… | |
| total_line_items_price_set_shop_money_am… | |
| total_line_items_price_set_shop_money_cu… | |
| total_price | 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 | |
| total_price_set_presentment_money_curren… | |
| total_price_set_shop_money_amount | |
| total_price_set_shop_money_currency_code | |
| total_price_usd | |
| total_shipping_price_set_presentment_mon… | |
| total_shipping_price_set_presentment_mon… | |
| total_shipping_price_set_shop_money_amou… | |
| total_shipping_price_set_shop_money_curr… | |
| total_tax | The sum of all the taxes applied to the order in the shop currency. Must be positive) |
| total_tax_set_presentment_money_amount | |
| total_tax_set_presentment_money_currency… | |
| total_tax_set_shop_money_amount | |
| total_tax_set_shop_money_currency_code | |
| total_tip_received | The sum of all the tips in the order in the shop currency |
| total_weight | The sum of all line item weights in grams |
| user_id | The ID of the user logged into Shopify POS who processed the order, if applicable |
| created_at | 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 | 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 |
| Parameter | Description |
| id | The unique numeric identifier for the page |
| author | The name of the person who created the page |
| body_html | The text content of the page, complete with HTML markup |
| handle | A unique, human-friendly string for the page, generated automatically from its title. In online store themes, the Liquid templating language refers to a page by its handle |
| published_at | The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden |
| shop_id | The ID of the shop to which the page belongs |
| template_suffix | The suffix of the Liquid template being used. For example, if the value is contact, then the page is using the page.contact.liquid template. If the value is an empty string, then the page is using the default page.liquid template |
| title | The page’s title |
| created_at | The date and time (ISO 8601 format) when the page was created |
| updated_at | The date and time (ISO 8601 format) when the page was last updated |
| Parameter | Description |
| id | The unique identifier of the payout |
| amount | The total amount of the payout, in a decimal formatted string |
| currency | The ISO 4217 currency code of the payout |
| date | The date (ISO 8601 format) when the payout was issued |
| status | The transfer status of the payout. The value will be one of the following: |
| summary_adjustments_fee_amount | Adjustments fee gross |
| summary_adjustments_gross_amount | Adjustments gross |
| summary_charges_fee_amount | Charges fee |
| summary_charges_gross_amount | Charges gross |
| summary_refunds_fee_amount | Refund fee |
| summary_refunds_gross_amount | Refund gross |
| summary_reserved_funds_fee_amount | Reserved funds fee |
| summary_reserved_funds_gross_amount | Reserved funds gross |
| summary_retried_payouts_fee_amount | Retried payouts fee |
| summary_retried_payouts_gross_amount | Retried payouts gross |
| Parameter | Description |
| body | A description of the policy |
| handle | A unique identifer for the policy used to build the policy’s URL |
| title | The name of the policy |
| url | The public URL of the policy |
| created_at | The date and time (ISO 8601 format) when the policy was created |
| updated_at | The date and time (ISO 8601 format) when the policy was last modified |
| payout_status | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout |
| processed_at | The time the transaction was processed |
| source_id | The id of the resource leading to the transaction |
| source_order_id | The id of the Order that this transaction ultimately originated from |
| source_order_transaction_id | The id of the Order Transaction that resulted in this balance transaction |
| source_type | The type of the resource leading to the transaction |
| test | If the transaction was created for a test mode Order or payment |
| type | The type of the balance transaction. The value will be one of the following: |
| Parameter | Description |
| id | The ID for the price rule |
| allocation_limit | The number of times the discount can be allocated on the cart – if eligible. For example a Buy 1 hat Get 1 hat for free discount can be applied 3 times on a cart having more than 6 hats, where maximum of 3 hats get discounted – if the allocation_limit is 3. Empty (null) allocation_limit means unlimited number of allocations., allocation_limit is only working with Buy X Get Y discount. The default value on creation will be null (unlimited) |
| allocation_method | The allocation method of the price rule. Valid values:, When the value of target_type is shipping_line, then this value must be each |
| customer_selection | The customer selection for the price rule |
| ends_at | The date and time (ISO 8601 format) when the price rule ends. Must be after starts_at |
| entitled_collection_ids | A list of IDs of collections whose products will be eligible to the discount. It can be used only with target_type set to line_item and target_selection set to entitled. It can’t be used in combination with entitled_product_ids or entitled_variant_ids |
| entitled_country_ids | A list of IDs of shipping countries that will be entitled to the discount. It can be used only with target_type set to shipping_line and target_selection set to entitled |
| entitled_product_ids | A list of IDs of products that will be entitled to the discount. It can be used only with target_type set to line_item and target_selection set to entitled., If a product variant is included in entitled_variant_ids, then entitled_product_ids can’t include the ID of the product associated with that variant |
| entitled_variant_ids | A list of IDs of product variants that will be entitled to the discount. It can be used only with target_type set to line_item and target_selection set to entitled., If a product is included in entitled_product_ids, then entitled_variant_ids can’t include the ID of any variants associated with that product |
| once_per_customer | Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer ID |
| prerequisite_collection_ids | List of collection ids that will be a prerequisites for a Buy X Get Y discount. The entitled_collection_ids can be used only with: |
| prerequisite_customer_ids | A list of customer IDs. For the price rule to be applicable, the customer must match one of the specified customers., If prerequisite_customer_ids is populated, then prerequisite_saved_search_ids must be empty |
| prerequisite_product_ids | List of product ids that will be a prerequisites for a Buy X Get Y type discount. The prerequisite_product_ids can be used only with:, If a product variant is included in prerequisite_variant_ids, then prerequisite_product_ids can’t include the ID of the product associated with that variant |
| prerequisite_quantity_range_greater_than… | The minimum number of items for the price rule to be applicable. greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value |
| prerequisite_saved_search_ids | A list of customer saved search IDs. For the price rule to be applicable, the customer must be in the group of customers matching a customer saved search., If prerequisite_saved_search_ids is populated, then prerequisite_customer_ids must be empty |
| prerequisite_shipping_price_range_less_t… | The maximum shipping price for the price rule to be applicable. less_than_or_equal_to: The shipping price must be less than or equal to this value |
| prerequisite_subtotal_range_greater_than… | The minimum subtotal for the price rule to be applicable. greater_than_or_equal_to: The subtotal of the entitled cart items must be greater than or equal to this value for the discount to apply |
| prerequisite_to_entitlement_quantity_rat… | Buy/Get ratio for a Buy X Get Y discount. prerequisite_quantity defines the necessary ‘buy’ quantity and entitled_quantity the offered ‘get’ quantity., The prerequisite_to_entitlement_quantity_ratio can be used only with:, Cannot be used in combination with prerequisite_subtotal_range, prerequisite_quantity_range or prerequisite_shipping_price_range |
| prerequisite_to_entitlement_quantity_rat… | Buy/Get ratio for a Buy X Get Y discount. prerequisite_quantity defines the necessary ‘buy’ quantity and entitled_quantity the offered ‘get’ quantity., The prerequisite_to_entitlement_quantity_ratio can be used only with:, Cannot be used in combination with prerequisite_subtotal_range, prerequisite_quantity_range or prerequisite_shipping_price_range |
| prerequisite_variant_ids | List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The entitled_variant_ids can be used only with:, If a product is included in prerequisite_product_ids, then prerequisite_variant_ids can’t include the ID of any variants associated with that product |
| starts_at | The date and time (ISO 8601 format) when the price rule starts |
| target_selection | The target selection method of the price rule |
| target_type | The target type that the price rule applies to |
| title | The title of the price rule. This is used by the Shopify admin search to retrieve discounts. It is also displayed on the page of the Shopify admin for bulk discounts., For non-bulk discounts, the discount code is displayed on the admin., For a consistent search experience, use the same value for title as the code property of the associated discount code |
| usage_limit | The maximum number of times the price rule can be used, per discount code |
| value | The value of the price rule. If if the value of target_type is shipping_line, then only -100 is accepted. The value must be negative |
| value_type | The value type of the price rule. Valid values:, If target_type is shipping_line, then only percentage is accepted |
| created_at | The date and time (ISO 8601 format) when the price rule was created |
| updated_at | The date and time (ISO 8601 format) when the price rule was updated |
| Parameter | Description |
| collection_id | The ID of the custom collection containing the product |
| product_id | The unique numeric identifier for the product in the custom collection |
| Parameter | Description |
| id | A unique numeric identifier for the product image |
| alt | |
| height | Height dimension of the image which is determined on upload |
| position | The order of the product image in the list. The first product image is at position 1 and is the “main” image for the product |
| product_id | The id of the product associated with the image |
| src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| variant_ids | An array of variant ids associated with the image |
| width | Width dimension of the image which is determined on upload |
| created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| updated_at | The date and time when the product image was last modified. The API returns this value in ISO 8601 format |
| Parameter | Description |
| available | |
| body_html | The description of the product, complete with HTML formatting |
| handle | A human-friendly unique string for the Product automatically generated from its title |
| product_id | The unique identifer of the product this listing is for. The primary key for this resource |
| product_type | A categorization that a product can be tagged with, commonly used for filtering |
| published_at | The date and time when the product was published. The API returns this in ISO 8601 |
| tags | A categorization that a product can be tagged with, commonly used for filtering |
| title | The name of the product |
| vendor | The name of the vendor of the product |
| created_at | The date and time when the product was created. The API returns this in ISO 8601 |
| updated_at | The date and time when the product was last modified. The API returns this in ISO 8601 |
| Parameter | Description |
| id | An unsigned 64-bit integer that’s used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they’re from different shops |
| body_html | A description of the product. Supports HTML formatting |
| handle | A unique human-friendly string for the product. Automatically generated from the product’s title. Used by the Liquid templating language to refer to objects |
| image_alt | |
| image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| image_height | Height dimension of the image which is determined on upload |
| image_id | A unique numeric identifier for the product image |
| image_position | The order of the product image in the list. The first product image is at position 1 and is the “main” image for the product |
| image_product_id | The id of the product associated with the image |
| image_src | Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png) |
| image_updated_at | The date and time when the product image was last modified. The API returns this value in ISO 8601 format |
| image_width | Width dimension of the image which is determined on upload |
| product_type | A categorization for the product used for filtering and searching products |
| published_at | The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel |
| published_scope | Whether the product is published to the Point of Sale channel |
| tags | A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters |
| template_suffix | The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called “product.suffix.liquid”, where “suffix” is the value of this property. If this property is “” or null, then the product page uses the default template “product.liquid”. (default: null) |
| title | The name of the product |
| vendor | The name of the product’s vendor |
| created_at | The date and time (ISO 8601 format) when the product was created |
| updated_at | The date and time (ISO 8601 format) when the product was last modified |
| Parameter | Description |
| id | The unique numeric identifier for the product variant |
| barcode | The barcode, UPC, or ISBN number for the product |
| compare_at_price | The original price of the item before an adjustment or a sale |
| fulfillment_service | The fulfillment service associated with the product variant. Valid values: manual or the handle of a fulfillment service |
| grams | The weight of the product variant in grams |
| image_id | The unique numeric identifier for a product’s image. The image must be associated to the same product as the variant |
| inventory_item_id | The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information |
| inventory_management | The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to “shopify”. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property |
| inventory_policy | Whether customers are allowed to place an order for the product variant when it’s out of stock |
| inventory_quantity | An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource |
| old_inventory_quantity | This property is deprecated. Use the InventoryLevel resource instead |
| option1 | The custom properties that a shop owner uses to define product variants. You can define three options for a product: option1, option2, option3. Default value: Default Title |
| option2 | The custom properties that a shop owner uses to define product variants. You can define three options for a product: option1, option2, option3. Default value: Default Title |
| option3 | The custom properties that a shop owner uses to define product variants. You can define three options for a product: option1, option2, option3. Default value: Default Title |
| position | The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed |
| price | The price of the product variant |
| product_id | The unique numeric identifier for the product |
| requires_shipping | Whether a customer needs to provide a shipping address when placing an order for the product variant |
| sku | A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService |
| taxable | Whether a tax is charged when the product variant is sold |
| title | The title of the product variant |
| weight | The weight of the product variant in the unit system specified with weight_unit |
| weight_unit | The unit of measurement that applies to the product variant’s weight. If you don’t specify a value for weight_unit, then the shop’s default unit of measurement is applied. Valid values: g, kg, oz, and lb |
| created_at | The date and time (ISO 8601 format) when the product variant was created |
| updated_at | The date and time when the product variant was last modified. Gets returned in ISO 8601 format |
| Parameter | Description |
| id | The ID for the province |
| code | The standard abbreviation for the province |
| country_id | The ID for the country that the province belongs to |
| name | The full name of the province |
| shipping_zone_id | The ID for the shipping zone that the province belongs to |
| tax | The sales tax rate to be applied to orders made by customers from this province |
| tax_name | The name of the tax for this province |
| tax_percentage | The province’s tax in percent format |
| tax_type | The tax type. Valid values: normal, null, or harmonized. If the value is harmonized, then the tax is compounded of the provincial and federal sales taxes |
| Parameter | Description |
| id | The unique identifier for the refund |
| note | An optional note attached to a refund |
| order_id | The unique identifier for the order that the refund is associated with |
| processed_at | The date and time (ISO 8601 format) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in Shopify |
| restock | Whether to add the line items back to the store’s inventory., Provide a restock_type to influence how this refund affects inventory instead |
| user_id | The unique identifier of the user who performed the refund |
| created_at | The date and time (ISO 8601 format) when the refund was created |
| Parameter | Description |
| id | The ID for the redirect |
| path | The old path to be redirected. When the user visits this path, they will be redirected to the target. (maximum: 1024 characters) |
| target | The target location where the user will be redirected. When the user visits the old path specified by the path property, they will be redirected to this location. This property can be set to any path on the shop’s site, or to an external URL. (maximum: 255 characters) |
| Parameter | Description |
| Parameter | Description |
| id | The unique numeric identifier for the report |
| category | The category for the report. When you create a report, the API will return custom_app_reports. , |
| name | The name of the report. Maximum length: 255 characters |
| shopify_ql | The ShopifyQL query that generates the report. See Shopify Query Language |
| updated_at | The date and time (ISO 8601) when the report was last modified |
| Parameter | Description |
| id | The ID for the script tag |
| display_scope | The page or pages on the online store where the script should be included |
| event | The DOM event that triggers the loading of the script. Valid values: onload |
| src | The URL of the remote script |
| created_at | The date and time (ISO 8601) when the script tag was created |
| updated_at | The date and time (ISO 8601) when the script tag was last updated |
| Parameter | Description |
| id | The unique numeric identifier for the shipping zone |
| location_group_id | The ID of the shipping zone’s location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group |
| name | The name of the shipping zone, specified by the user |
| profile_id | The ID of the shipping zone’s delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates |
| Parameter | Description |
| id | The ID for the shop. A 64-bit unsigned integer |
| address1 | The shop’s street address |
| address2 | The the optional second line of the shop’s street address |
| auto_configure_tax_inclusivity | |
| checkout_api_supported | Whether the shop is capable of accepting payments directly through the Checkout API |
| city | The shop’s city |
| cookie_consent_level | |
| country | The shop’s country. In most cases matches the country_code |
| country_code | The two-letter country code corresponding to the shop’s country |
| country_name | The shop’s normalized country name |
| county_taxes | Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: true or null.” |
| currency | The three-letter code (ISO 4217 format) for the shop’s default currency |
| customer_email | The contact email used for communication between the shop owner and the customer |
| domain | The shop’s domain |
| eligible_for_card_reader_giveaway | Whether the shop is eligible to receive a free credit card reader from Shopify |
| eligible_for_payments | Whether the shop is eligible to use Shopify Payments |
| The contact email used for communication between Shopify and the shop owner | |
| enabled_presentment_currencies | A list of enabled currencies (ISO 4217 format) that the shop accepts. Merchants can enable currencies from their Shopify Payments settings in the Shopify admin |
| force_ssl | Whether the shop forces requests made to its resources to be made over SSL using the HTTPS protocol. Valid values: true or false |
| google_apps_domain | The GSuite URL for the store, if applicable |
| google_apps_login_enabled | Whether the GSuite login is enabled. Shops with this feature will be able to log in through the GSuite login page. Valid values: true, null |
| has_discounts | Whether any active discounts exist for the shop |
| has_gift_cards | Whether any active gift cards exist for the shop |
| has_storefront | Whether the shop has an online storefront |
| iana_timezone | The name of the timezone assigned by the IANA |
| latitude | The latitude of the shop’s location |
| longitude | The longitude of the shop’s location |
| money_format | A string representing the way currency is formatted when the currency isn’t specified |
| money_in_emails_format | A string representing the way currency is formatted in email notifications when the currency isn’t specified |
| money_with_currency_format | A string representing the way currency is formatted when the currency is specified |
| money_with_currency_in_emails_format | A string representing the way currency is formatted in email notifications when the currency is specified |
| multi_location_enabled | Whether the shop has enabled multiple locations |
| myshopify_domain | The shop’s myshopify.com domain |
| name | The name of the shop |
| password_enabled | Whether the password protection page is enabled on the online storefront |
| phone | The contact phone number for the shop |
| plan_display_name | The display name of the Shopify plan the shop is on |
| plan_name | The name of the Shopify plan the shop is on |
| pre_launch_enabled | Whether the pre-launch page is enabled on the online storefront |
| primary_locale | The shop’s primary locale, as configured in the language settings of the shop’s theme |
| primary_location_id | Formerly used for the ID of the shipping origin location (read only)., Use the Location resource instead |
| province | The shop’s normalized province or state name |
| province_code | The two-letter code for the shop’s province or state |
| requires_extra_payments_agreement | Whether the shop requires an extra Shopify Payments agreement |
| setup_required | Whether the shop has any outstanding setup steps or not |
| shop_owner | The username of the shop owner |
| source | The handle of the partner account that referred the merchant to Shopify, if applicable |
| tax_shipping | Whether taxes are charged for shipping. Valid values: true or false |
| taxes_included | Whether applicable taxes are included in product prices. Valid values: true or null |
| timezone | The name of the timezone the shop is in |
| visitor_tracking_consent_preference | |
| weight_unit | The default unit of weight measurement for the shop |
| zip | The shop’s zip or postal code |
| created_at | The date and time (ISO 8601) when the shop was created |
| updated_at | The date and time (ISO 8601) when the shop was last updated |
| Parameter | Description |
| id | The ID of the smart collection |
| body_html | The description of the smart collection. Includes HTML markup. Many shop themes display this on the smart collection page |
| disjunctive | Whether the product must match all the rules to be included in the smart collection |
| handle | A human-friendly unique string for the smart collection. Automatically generated from the title. Used in shop themes by the Liquid templating language to refer to the smart collection. (maximum: 255 characters) |
| image_alt | Alternative text that describes the collection image |
| image_created_at | The date and time when the product image was created. The API returns this value in ISO 8601 format |
| image_height | Height dimension of the image which is determined on upload |
| image_src | A URL that specifies the location of the image |
| image_width | Width dimension of the image which is determined on upload |
| published_at | The date and time (ISO 8601 format) that the smart collection was published. Returns null when the collection is hidden |
| published_scope | Whether the smart collection is published to the Point of Sale channel |
| sort_order | The order of the products in the smart collection |
| template_suffix | The suffix of the Liquid template that the shop uses. By default, the original template is called product.liquid, and additional templates are called product.suffix.liquid |
| title | The name of the smart collection. Maximum length: 255 characters |
| updated_at | The date and time (ISO 8601 format) when the smart collection was last modified |
| Parameter | Description |
| tag |
| Parameter | Description |
| id | The ID of the transaction |
| amount | The amount of the tender transaction in the shop’s currency |
| currency | The three-letter code (ISO 4217 format) for the currency used for the tender transaction |
| order_id | The ID of the order that the tender transaction belongs to |
| payment_details_credit_card_company | Information about the payment instrument used for this transaction. The name of the company that issued the customer’s credit card |
| payment_details_credit_card_number | Information about the payment instrument used for this transaction. The customer’s credit card number, with most of the leading digits redacted |
| payment_method | Information about the payment method used for this transaction |
| processed_at | The date and time (ISO 8601 format) when the tender transaction was processed |
| remote_reference | The remote (gateway) reference associated with the tender |
| test | Whether the tender transaction is a test transaction |
| user_id | The ID of the user logged into the Shopify POS device that processed the tender transaction, if applicable |
| Parameter | Description |
| id | A unique numeric identifier for the theme |
| name | The name of the theme |
| previewable | Whether the theme can currently be previewed |
| processing | Whether files are still being copied into place for this theme |
| role | Specifies how the theme is being used within the shop |
| theme_store_id | A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store. Not all themes available in the Theme Store are developed by Shopify. Returns null if the store’s theme isn’t made by Shopify, or if it wasn’t installed from the Theme Store |
| created_at | The date and time (ISO 8601 format) when the theme was created |
| updated_at | The date and time ( ISO 8601 format) when the theme was last updated |
| Parameter | Description |
| id | The ID for the transaction |
| amount | The amount of money included in the transaction. If you don’t provide a value for amount, then it defaults to the total cost of the order (even if a previous transaction has been made towards it) |
| authorization | The authorization code associated with the transaction |
| currency | The three-letter code (ISO 4217 format) for the currency used for the payment |
| currency_exchange_adjustment_adjustment | An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. The difference between the amounts on the associated transaction and the parent transaction |
| currency_exchange_adjustment_currency | An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. The shop currency |
| currency_exchange_adjustment_final_amoun… | An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. The amount of the associated transaction in the shop currency |
| currency_exchange_adjustment_id | An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. The ID of the adjustment |
| currency_exchange_adjustment_original_am… | An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. The amount of the parent transaction in the shop currency |
| device_id | The ID for the device |
| error_code | A standardized error code, independent of the payment provider |
| gateway | The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify’s payment gateways page |
| kind | The transaction’s type |
| location_id | The ID of the physical location where the transaction was processed |
| message | A string generated by the payment provider with additional information about why the transaction succeeded or failed |
| order_id | The ID for the order that the transaction is associated with |
| parent_id | The ID of an associated transaction |
| payment_details_avs_result_code | The response code from the address verification system. The code is a single letter; see this chart for the codes and their definitions |
| payment_details_credit_card_bin | The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer’s credit card. This is made up of the first few digits of the credit card number |
| payment_details_credit_card_company | The name of the company that issued the customer’s credit card |
| payment_details_credit_card_number | The customer’s credit card number, with most of the leading digits redacted |
| payment_details_cvv_result_code | The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions |
| processed_at | The date and time (ISO 8601 format) when a transaction was processed. This value is the date that’s used in the analytic reports. By default, it matches the created_at value. If you’re importing transactions 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 transaction was processed |
| receipt_authorization | |
| receipt_testcase | |
| source_name | The origin of the transaction. This is set by Shopify and can’t be overridden. Example values: web, pos, iphone, and android |
| status | The status of the transaction. Valid values: pending, failure, success, and error |
| test | Whether the transaction is a test transaction |
| user_id | The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable |
| created_at | The date and time (ISO 8601 format) when the transaction was created |
| Parameter | Description |
| id | The ID of the user’s staff account |
| account_owner | Whether the user is the owner of the Shopify account |
| bio | The description the user has written for themselves |
| The user’s email address | |
| first_name | The user’s first name |
| im | The user’s IM account address |
| last_name | The user’s last name |
| locale | The user’s preferred locale. Locale values use the format language or language-COUNTRY, where language is a two-letter language code, and COUNTRY is a two-letter country code. For example: en or en-US |
| permissions | The permissions that the user’s staff account has. Users will either have full permissions or a list of specific permissions |
| phone | The user’s phone number |
| receive_announcements | Whether this account will receive email announcements from Shopify |
| screen_name | This property is |
| tfa_enabled_ | |
| url | The user’s homepage or other web address |
| user_type | The type of account the user has |
| Parameter | Description |
| id | Unique numeric identifier for the webhook subscription |
| address | URI where the webhook subscription should send the POST request when the event occurs |
| api_version | The Admin API version that Shopify uses to serialize webhook events. This value is set by the app that created the webhook |
| format | Format in which the webhook subscription should send the data. Valid values are JSON and XML |
| topic | Event that triggers the webhook. Valid values are: app/uninstalled, carts/create, carts/update, checkouts/create, checkouts/delete, checkouts/update, collection_listings/add, collection_listings/remove, collection_listings/update, collections/create, collections/delete, collections/update, customer_groups/create, customer_groups/delete, customer_groups/update, customers/create, customers/delete, customers/disable, customers/enable, customers/update, draft_orders/create, draft_orders/delete, draft_orders/update, fulfillment_events/create, fulfillment_events/delete, fulfillments/create, fulfillments/update, inventory_items/create, inventory_items/delete, inventory_items/update, inventory_levels/connect, inventory_levels/disconnect, inventory_levels/update, locales/create, locales/update, locations/create, locations/delete, locations/update, order_transactions/create, orders/cancelled, orders/create, orders/delete, orders/fulfilled, orders/paid, orders/partially_fulfilled, orders/updated, product_listings/add, product_listings/remove, product_listings/update, products/create, products/delete, products/update, refunds/create, shop/update, tender_transactions/create, themes/create, themes/delete, themes/publish, themes/update |
| created_at | Date and time when the webhook subscription was created. The API returns this value in ISO 8601 format |
| updated_at | Date and time when the webhook subscription was updated. The API returns this value in ISO 8601 format |
Ready-to-use data connectors
We have developed data connectors to 200+ APIs and web services. Can’t find your connector? Reach out to us through our chat. We are continuously developing new connectors.
