Shopify Connector for CData Sync
概要
CData Sync App は、Shopify データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Shopify コネクタはCData Sync アプリケーションから使用可能で、Shopify からデータを取得して、サポートされている任意の同期先に移動できます。
Shopify バージョンサポート
Sync App はShopify Admin API をリレーショナルデータベースにモデル化します。
接続の確立
Shopify への接続を追加
Shopify への接続を追加するには：- アプリケーションコンソールで、接続ページに移動します。
- 接続の追加パネルで、追加したい接続のアイコンを選択します。
- Shopify アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからShopify コネクタをダウンロードおよびインストールします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Shopify への接続
このセクションでは、Web、デスクトップアプリケーション、ヘッドレスアプリケーションからShopify に接続する方法について説明します。アクセストークンによる接続
アクセストークン経由の接続には、2つのステップが必要です。
- Shopify の管理画面でアクセストークンを作成
- アクセストークンを使用して認証
アクセストークンの作成
アプリを登録してアクセストークンを取得する方法は、次のとおりです。- 管理画面からShopify にログインしApps -> Apps and sales channels に進みます。
- Develop apps をクリックしてCreate an app を選択します。
- Overview タブで、Configure Admin API scopes をクリックし、アプリに許可するストアのアクセス権を選択します。プロバイダーがすべてのテーブルとビューを使用するために必要な権限は次のとおりです。
- read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
- read_content, write_content
- read_customers, write_customers
- read_draft_orders, write_draft_orders
- read_fulfillments, write_fulfillments
- read_gift_cards, write_gift_cards
- read_inventory, write_inventory
- read_marketing_events, write_marketing_events
- read_orders, write_orders
- read_price_rules, write_price_rules
- read_product_listings, write_product_listings
- read_products, write_products
- read_reports, write_reports
- read_script_tags, write_script_tags
- read_shopify_payments_payouts
- read_themes, write_themes
- read_markets
- read_shopify_payments_accounts
- read_publications
- unauthenticated_read_content (Storefront API)
- Save をクリックします。
- API Credentials を選択します。
- "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます。
- Admin API Access token のアクセストークンをコピーします。NOTE：トークンの公開およびコピーは1回のみ可能です。
アクセストークンによる認証
アクセストークンで認証するには、次を設定します。- AuthScheme：AccessToken に設定。
- AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定。
OAuth での接続
Shopify はOAuth 認証をサポートします。いかなる場合も、AuthScheme をOAuth に設定してカスタムOAuth アプリケーションを作成する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。
高度な機能
このセクションでは、Shopify Sync App の高度な機能を厳選して説明します。
ユーザー定義ビュー
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
ファイアウォールとプロキシ
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
クエリ処理
Sync App は、Shopify にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
ログ
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
SSL の設定
SSL 設定のカスタマイズ
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
ファイアウォールとプロキシ
Firewall またはProxy 経由の接続
HTTP プロキシ
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
その他のプロキシ
次のプロパティを設定します。
- プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
- 接続をトンネルするには、FirewallType をTUNNEL に設定します。
- 認証するには、FirewallUser とFirewallPassword を設定します。
- SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。
データモデル
CData Sync App は、Shopify API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
主要機能
- Include Custom Fields 接続プロパティを使用すると、Products およびProductVariants テーブルのカスタムフィールドを取得できます。この機能を有効にするには、このプロパティをTrue に設定します。
- Row Scan Depth 接続プロパティは、カスタムフィールドに対してフィルタリングされる行数を設定します。このプロパティのデフォルト値は50です。低い値を設定するとすべてのカスタムフィールドを取得できなくなる可能性がありますが、高い値を設定するとドライバーのパフォーマンスが低下します。この機能を使用するには、Include Custom Fields 接続プロパティをTrue に設定します。
- Flexible Schema は、Products およびProductVariants テーブルのカスタムフィールドを取得します。この機能は、Include Custom Fields 接続プロパティがTrue に設定されている場合に有効です。Flexible Schema は、カスタムフィールドを最大250行検索します。より多くのフィールドを取得するには、Row Scan Depth をより大きな値に設定します。
REST API の使用
REST API で利用可能なエンティティについては、REST Data Model を参照してください。
GraphQL API の使用
GraphQL API で利用可能なエンティティについては、GRAPHQL Data Model を参照してください。
API Version 2023-04
CData Sync App は、Shopify API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
主要機能
- Include Custom Fields 接続プロパティを使用すると、Products およびProductVariants テーブルのカスタムフィールドを取得できます。この機能を有効にするには、このプロパティをTrue に設定します。
- Row Scan Depth 接続プロパティは、カスタムフィールドに対してフィルタリングされる行数を設定します。このプロパティのデフォルト値は50です。低い値を設定するとすべてのカスタムフィールドを取得できなくなる可能性がありますが、高い値を設定するとドライバーのパフォーマンスが低下します。この機能を使用するには、Include Custom Fields 接続プロパティをTrue に設定します。
- Flexible Schema は、Products およびProductVariants テーブルのカスタムフィールドを取得します。この機能は、Include Custom Fields 接続プロパティがTrue に設定されている場合に有効です。Flexible Schema は、カスタムフィールドを最大250行検索します。より多くのフィールドを取得するには、Row Scan Depth をより大きな値に設定します。
REST API の使用
REST API で利用可能なエンティティについては、REST Data Model を参照してください。
GraphQL API の使用
GraphQL API で利用可能なエンティティについては、GRAPHQL Data Model を参照してください。
REST Data Model
CData Sync App は、Shopify API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
REST データモデルを使用するには、Schema をREST に設定します。
テーブル
テーブル は、Orders、Products などの変更可能なテーブルです。
ビュー
ビュー は、Events、Patouts、Reports などの変更ができないテーブルです。一般的に、読み取り専用のモデルデータはビューとして表示されます。
ストアドプロシージャ
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらのインターフェイスを使用して、データソース内の情報を検索、更新、および変更できます。
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| ApplicationCharges | Create or view Application Charges for Billing. |
| ApplicationCredit | Create or view Application Credit for Billing. |
| Articles | Create, read, update or delete articles |
| Assets | Create, read, update or delete assets. CUD support is no longer accessible for public apps. |
| Blogs | Create, read, update or delete blogs |
| CarrierServices | Returns a list of resource feedback objects.. |
| CollectionListings | Query and delete information regarding different collects. |
| Collects | Query, insert, or delete information regarding different collects. |
| Comments | Create, read, update and delete the comments. |
| Countries | Create, select, update, and delete information regarding countries. |
| CustomCollections | Query, insert, update, or delete information regarding different custom collections. |
| CustomerAddresses | Create, update, delete, and query customer addresses. |
| Customers | Create, update, delete, and query customers. |
| DiscountCodes | Create, select, update, and delete information regarding discount codes. |
| DraftOrders | Create, update, delete, and query draft orders. |
| FulfillmentEvents | Create, delete, and query information regarding fulfillment events. |
| Fulfillments | Create, update, and query fulfillments. |
| FulfillmentServices | Query, create, update, and delete information regarding different fulfillment services. |
| GiftCards | Create, update, delete, and query gift cards. |
| InventoryItems | Query and update information regarding different inventory items. |
| InventoryLevels | Query, create, and update information regarding different inventory levels. |
| MarketingEvents | Create, update, delete, and query marketing events. |
| Metafields | Retrieves a list of metafields that belong to a resource. |
| OrderRisks | Create, update, delete, and query order risks. |
| Orders | Create, update, delete, and query orders. |
| OrderTransactions | Create and query transactions. |
| Pages | Create, read, update or delete pages |
| PriceRules | Create, update, delete, and query price rules. |
| ProductImages | Query, Update and Delete Product Images |
| ProductListings | Query and delete product listings. |
| ProductOptions | Query product options. |
| ProductResourceFeedbacks | Returns a list of resource feedback objects.. |
| Products | List of products. |
| ProductVariants | List of the product variants. |
| Provinces | Query and update information regarding different provinces. |
| RecurringApplicationCharges | Create, update, delete, and query Recurring Application Charges. |
| Redirects | Create, read, update or delete redirects. |
| Refunds | Create and query refunds. |
| ResourceFeedbacks | Returns a list of resource feedback objects.. |
| ScriptTags | Create, read, update or delete script tags. |
| SmartCollections | Query, insert, update, or delete information regarding different smart collections. |
| Themes | Create, read, update or delete themes |
| UsageCharges | Create or view Usage Charges for Recurring Application Charges. |
ApplicationCharges
Create or view Application Charges for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCharges WHERE Id = '123'
Insert
INSERT INTO ApplicationCharges ( Test ) VALUES ( 'true' )
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The Unique Identifier of the Application Charge | |
| Name | String | False |
The Order Number | |
| ApiClientId | Long | True |
The API Client ID | |
| Price | Decimal | False |
The price of the application charge | |
| Status | String | True |
The status of the application charge. Valid Values are: pending, active, declined, expired | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting a charge. | |
| Test | String | False |
Whether the application charge is a test transaction. Valid values:true,null | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was last updated. | |
| ChargeType | String | True |
The type of the application charge | |
| DecoratedReturnUrl | String | True |
The decorated return url |
ApplicationCredit
Create or view Application Credit for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCredit WHERE Id = '123'
Insert
INSERT INTO ApplicationCredit (Amount, Description, Test) VALUES ('100', 'success or failure', 'true')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the application credit. | |
| Amount | Decimal | False |
The amount refunded by the application credit. | |
| Description | String | False |
The description of the application credit. | |
| Test | String | False |
Whether the application credit is a test transaction. Valid values: true,null |
Articles
Create, read, update or delete articles
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '123'
Insert
You must specify the Title to create an Article.
INSERT INTO Articles (BlogId, Author, Title) VALUES ('599421749', 'Adam', 'New Article')
Update
You must specify the blog id and id to update an article. For example:
UPDATE Articles SET Author = 'Harry' WHERE BlogId = '599421749' AND Id = '5557081211'
Delete
You must specify the Id and the Blog Id of the article to delete it.
DELETE FROM Articles WHERE BlogId = '599421749' AND Id = '5556952105'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the article. | |
| BlogId [KEY] | Long | False |
Blogs.Id |
The ID of the blog containing the article. |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the author of the article. | |
| BodyHtml | String | False |
The text of the body of the article, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was created. | |
| Handle | String | False |
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. | |
| ImageAlt | String | False |
Alternative text that describes the image. | |
| ImageCreatedAt | Datetime | True |
The date and time when image is created. | |
| ImageHeight | Int | False |
Height of the image. | |
| ImageSrc | String | False |
A source URL that specifies the location of the image. | |
| ImageWidth | Int | False |
Width of the image. | |
| ImageAttachment | String | False |
An image attached to article returned as Base64-encoded binary data. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the article was published. | |
| SummaryHtml | String | False |
A summary of the article, complete with HTML markup. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the article. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was last updated. | |
| UserId | Long | True |
A unique numeric identifier for the author of the article. | |
| PublishedStatus | String | False |
Filter articles by their publish status. Valid values are: published, unpublished and any ; default: any. |
Assets
Create, read, update or delete assets. CUD support is no longer accessible for public apps.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Assets WHERE Key = 'assets/abc.gif'
Insert
You must specify the Theme Id and Key to insert an Asset. For example:
INSERT INTO Assets(Key, Value, ThemeId) VALUES('assets/abc.gif', '
Update
You must specify the Theme Id and Key to update an Asset. For example:
UPDATE Assets SET value = 'pqrs' WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Delete
You must specify the Id and the Theme Id of the Asset to delete it.
DELETE FROM Assets WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Columns
| Name | Type | ReadOnly | References | Description |
| Key [KEY] | String | False |
The path to the asset within a theme. | |
| ThemeId [KEY] | Long | True |
Themes.Id |
The ID for the theme that an asset belongs to. |
| Attachment | String | False |
A base64-encoded image. | |
| Checksum | String | True |
The MD5 representation of the content, consisting of a string of 32 hexadecimal digits. May be null if an asset has not been updated recently. | |
| ContentType | String | True |
The MIME representation of the content, consisting of the type and subtype of the asset. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the asset was created. | |
| PublicUrl | String | True |
The public-facing URL of the asset. | |
| Size | Int | True |
The asset size in bytes. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when an asset was last updated. | |
| Value | String | False |
The text content of the asset, such as the HTML and Liquid markup of a template file. |
Blogs
Create, read, update or delete blogs
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Handle column and Id. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- Handle supports the '=,IN' comparison.
SELECT * FROM Blogs WHERE Id = '123'
SELECT * FROM Blogs WHERE Id IN ('123', '345')
SELECT * FROM Blogs WHERE Handle = 'new-blog-5927';
SELECT * FROM Blogs WHERE Handle IN ('new-blog-5927', 'new-blog-5926');
Insert
You must specify the Title to create a Blog.
INSERT INTO Blogs (title) VALUES ('new blog')
INSERT INTO Blogs (Title, Metafields) VALUES ('new blog','[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]')
Update
You must specify the id to update a Blog. For example:
UPDATE Blogs SET title = 'new blog' WHERE Id = '77171130'
UPDATE Blogs SET Metafields='[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]' WHERE Id='77171130'
Delete
You must specify the Id of the Blog to delete it.
DELETE FROM Blogs WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the blog. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Commentable | String | False |
Indicates whether readers can post comments to the blog and if comments are moderated or not. | |
| CreatedAt | Datetime | True |
The date and time when the blog was created. | |
| Feedburner | String | False |
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. | |
| FeedburnerLocation | String | False |
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 | String | False |
A human-friendly unique string for a blog automatically generated from its title. | |
| Metafields | String | False |
Attaches additional metadata to a store's resources. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the blog. | |
| UpdatedAt | Datetime | True |
The date and time when changes were last made to the blog's properties. |
CarrierServices
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CarrierServices
SELECT * FROM CarrierServices WHERE Id = '123'
SELECT * FROM CarrierServices WHERE Id IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [CarrierServices] (Name, Type, CallbackUrl) VALUES ('ApiServiceType', 'api', 'https://test.com');
Update
You must specify the id to update a Redirect. For example:
UPDATE [CarrierServices] SET [Active] = 'false' WHERE [Id] = 59103608855;
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM [CarrierServices] WHERE [Id] = 59103608855;
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the carrier service. | |
| Active | Bool | False |
Whether this carrier service is active. If true, then the service will be available to serve rates in checkout. | |
| Name | String | False |
The name of the shipping service as seen by merchants and their customers. | |
| CallbackUrl | String | False |
The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL. | |
| Type | String | False |
Distinguishes between API or legacy carrier services. | |
| Format | String | False |
The format of the data returned by the URL endpoint. json is the only valid value. | |
| ServiceDiscovery | String | False |
Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. | |
| AdminGraphqlApiId | String | False |
The GraphQL GID for this carrier service. |
CollectionListings
Query and delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CollectionListings WHERE Id = '123'
Delete
You must specify the Id of the collection listing to delete it.
DELETE FROM CollectionListings WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The Id of the collection this listing belongs to. | |
| Title | String | True |
The titke of the collection listing. | |
| BodyHtml | String | True |
The HTML body/description for this listing. | |
| DefaultProductImage | String | True |
The default product image in this listing. | |
| ImageCreatedAt | String | True |
The date and time the image for this listing was created at. | |
| ImageSource | String | True |
The source/link of the image for this listing. | |
| Handle | String | True |
The handle of this listing. | |
| UpdatedAt | Datetime | True |
The date and time when the collection listing was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the collection listing was created. |
Collects
Query, insert, or delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Collects WHERE Id = '123'
Insert
You must specify the ProductId and CollectionId to create a collect.
INSERT INTO Collects (ProductId, CollectionId) VALUES ('512433520663', '22892937239')
Delete
You must specify the Id of the collect to delete it.
DELETE FROM Collects WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the collect. | |
| CollectionId | Long | False |
The Id of the collection this collection is linked with. | |
| ProductId | Long | False |
Products.Id |
The Id of the product this collection is linked with. |
| Position | Int | True |
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. | |
| SortValue | String | True |
This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. | |
| CreatedAt | Datetime | True |
The date and time when the collect was created. | |
| UpdatedAt | Datetime | True |
The date and time when the collect was last modified. |
Comments
Create, read, update and delete the comments.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Comments WHERE Id = '123'
Insert
You must specify Article Id, Author, Body, Email to create a Comment.
INSERT INTO Comments (articleid, author, body, email) VALUES ('5557001', 'Harry', 'test', '[email protected]')
Update
You must specify the Id to update a Comment. For example:
UPDATE Comments SET Author = 'Adam' WHERE Id = '77171130'
Delete
You must specify the Id of the Comments to delete it.
DELETE FROM Comments WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the comment. | |
| BlogId | Long | False |
Blogs.Id |
A unique numeric identifier for the blog containing the article that the comment belongs to. |
| ArticleId | Long | False |
Articles.Id |
A unique numeric identifier for the article that the comment belongs to. |
| Author | String | False |
The name of the author of the comment. | |
| Body | String | False |
The basic Textile markup of a comment. | |
| BodyHtml | String | False |
The text of the comment, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was created. | |
| String | False |
The email address of the author of the comment. | ||
| Ip | String | False |
The IP address from which the comment was posted. | |
| PublishedAt | String | False |
The date and time (ISO 8601 format) when the comment was published. | |
| Status | String | True |
The status of the comment. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was last modified. | |
| UserAgent | String | False |
The user agent string provided by the software used to create the comment. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
Countries
Create, select, update, and delete information regarding countries.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Countries
SELECT * FROM Countries WHERE Id = '123'
Insert
You must specify the Code to create a country.
INSERT INTO Countries (Code) VALUES ("FR")
Update
You must specify the country Id to update a country. For example:
UPDATE Countries SET Tax = 0.1 WHERE Id = '123'
Delete
You must specify the Id of the country to delete it.
DELETE FROM Countries WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the country. | |
| Name | String | True |
The name of the country. | |
| Code | String | False |
The code of the country. | |
| Tax | Decimal | False |
The amount of tax which should be applied for this country. | |
| Provinces | String | False |
The sub-regions of a country, such as its provinces or states. Each sub-region has the following properties: code: The two letter province or state code, country_id: The ID for the country to which this sub-region belongs, id: The ID for the particular sub-region, name: The name of the sub-region, tax: The tax value in decimal format, tax_name: The name of the tax as it is referred to in the applicable sub-region. For example, in Canada, the sales tax in the province Ontario is referred to as HST, tax_type: The tax type. Valid values: null, normal, or harmonized. If the value is harmonized, then the tax is compounded of the provincial and federal sales taxes, tax_percentage: The tax value in percent format |
CustomCollections
Query, insert, update, or delete information regarding different custom collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, and PublishedAt columns. The supported SQL operators are 'IN' for Id and Handle, '=' for the ProductId, Title and PublishedStatus columns, '>' and '<' for UpdatedAt and PublishedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM CustomCollections WHERE Id = '123'
SELECT * FROM CustomCollections WHERE Id IN ('123', '456')
SELECT * FROM CustomCollections WHERE ProductId = '123'
SELECT * FROM CustomCollections WHERE Title = 'Ducks'
SELECT * FROM CustomCollections WHERE Handle = 'frontpage'
SELECT * FROM CustomCollections WHERE Handle IN ('frontpage', 'lastpage')
SELECT * FROM CustomCollections WHERE PublishedStatus = 'published'
SELECT * FROM CustomCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM CustomCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title to create a custom collection.
INSERT INTO CustomCollections (Title) VALUES ('Macbooks')
INSERT INTO CustomCollections (Title, Published) VALUES ('Macbooks', false)
Update
You must specify the custom collection Id to update a custom collection. For example:
UPDATE CustomCollections SET Title = 'Updated title' WHERE Id = '123'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM CustomCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the custom collection. | |
| Title | String | False |
The title of the custom collection. | |
| BodyHtml | String | False |
The body/description of the custom collection. | |
| Image | String | False |
A JSON aggregate with information regarding the image of custom collection. | |
| Metafields | String | False |
Attaches additional metadata to a shop's resources: key: An identifier for the metafield. (maximum: 30 characters), namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters), value: Information to be stored as metadata, value_type: The information type being stored. Valid values: string or integer, description (optional): Additional information about the metafield . | |
| Handle | String | False |
A human-friendly unique string for the custom collection automatically generated from its title. | |
| SortOrder | String | False |
The order in which products in the custom collection appear. | |
| TemplateSuffix | String | False |
The suffix of the liquid template being used. | |
| PublishedScope | String | False |
The sales channels in which the custom collection is visible. | |
| UpdatedAt | Datetime | True |
The date and time when the custom collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the custom collection was published to the Online Store channel. | |
| ProductId | String | False |
Show custom collections that include a given product. | |
| PublishedStatus | String | False |
Show custom collection with a given published status: published: show only published custom collections, unpublished: show only unpublished custom collections, any: show custom collections of any published status. (default: any). |
CustomerAddresses
Create, update, delete, and query customer addresses.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- CustomerId supports the '=,IN' comparison.
- CustomerUpdatedAt supports the '<,>,<=,>=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM CustomerAddresses WHERE CustomerId = '123'
SELECT * FROM CustomerAddresses WHERE CustomerId IN ('123', '456')
SELECT * FROM CustomerAddresses WHERE CustomerUpdatedAt >= '2018-05-04'
Insert
You must specify the customer Id to create an address.
INSERT INTO CustomerAddresses (CustomerId, Address1, City, Company) VALUES ('123', '1 Rue des Carrieres', 'Suite 1234', 'Montreal')
Update
You must specify the customer Id and the Id of the customer address to update an address.
UPDATE CustomerAddresses SET Zip = '90210' WHERE CustomerId = '123' AND Id = '456'
Delete
You must specify the customer Id and the Id of the customer address to delete an address. You cannot delete a customer's default address.
DELETE FROM CustomerAddresses WHERE CustomerId = '183467180055' AND Id = '292265787415'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the address. | |
| CustomerId [KEY] | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerUpdatedAt | Datetime | True |
The date and time when the customer information was last updated. | |
| Name | String | False |
The customer's name. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| Company | String | False |
The customer's company. | |
| Address1 | String | False |
The customer's mailing address. | |
| Address2 | String | False |
An additional field for the customer's mailing address. | |
| City | String | False |
The customer's city. | |
| Province | String | False |
The customer's province or state name. | |
| Country | String | False |
The customer's country. | |
| Zip | String | False |
The customer's zip or postal code. | |
| Phone | String | False |
The customer's phone number for this mailing address. | |
| ProvinceCode | String | False |
The two-letter pcode for the customer's province or state. | |
| CountryCode | String | False |
The two-letter country code corresponding to the customer's country. | |
| CountryName | String | False |
The customer's normalized country name. | |
| Default | Bool | True |
Indicates whether this address is the default address for the customer. |
Customers
Create, update, delete, and query customers.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- FirstName supports the '=' comparison.
- LastName supports the '=' comparison.
- Email supports the '=' comparison.
- Phone supports the '=' comparison.
- TotalSpent supports the '=' comparison.
- OrdersCount supports the '=' comparison.
- AcceptsMarketing supports the '=' comparison.
- State supports the '=' comparison.
- VerifiedEmail supports the '=' comparison.
- CreatedAt supports the '>=,<=' comparison.
- UpdatedAt supports the '>=,<=,=' comparison.
SELECT * FROM Customers WHERE Id = '123'
SELECT * FROM Customers WHERE Id IN ('123', '456')
SELECT * FROM Customers WHERE CreatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE CreatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE FirstName = 'abc'
SELECT * FROM Customers WHERE LastName = 'xyz'
SELECT * FROM Customers WHERE Email = '[email protected]'
SELECT * FROM Customers WHERE OrdersCount = 5
SELECT * FROM Customers WHERE Phone = '999999999'
SELECT * FROM Customers WHERE VerifiedEmail = true
SELECT * FROM Customers WHERE UpdatedAt = '2017-10-25'
Insert
The Email field is required to insert.
INSERT INTO Customers (Email, Phone) VALUES ('[email protected]', '+15142546011')
INSERT INTO Customers (Email, Phone, SendEmailInvite) VALUES ('[email protected]', '+15142546011', true)
Update
You must specify the Id of the customer to update a customer.
UPDATE Customers SET Note = 'Customer is a great guy' WHERE Id = '123'
UPDATE Customers SET Tags = 'New Customer, Repeat Customer' WHERE Id = '123'
Delete
You must specify the Id of the customer to delete a customer.
DELETE FROM Customers WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the customer. | |
| LastOrderId | Long | True |
Orders.Id |
The id of the customer's last order. |
| LastOrderName | String | True |
The name of the customer's last order. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| String | False |
The unique email address of the customer. | ||
| Phone | String | False |
The unique phone number for this customer. | |
| TaxExempt | Bool | False |
Indicates whether the customer should be charged taxes when placing orders. | |
| TotalSpent | Decimal | True |
The total amount of money that the customer has spent at the shop. | |
| OrdersCount | Int | True |
The number of orders associated with this customer. | |
| MultipassIdentifier | String | True |
The customer's identifier used with Multipass login. | |
| Note | String | False |
A note about the customer. | |
| EmailMarketingState | String | False |
The current email marketing state for the customer. | |
| EmailMarketingLevel | String | False |
The marketing subscription opt-in level. | |
| EmailMarketingUpdatedAt | Datetime | False |
The date and time when the customer consented to receive marketing material by email. | |
| State | String | True |
The state of the customer's account in a shop. | |
| Tags | String | False |
The tags for this customer. Separate with comma for multiple tags. | |
| VerifiedEmail | Bool | True |
States whether or not the email address has been verified. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| UpdatedAt | Datetime | True |
The date and time when the customer information was updated. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Password | String |
Password of the customer. |
| PasswordConfirmation | String |
Password confirmation of the customer. |
| SendEmailWelcome | Bool |
Whether to send a welcome email to the customer or not. |
| SendEmailInvite | Bool |
Whether to send an invite email to the customer or not. |
DiscountCodes
Create, select, update, and delete information regarding discount codes.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the PriceRuleId and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123'
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Insert
You must specify the PriceRuleId and Code to create a discount code.
INSERT INTO DiscountCodes (PriceRuleId, Code) VALUES ('290807676951', 'SUMMERSALE100OFF')
Update
You must specify the PriceRuleId and Id to update a discount code. For example:
UPDATE DiscountCodes SET Code = 'WINTERSALE500OFF' WHERE PriceRuleId = '123' AND Id = '456'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the discount code. | |
| PriceRuleId [KEY] | Long | False |
PriceRules.Id |
The Id for the price rule that this discount code belongs to. |
| Code | String | False |
The case-insensitive discount code that customers use at checkout. | |
| UsageCount | Int | True |
The number of times that the discount code has been redeemed. | |
| CreatedAt | Datetime | True |
The date and time when the discount code was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount code was last modified. |
DraftOrders
Create, update, delete, and query draft orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status, and UpdatedAt columns. The supported SQL operators are "=" and "IN" for Id, "=" for Status, and ">" and "<" for UpdatedAt. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DraftOrders WHERE Id = '123'
SELECT * FROM DraftOrders WHERE Id IN ('123', '456')
SELECT * FROM DraftOrders WHERE Status = 'completed'
SELECT * FROM DraftOrders WHERE UpdatedAt > '2018-02-05'
Insert
-
Create a simple draft order with only a product variant Id using aggregates.
INSERT INTO DraftOrders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple draft order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO DraftOrders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a custom draft order using aggregates.
INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('[{\"title\":\"Custom Tee\",\"price\":20.15,\"quantity\":5}]', '709015339031', true) -
Create a custom draft order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemQuantity) VALUES ('Custom Tee', 20.15, 5) INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('OrdersItems#TEMP', '709015339031', true)
Update
-
Add a Note to a draft order:
UPDATE DraftOrders SET Note = 'Customer contacted us about a custom engraving on this iPod' WHERE Id = '123'
-
Set a discount on a draft order:
UPDATE DraftOrders SET AppliedDiscountDescription = 'Custom discount', AppliedDiscountValueType = 'percentage', AppliedDiscountValue = 10.0, AppliedDiscountAmount = 19.90, AppliedDiscountTitle = 'Custom' WHERE Id = '123'
Delete
You must specify the Id of the draft order to delete it.
DELETE FROM DraftOrders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| Tags | String | False |
Additional short descriptors. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| Status | String | True |
The status of the order. Valid values are: open (all open orders), invoice_sent (only closed orders), and completed (cancelled orders). Defaults to 'open'. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the draft order. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| CompletedAt | Datetime | True |
The date and time when the order was completed at. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| UseCustomerDefaultAddress | Bool |
Optional boolean that you can send as part of a draft order object to load customer shipping information. Valid values: true or false. |
FulfillmentEvents
Create, delete, and query information regarding fulfillment events.
Table-Specific Information
Select
The OrderId and FulfillmentId are required to query this table. The Sync App uses the Shopify API to process search criteria that refer to the OrderId, FulfillmentId, and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456'
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456' AND Id = '789'
Insert
You must specify the OrderId, FulfillmentId, and Status to create a fulfillment event.
INSERT INTO FulfillmentEvents (Orderid, FulfillmentId, Status, Message, EstimatedDeliveryAt) VALUES ('202520330263', '206541914135', 'in_transit', 'test', '2018-08-02 10:15:25 PM')
Delete
You must specify the OrderId, FulfillmentId, and Id of the fulfillment event to delete it.
DELETE FROM FulfillmentEvents WHERE Orderid = '202520330263' AND FulfillmentId = '206541914135' AND Id = '2374424264727'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A numeric unique identifier for the fulfillment event. | |
| OrderId [KEY] | Long | False |
Orders.Id |
The id of the order the fulfillment event belongs to. |
| FulfillmentId [KEY] | Long | False |
Fulfillments.Id |
A numeric unique identifier for the fulfillment to which the fulfillment event belongs. |
| ShopId | Long | True |
Shop.Id |
A numeric unique identifier for the shop to which the fulfillment event belongs. |
| Status | String | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| EstimatedDeliveryAt | Datetime | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| Message | String | False |
An arbitrary message describing the status. Can be provided by a shipping carrier. | |
| City | String | False |
The city in which the fulfillment event occurred. | |
| Province | String | False |
The province in which the fulfillment event occurred. | |
| Zip | String | False |
The zip code in the location in which the fulfillment event occurred. | |
| Country | String | False |
The country in which the fulfillment event occurred. | |
| Address1 | String | False |
The fulfillment event's street address. | |
| Latitude | Double | False |
Geographic coordinate specifying the north/south location of a fulfillment event. | |
| Longitude | Double | False |
Geographic coordinate specifying the east/west location of a fulfillment event. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment event was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment event was updated. | |
| HappenedAt | Datetime | True |
The date and time when the fulfillment event occurred. |
Fulfillments
Create, update, and query fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, OrderId, CreatedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
-
If you specify the unique identifier of the order, then this view will only list fulfillment information concerning that order. You can also retrieve a specific fulfillment by specifying OrderId and Id. To retrieve fulfillments associated with a fulfillment order you need to specify the FulfillmentOrderId.
SELECT * FROM Fulfillments WHERE OrderId = '123' SELECT * FROM Fulfillments WHERE OrderId = '123' AND Id = '567' SELECT * FROM Fulfillments WHERE FulfillmentOrderId = '123'
-
This view supports filtering by the CreatedAt and UpdatedAt columns on the server-side.
SELECT * FROM Fulfillments WHERE CreatedAt > '2017-10-25'
Insert
You must specify the FulfillmentOrderId column to insert a fulfillment.
-
Fulfill one line item using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"}]') -
Fulfill one line item using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
Insert INTO OrdersItems#TEMP (ItemId) VALUES ('123')Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LinesAggregate) VALUES ('123', 'OrdersItems#TEMP')In cases that two ore more shop locations are specified in your Shopify account the LocationId needs to be added. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LocationId, LinesAggregate) VALUES ('123', '456', 'OrdersItems#TEMP') -
Fulfill many line items using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"},{\"id\":\"456\"},{\"id\":\"789\"}]') -
Fulfill many line items using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('123') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('456') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('789') INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', 'OrdersItems#TEMP') -
Fulfill all line items, notify the customer, and set a tracking number.
INSERT INTO Fulfillments (FulfillmentOrderId, TrackingNumbers, NotifyCustomer) VALUES ('123', 'FEDEX1', true) -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":5}]') -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 5) INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('456', 'OrdersItems#TEMP') -
Complete a fulfillment (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Complete') -
Transition a fulfillment from pending to open (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Open') -
Cancel a fulfillment (you must specify Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Cancel')
Update
You must specify the OrderId and Id of the fulfillment to fulfill an order.
UPDATE Fulfillments SET TrackingNumbers = 'FedEx123,UPS123' WHERE OrderId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| LocationId [KEY] | Long | False |
A unique numeric identifier for the Location. | |
| NotifyCustomer | Bool | False |
A flag indicating whether the customer should be notified | |
| Status | String | False |
The status of the fulfillment. | |
| Receipt | String | True |
Provides information about the receipt of this fulfillment. | |
| TrackingCompany | String | False |
The name of the tracking company. | |
| TrackingNumbers | String | False |
A list of comma-separated tracking numbers, provided by the shipping company. | |
| TrackingUrls | String | False |
The sum of all the prices of all the items in the fulfillment. | |
| VariantInventoryManagement | String | True |
States the name of the inventory management service. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the fulfillment. | |
| OrderUpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| OrderCreatedAt | Datetime | True |
The date and time when the order was last created. | |
| FulfillmentOrderId | Long | False |
The ID of the fulfillment order that is associated with the fulfillments. |
FulfillmentServices
Query, create, update, and delete information regarding different fulfillment services.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM FulfillmentServices WHERE Id = '123'
Insert
You must specify the Name, CallbackUrl, and Format to create a fulfillment service.
INSERT INTO FulfillmentServices (Name, CallbackUrl, Format) VALUES ('testing fulfillment services', 'http://google.com', 'json')
Update
You must specify the Id to update a fulfillment service. For example:
UPDATE FulfillmentServices SET Name = 'test32', IncludePendingStock = true WHERE Id = '123'
Delete
You must specify the Id of the fulfillment service to delete it.
DELETE FROM FulfillmentServices WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment service. | |
| LocationId | Long | True |
Locations.Id |
The unique identifier of the location tied to the fulfillment service. |
| ProviderId | String | True |
A unique identifier for the fulfillment service provider. | |
| Name | String | False |
The name of the fulfillment service as seen by merchants and their customers. | |
| Handle | String | True |
A human-friendly unique string for the fulfillment service generated from its title. | |
| ServiceName | String | True |
The name of the fulfillment service. | |
| String | False |
The email of the fulfillment service. | ||
| IncludePendingStock | Bool | False |
States if the fulfillment service includes a pending stock. | |
| RequiresShippingMethod | Bool | False |
States if the fulfillment service requires products to be physically shipped. Valid values are 'true' and 'false'. | |
| TrackingSupport | Bool | False |
States if the fulfillment service provides tracking numbers for packages. Valid values are | |
| InventoryManagement | Bool | False |
States if the fulfillment service tracks product inventory and provides updates to Shopify. Valid values are | |
| FulfillmentOrdersOptIn | Bool | False |
States if the fulfillment orders is opt in. | |
| CallbackUrl | String | False |
States the URL endpoint that Shopify needs to retrieve inventory and tracking updates. This field is necessary if either inventory_management or tracking_support is set to | |
| Format | String | False |
Specifies the format of the API output. Valid values are json and xml. |
GiftCards
Create, update, delete, and query gift cards.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the gift card. | |
| APIClientId | Long | True |
The ID of the client that issued the gift card. | |
| Balance | Decimal | True |
The balance of the gift card. | |
| Code | String | False |
The gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters) | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was created. | |
| Currency | String | True |
The currency of the gift card. | |
| CustomerId | Long | True |
Customers.Id |
The ID of the customer associated with this gift card. |
| DisabledAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was disabled. | |
| ExpiresOn | Date | False |
The date (YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date. | |
| InitialValue | Decimal | False |
The initial value of the gift card when it was created. | |
| LastCharacters | String | True |
The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved. | |
| LineItemId | Long | True |
OrdersItems.ItemId |
The ID of the line item that initiated the creation of this gift card, if it was created by an order. |
| Note | String | False |
An optional note that a merchant can attach to the gift card that isn't visible to customers. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that initiated the creation of this gift card, if it was created by an order. |
| TemplateSuffix | String | False |
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. | |
| UserId | Long | True |
Users.Id |
The ID of the user that issued the gift card, if it was issued by a user. |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was last modified. |
InventoryItems
Query and update information regarding different inventory items.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM InventoryItems WHERE Id = '123'
SELECT * FROM InventoryItems WHERE Id IN ('123', '456')
Update
You must specify the Id to update an inventory item. For example:
UPDATE InventoryItems SET Sku = 'lamo', Tracked = false WHERE Id = '123'
UPDATE InventoryItemsSET Cost = 45.95, CountryCodeOfOrigin = 'AU', CountryHarmonizedSystemCodes ='[{"harmonized_system_code":"701912","country_code":"CA"},{"harmonized_system_code":"701912","country_code":"US"}]', HarmonizedSystemCode = '701912', ProvinceCodeOfOrigin = 'NC', SKU = 'Test1', Tracked = FALSE WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| Cost | Decimal | False |
The unit cost of the inventory item. | |
| CountryCodeOfOrigin | String | False |
The two-digit code for the country where the inventory item was made. | |
| CountryHarmonizedSystemCodes | String | False |
An array of country-specific Harmonized System (HS) codes for the item. | |
| HarmonizedSystemCode | String | False |
The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code is not available. | |
| ProvinceCodeOfOrigin | String | False |
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. | |
| SKU | String | False |
The unique SKU (stock keeping unit) of the inventory item. | |
| Tracked | Bool | False |
Whether the inventory item is tracked. If true, then inventory quantity changes are tracked by Shopify. | |
| RequiresShipping | Bool | True |
Whether a customer needs to provide a shipping address when placing an order containing the inventory item. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was last updated. |
InventoryLevels
Query, create, and update information regarding different inventory levels.
Table-Specific Information
Select
To query this table InventoryItemId, LocationId or both should be specified. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123'
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123' AND LocationId = '456'
SELECT * FROM InventoryLevels WHERE InventoryItemId IN ('123', '456') AND LocationId IN ('123', '456')
Insert
-
Adjust the available quantity of an inventory item at a single location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation) VALUES (534169354263, 1448280087, 5, 'Adjust')
-
Connects an inventory item to a location by creating an inventory level at that location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Operation) VALUES (534169354263, 4484497431, 'Connect')
-
Sets the inventory level for an inventory item at a location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation, DisconnectIfNecessary) VALUES (534169354263, 4484497431, 42, 'Set', true)
Delete
You must specify the InventoryItemId and LocationId to delete an inventory level of an inventory item at a location.
DELETE FROM InventoryLevels WHERE InventoryItemId = '153681943' AND LocationId = '45678'
Columns
| Name | Type | ReadOnly | References | Description |
| InventoryItemId [KEY] | Long | False |
The ID of the inventory item that the inventory level belongs to. | |
| LocationId [KEY] | Long | False |
Locations.Id |
The ID of the location that the inventory level belongs to. To find the ID of the location, use the Locations view. |
| Available | Int | False |
The quantity of inventory items available for sale. Returns null if the inventory item is not tracked. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the inventory level was last modified. | |
| Operation | String | False |
An operation to apply to the InventoryLevel. Valid values for order: adjust, connect, set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| RelocateIfNecessary | Bool |
Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. Used in insertions. |
| DisconnectIfNecessary | Bool |
Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. Used in insertions. |
MarketingEvents
Create, update, delete, and query marketing events.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM MarketingEvents
SELECT * FROM MarketingEvents WHERE Id = '123'
Insert
You must specify the MarketingChannel, EventType, Paid, ReferringDomain, and StartedAt columns to create a marketing event. For example:
INSERT INTO MarketingEvents (MarketingChannel, EventType, Paid, ReferringDomain, StartedAt) VALUES ('social', 'ad', true, 'facebook.com', '2018-12-15')
Update
You must specify the Id to update a marketing event. You can modify only timestamps, RemoteId, and budget/currency. For example:
UPDATE MarketingEvents SET RemoteId = '1000:2000', StartedAt = '2018-02-02T00:00 +00:00', EndedAt = '2018-02-03T00:00 +00:00', ScheduledToEndAt = '2018-02-04T00:00 +00:00', Budget = 11.1, BudgetType = 'daily', Currency = 'USD' WHERE Id = '123'
Delete
You must specify the Id of the marketing event to delete it.
DELETE FROM MarketingEvents WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the marketing event. | |
| RemoteId | String | False |
An optional remote identifier for a marketing event. | |
| BreadcrumbId | String | True |
An optional identifier for the breadcrumb of a marketing event. | |
| UTMCampaign | String | True |
A unique name for the UTM campaign. | |
| UTMSource | String | True |
The source of the UTM campaign. | |
| UTMMedium | String | True |
The medium of the UTM campaign. | |
| UTMContent | String | True |
The content of the UTM campaign. | |
| UTMTerm | String | True |
The term of the UTM campaign. | |
| EventTarget | String | True |
The target of the event. | |
| Description | String | True |
A description for the marketing event. | |
| MarketingChannel | String | False |
A broader marketing event type that is focused only on the channel. Must be one of the allowed values (`search`, `display`, `social`, `email`, `referral`). | |
| EventType | String | False |
The specific type of marketing event. Must be one of the allowed values (`ad`, `post`, `message`, `retargeting`, `transactional`, `affiliate`, `loyalty`, `newsletter`, `abandoned_cart`, `receipt`). | |
| Budget | Decimal | False |
The budget of the ad campaign. | |
| Paid | Bool | False |
A boolean field to specify whether this event is paid or organic. | |
| BudgetType | String | False |
The type of the budget; must be either `daily` or `lifetime`. | |
| Currency | String | False |
The currency for the budget. | |
| ManageUrl | String | True |
A link to manage the marketing event, generally in the Shopify app's interface. | |
| PreviewUrl | String | True |
A link to view the live version of the post/ad, or to view a rendered preview of the post/ad/email in the Shopify app. | |
| ReferringDomain | String | False |
The destination domain of the marketing event. Required unless MarketingChannel is one of email/referral/display. | |
| MarketedResources | String | True |
A list of the items that were marketed in the marketing event. It's a list of dictionaries with type keys and id keys. Valid values for type are: (`product`, `collection`, `price_rule`, `page`, `article`, `homepage`). All types, other than homepage, also require an id. | |
| StartedAt | Datetime | False |
The timestamp when the marketing action was started, or when the email was sent, or when the Facebook post was made live, etc. | |
| EndedAt | Datetime | False |
For events with a duration, when the event actually ended. This may differ from ScheduledToEndAt, if the ad was stopped early, etc. | |
| ScheduledToEndAt | Datetime | False |
For events with a duration, when the event was supposed to end. |
Metafields
Retrieves a list of metafields that belong to a resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria for all columns except Value and Description. The supported SQL operators are '=,IN' for the Id, OwnerResource and OwnerId columns, '=' for the Namespace, Key, Type columns and '=,<=,<,>,>=' for the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE Id = 721389482
SELECT * FROM Metafields WHERE ID IN (SELECT Id FROM Customers)
SELECT * FROM Metafields WHERE ID IN (19422939054103, 19422939185175, 19422939250711, 19431415152663, 19431415185431)
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource IN ('product', 'customer')
SELECT * FROM Metafields WHERE OwnerId IN (64146833430, 64146833431) AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'customer' AND OwnerId IN (SELECT Id FROM Customers);
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND UpdatedAt >= '2021-10-13T05:55:08-04:00';
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND Type = 'multi_line_text_field';
Insert
You must specify the NameSpace, Key, and Value to create Metafields.
INSERT INTO Metafields (NameSpace, Key, Value, Type, Description, OwnerResource) VALUES ('inventory', 'warehouse', 25, 'number_integer', 'This is description about data', 'factory')
Update
You must specify the Id to update Metafields. For example:
UPDATE Metafields SET Value = 26 WHERE Id = 19712314851607
Delete
You must specify the Id of the Metafields to delete it.
DELETE FROM Metafields WHERE Id = 19712314851607
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique ID of the metafield. | |
| Namespace | String | False |
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. | |
| Key | String | False |
The name of the metafield. | |
| Value | String | False |
The information to be stored as metadata. | |
| Type | String | False |
The metafield's information type. | |
| Description | String | False |
A description of the information that the metafield contains. | |
| OwnerId | Long | False |
The unique ID of the resource that the metafield is attached to. | |
| OwnerResource | String | False |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was last updated. | |
| AdminGraphqlApiId | String | True |
The admin graphql api id |
OrderRisks
Create, update, delete, and query order risks.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order risk. | |
| CauseCancel | Bool | False |
Whether this order risk is severe enough to force the cancellation of the order. | |
| CheckoutId | Long | True |
The ID of the checkout that the order risk belongs to. | |
| Display | Bool | False |
Whether the order risk is displayed on the order details page in the Shopify admin. | |
| Message | String | False |
The message that's displayed to the merchant to indicate the results of the fraud check. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that the order risk belongs to. |
| Recommendation | String | False |
The recommended action given to the merchant. | |
| Score | Decimal | False |
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 | String | False |
The source of the order risk. |
Orders
Create, update, delete, and query orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, FinancialStatus, FulfillmentStatus, CreatedAt, ProcessedAt and UpdatedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for FinancialStatus, and FulfillmentStatus, and '>' and '<' for the CreatedAt, ProcessedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = '123'
SELECT * FROM Orders WHERE FinancialStatus = 'pending'
SELECT * FROM Orders WHERE CreatedAt > '2017-10-25'
Insert
-
Create a simple order with only a product variant Id using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2}]') -
Create a simple order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using aggregates.
INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, '[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, 'OrdersItems#TEMP') -
Create a simple order, with taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"}]') -
Create a simple order, with taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a simple order, with multiple taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"},{\"price\":4.25,\"rate\":0.025,\"title\":\"County Tax\"}]') -
Create a simple order, with multiple taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (4.25, 0.025, 'County Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a more comprehensive order using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ([{\"title\":\"Big Brown Bear Boots\",\"price\":74.99,\"grams\":1300,\"quantity\":3}]) -
Create a more comprehensive order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemGrams, ItemQuantity) VALUES ('Big Brown Bear Boots', 74.99, 1300, 3) INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a pending order with an existing customer using aggregates.
INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', '456', 'pending') -
Create a pending order with an existing customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('OrdersItems#TEMP', '456', 'pending') -
Create a partially paid order with a new customer and addresses using aggregates.
INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Create a partially paid order with a new customer and addresses using temporary.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('OrdersItems#TEMP', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Close an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Close') -
Reopen an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Open') -
Cancel an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Cancel')
Update
Only columns BuyerAcceptsMarketing, Email, Phone, Note, Tags, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressPhone, ShippingAddressCity, ShippingAddressCompany, ShippingAddressZip, ShippingAddressProvince, ShippingAddressCountry, ShippingAddressLatitude, ShippingAddressLongitude, ShippingAddressName, ShippingAddressCountryCode, ShippingAddressProvinceCode and ShippingAddressDefault can be updated.
-
Update the shipping address of an existing order.
UPDATE Orders SET ShippingAddressAddress1 = '123 Ship Street', ShippingAddressCity = 'Shipsville' WHERE Id = '123'
-
Update an order's tags.
UPDATE Orders SET Tags = 'External, Inbound, Outbound' WHERE Id = '123'
Delete
You must specify the Id of the order when deleting an item from this table.
DELETE FROM Orders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| Number | Long | True |
A unique identifier for the order, used by the shop owner and customer. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerFirstName | String | False |
The first name of the customer. | |
| CustomerLastName | String | False |
The last name of the customer. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalDiscounts | Decimal | True |
The total amount of the discounts to be applied to the price of the order. | |
| TotalOrderItemsPrice | Decimal | True |
The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TotalWeight | Int | True |
The sum of all the weights of the line items in the order, in grams. | |
| BrowserIp | String | True |
The IP address of the browser used by the customer when placing the order. | |
| BuyerAcceptsMarketing | Bool | False |
Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | True |
The reason why the order was canceled. | |
| CartToken | String | True |
Unique identifier for a particular cart that is attached to a particular order. | |
| OrderStatusUrl | String | True |
The URL pointing to the order status web page. | |
| Token | String | True |
Unique identifier for a particular order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| SourceName | String | True |
Where the order originated. | |
| ReferringSite | String | True |
The website that the customer clicked on to come to the shop. | |
| Phone | String | False |
The customer's phone number. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| LocationId | Long | True |
The unique numeric identifier for the physical location at which the order was processed. | |
| LandingSite | String | True |
The URL for the page where the buyer landed when entering the shop. | |
| Tags | String | False |
Additional short descriptors. | |
| FulfillmentStatus | String | False |
The fulfillment status of the order. Valid values during SELECT: shipped, partial, unshipped, any, unfulfilled. Valid values during INSERT: fulfilled, null, partial, restocked. | |
| FinancialStatus | String | False |
The financial status of the order. Valid values during SELECT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid. Valid values during INSERT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded. | |
| CustomerLocale | String | True |
The customer locale of the order. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| DiscountCodes | String | True |
Applicable discount codes that can be applied to the order. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the order. | |
| TaxAggregate | String | False |
A JSON aggregate of tax line items associated with the order. Note, these taxes are applied on the order, not on individual items. If you want them to be applied on individual items, use them in LineAggregate. Tax lines must be associated with either order or line item but not both. | |
| ShippingAggregate | String | False |
A JSON aggregate of shipping line items associated with the order. | |
| NoteAttributesAggregate | String | False |
A JSON aggregate of note attributes associated with the order. | |
| DiscountApplicationsAggregate | String | True |
An ordered list of stacked discount applications. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| PaymentTermsAmount | Long | True |
The amount that is owed according to the payment terms. | |
| PaymentTermsCurrency | String | True |
The presentment currency for the payment. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the selected payment terms template for the order. | |
| PaymentTermsPaymentTermsType | String | True |
The type of selected payment terms template for the order. | |
| PaymentTermsDueInDays | Int | True |
The number of days between the invoice date and due date that is defined in the selected payment terms template. | |
| PaymentTermsPaymentSchedules | String | True |
An array of schedules associated to the payment terms. | |
| ProcessedAt | Datetime | True |
The date and time when the order was imported, in ISO 8601 format. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| SendReceipt | Bool | False |
Determines whether an order confirmation will be sent to the customer. | |
| SendFulfillmentReceipt | Bool | False |
Determines whether a fulfillment confirmation will be sent to the customer. | |
| InventoryBehaviour | String | False |
Determines which inventory updating behavior is used. The following values are available: default, decrement_ignoring_policy, decrementobeying_policy | |
| Operation | String | False |
An operation to apply to the Order. Valid values for order: Close, Open, or Cancel. | |
| TotalShippingPriceSetShopMoneyAmount | Double | True |
The amount of the shop money in the total shipping price set. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
The currency code of the shop money in the total shipping price set. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total shipping price set. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total price set. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total price set. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total tax set. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total tax set. | |
| CheckoutId | Long | True |
The checkout id. | |
| CheckoutToken | String | True |
A unique value when referencing the checkout that's associated with the order. | |
| EstimatedTaxes | Bool | True |
Estimated taxes of the order. | |
| Test | Bool | True |
Test boolean for the order. | |
| TotalOutstanding | Decimal | True |
The outstanding sum of all the items in the order. | |
| TotalTipReceived | Decimal | True |
The total tip for the order. | |
| PresentmentCurrency | String | True |
The currency code of the presentment money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total line items price set. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total line items price set. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the discounts set. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the discounts set. | |
| TotalSubtotalSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the subtotal. | |
| TotalSubtotalSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the subtotal. | |
| OrigTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total additional fees set. | |
| OrigTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total additional fees set. | |
| CurTotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total discounts set. | |
| CurTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total discounts set. | |
| CurSubtotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current subtotal price set. | |
| CurSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current subtotal price set. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total tax set. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total tax set. | |
| CurTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total additional fees set. | |
| CurTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total additional fees set. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total price set. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total price set. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total duties set. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total duties set. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total duties set. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total duties set. | |
| PaymentGatewayNames | String | True |
The list of payment gateway names | |
| FulfillmentAggregate | String | True |
A JSON aggregate of fulfillments associated with the order. Note, these fulfillments are applied on the order, not on individual items. | |
| RefundAggregate | String | True |
A JSON aggregate of refunds associated with the order. Note, these refunds are applied on the order, not on individual items. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Status | String |
Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
OrderTransactions
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM OrderTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of transactions and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving transactions. Therefore to retrieve all the transactions, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the transactions for each OrderId to build the result set.
SELECT * FROM OrderTransactions WHERE Kind = 'Capture'
Insert
You must specify the OrderId and Kind when inserting a transaction.
-
Capture a specified amount on a previously authorized order.
INSERT INTO OrderTransactions (OrderId, Amount, Kind) VALUES ('123', 10.25, 'Capture') -
Capture a previously authorized order for the full amount.
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'Capture') - Create an Authorization transaction :
INSERT INTO OrderTransactions (OrderId, Kind, Authorization) VALUES ('123', 'authorization', '7') - Create a Capture transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'capture') - Create a Sale transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'sale') - Create a Void transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Currency, Amount) VALUES ('123', 'void', '456', 'USD', '0.1') - Create a Refund transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Amount) VALUES ('123', 'refund', '456', '1440.00')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the transaction. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| UserId | Long | True |
The unique identifier for the user. | |
| LocationId | Long | True |
The ID of the physical location where the transaction was processed. | |
| Amount | Decimal | False |
The amount of money that the transaction was for. | |
| Authorization | String | False |
The authorization code associated with the transaction. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| DeviceId | String | True |
The unique identifier for the device. | |
| Gateway | String | False |
The name of the gateway the transaction was issued through. | |
| SourceName | String | True |
The origin of the transaction. | |
| Kind | String | False |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. | |
| Message | String | True |
The message associated with this transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| Status | String | False |
The status of the transaction. | |
| Test | Bool | True |
The option to use the transaction for testing purposes. | |
| AVSResultCode | String | True |
The Response code from the address verification system. | |
| CreditCardBin | String | True |
The issuer identification number (IIN). | |
| CVVResultCode | String | True |
The Response code from the credit card company. | |
| CreditCardNumber | String | True |
The customer's credit card number, with most of the leading digits redacted with Xs. | |
| CreditCardCompany | String | True |
The name of the company who issued the customer's credit card. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| PaymentsRefundsAttributesStatus | String | True |
The current status of the refund | |
| PaymentsRefundsAttributesAcquirerReferenceNumber | String | True |
A unique number associated with the transaction that can be used to track the refund. | |
| PaymentId | String | True |
The unique identifier for the payment. | |
| ProcessedAt | Datetime | True |
The date and time when the transaction was processed. | |
| CreditCardName | String | True |
The name on the customer's credit card. | |
| CreditCardWallet | String | True |
The wallet of the customer's credit card. | |
| CreditCardExpMonth | Long | True |
The expiration month of the customer's credit card. | |
| CreditCardExpYear | Long | True |
The expiration year of the customer's credit card. | |
| Receipt | String | True |
A JSON aggregate of the order receipt. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total unsettled set. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total unsettled set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| TransactionItemAmount | Decimal |
The amount of money that the transaction was for. Use this when inserting transactions into an order or refund. |
| TransactionItemGateway | String |
The name of the gateway the transaction was issued through. Use this when inserting transactions into an order or refund. |
| TransActionItemKind | String |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. Use this when inserting transactions into an order or refund. |
| TransactionItemStatus | String |
The status of the transaction. Use this when inserting transactions into an order or refund. |
| TransactionItemParentId | String |
The parent id of the transaction. Use this when inserting transactions into a refund. |
| TransactionItemSource | String |
The status of the transaction. |
| UpdatedAt | Datetime |
The last time the order is updated. |
Pages
Create, read, update or delete pages
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, CreatedAt, Handle, PublishedAt, Title, UpdatedAt, PublishedStatus columns. The following queries are the only ones processed server-side:SELECT * FROM Pages
SELECT * FROM Pages WHERE Id = '123'
SELECT * FROM Pages WHERE CreatedAt > '2018-05-02'
SELECT * FROM Pages WHERE Handle = 'test'
SELECT * FROM Pages WHERE PublishedAt <= '2018-05-02'
SELECT * FROM Pages WHERE Title = 'new title'
SELECT * FROM Pages WHERE UpdatedAt >= '2018-05-02'
SELECT * FROM Pages WHERE PublishedStatus >= 'published'
Insert
You must specify the Title to create a Page.
INSERT INTO Pages (title) VALUES ('new Page')
Update
You must specify the id to update a Page. For example:
UPDATE Pages SET author = 'Harry' WHERE Id = '77171130'
Delete
You must specify the Id of the Page to delete it.
DELETE FROM Pages WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique numeric identifier for the page. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the person who created the page. | |
| BodyHtml | String | False |
The text content of the page, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was created. | |
| Handle | String | False |
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. | |
| Metafields | String | False |
Additional information attached to the Page object. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden. | |
| ShopId | Long | True |
The ID of the shop to which the page belongs. | |
| TemplateSuffix | String | False |
The suffix of the Liquid template being used. | |
| Title | String | False |
The page's title. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was last updated. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
PriceRules
Create, update, delete, and query price rules.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM PriceRules WHERE Id = '123'
Insert
You must specify the Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, and AllocationMethod columns to create a price rule. For example:
INSERT INTO PriceRules (Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, AllocationMethod) VALUES ('SUMMERSALE10OFF', 'line_item', 'all', 'fixed_amount', '-10.0', 'all', '2017-01-19T17:59:10Z', 'across')
Update
You must specify the Id to update a price rule. For example:
UPDATE PriceRules SET Title = 'SUMMERSALE10OFF' WHERE Id = '123'
Delete
You must specify the Id of the price rule to delete it.
DELETE FROM PriceRules WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the price rule. | |
| AllocationMethod | String | False |
The allocation method of the price rule. Valid values: each: The discount is applied to each of the entitled items. across: The calculated discount amount will be applied across the entitled items. | |
| CustomerSelection | String | False |
The customer selection for the price rule. Valid values: all: The price rule is valid for all customers. prerequisite: The customer must either belong to one of the customer saved searches specified by PrerequisiteSavedSearchIds. | |
| EntitledCollectionIds | String | False |
A list of Ids of collections whose products will be eligible to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. It can't be used in combination with EntitledProductIds or EntitledVariantIds. | |
| EntitledCountryIds | String | False |
A list of Ids of shipping countries that will be entitled to the discount. It can be used only with TargetType set to shipping_line and TargetSelection set to entitled. | |
| EntitledProductIds | String | False |
A list of Ids of products that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| EntitledVariantIds | String | False |
A list of Ids of product variants that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| OncePerCustomer | Bool | False |
Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer Id. | |
| PrerequisiteCustomerIds | String | False |
A list of customer Ids which for the price rule to be applicable, the customer must match one of the specified customers. If PrerequisiteCustomerIds is populated, then PrerequisiteSavedSearchIds must be empty. | |
| PrerequisiteQuantityRange | String | False |
The minimum number of items for the price rule to be applicable. It has the following property: greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value. | |
| PrerequisiteSavedSearchIds | String | False |
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 PrerequisiteSavedSearchIds is populated, then PrerequisiteCustomerIds must be empty. | |
| PrerequisiteShippingPriceRange | String | False |
The maximum shipping price for the price rule to be applicable. It has the following property: less_than_or_equal_to: The shipping price must be less than or equal to this value. | |
| PrerequisiteSubtotalRange | String | False |
The minimum subtotal for the price rule to be applicable. It has the following property: 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. | |
| TargetSelection | String | False |
The target selection method of the price rule. Valid values: all: The price rule applies the discount to all line items in the checkout, entitled: The price rule applies the discount to selected entitlements only. | |
| TargetType | String | False |
The target type that the price rule applies to. Valid values: line_item: The price rule applies to the cart's line items, shipping_line: The price rule applies to the cart's shipping lines. | |
| UsageLimit | Int | False |
The maximum number of times the price rule can be used, per discount code. | |
| PrerequisiteProductIds | String | False |
List of product ids that will be a prerequisites for a Buy X Get Y type discount. The PrerequisiteProductIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product variant is included in PrerequisiteVariantIds, then PrerequisiteProductIds can't include the ID of the product associated with that variant. | |
| PrerequisiteVariantIds | String | False |
List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The EntitledVariantIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product is included in PrerequisiteProductIds, then PrerequisiteVariantIds can't include the ID of any variants associated with that product. | |
| PrerequisiteCollectionIds | String | False |
List of collection ids that will be a prerequisites for a Buy X Get Y discount. The EntitledCollectionIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Cannot be used in combination with PrerequisiteProductIds or PrerequisiteVariantIds. | |
| Value | Decimal | False |
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. | |
| ValueType | String | False |
The value type of the price rule. Valid values: fixed_amount: Applies a discount of value as a unit of the store's currency. For example, if value is -30 and the store's currency is USD, then $30 USD is deducted when the discount is applied, percentage: Applies a percentage discount of value. For example, if value is -30, then 30% will be deducted when the discount is applied. If TargetType is shipping_line, then only percentage is accepted. | |
| PrerequisiteToEntitlementQuantityRatio | String | False |
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 PrerequisiteToEntitlementQuantityRatio can be used only with: ValueType set to percentage, TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each, PrerequisiteProductIds or PrerequisiteVariantIds or PrerequisiteCollectionIds defined and EntitledProductIds or EntitledVariantIds or EntitledCollectionIds defined. | |
| Images | String | False |
A list of image objects. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| StartsAt | Datetime | False |
The date and time when the price rule starts. | |
| EndsAt | Datetime | False |
The date and time when the price rule ends. Must be after StartsAt. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the price rule was created. | |
| UpdatedAt | Datetime | True |
The date and time when the price rule was last modified. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductImages
Query, Update and Delete Product Images
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ImageId. The supported SQL operators are '=' for ProductId and '=' for ImageId. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM ProductImages WHERE ProductId = '123'
SELECT * FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Insert
To create a new product image with image data as attachment
INSERT INTO ProductImages (productid, filename, attachment) VALUES ('64146735127', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
To create a new product image using a source URL that will be downloaded by Shopify
INSERT INTO ProductImages (productid, filepath) VALUES ('64146735127', 'http://example.com/rails_logo.gif')")
To create a new product image and make it the main image
INSERT INTO ProductImages (productid, position, filename, filepath) VALUES ('64146735127', 1, 'test.png', 'http://example.com/rails_logo.gif')")
To create a new product image and attach it to product variants
INSERT INTO ProductImages (productid, variantids, filename, attachment) VALUES ('64146735127', '[808950810,457924702]', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
Update
To update a product image you must specify its ProductId and ImageId.
To change the position and alt tag content for an image
UPDATE ProductImages SET Position = 1, Alt = 'This is the main image' WHERE ProductId = '123' AND ImageId = '2342'
To add it to product variants for an image
UPDATE ProductImages SET VariantIds = '[808950810,457924702]' WHERE ProductId = '123' AND ImageId = '2342'
Delete
To delete a product image you must specify its Id.
DELETE FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Columns
| Name | Type | ReadOnly | References | Description |
| ImageId [KEY] | Long | True |
A unique numeric identifier for the product image. | |
| ProductId | Long | True |
Products.Id |
The id of the product associated with the image. |
| VariantIds | String | False |
The array of variant ids associated with the image. | |
| Position | Int | False |
The order of the product image in the list. | |
| FilePath | String | False |
Full path to the image. Can be locally or online. Example: http://example.com/rails_logo.gif. Either this or Base64Content are required. | |
| Width | Int | True |
The width of the image. | |
| Height | Int | True |
The height of the image. | |
| CreatedAt | Datetime | True |
The datetime when the image was created. | |
| UpdatedAt | Datetime | True |
The datetime when the image was updated. | |
| Alt | String | False |
The Alt content of the image. | |
| Src | String | False |
Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FileName | String |
The name that the image will be displayed in the application. |
| Attachment | String |
Base64 encoded bytes of the image. Either this or FilePath are required. |
ProductListings
Query and delete product listings.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and Handle columns. The supported SQL operators are '=' and 'IN' for ProductId and '=' and 'IN' for Handle column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM ProductListings WHERE ProductId = '123'
SELECT * FROM ProductListings WHERE ProductId IN ('123', '456')
SELECT * FROM ProductListings WHERE Handle = 'ipod-nano'
SELECT * FROM ProductListings WHERE Handle IN ('ipod-nano', 'ipod-nano2')
Delete
Delete a product listing to unpublish a product from your app (ProductId is required):
DELETE FROM ProductListings WHERE Productid = 512433520663
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
The unique identifer of the product this listing is for. The primary key for this resource. | |
| Title | String | False |
The name of the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Variants | String | True |
A list of variant objects, each one representing a slightly different version of the product. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Tags | String | False |
A categorization that a product can be tagged with, commonly used for filtering. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
ProductOptions
Query product options.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ProductUpdatedAt columns. The supported SQL operators are '=' for ProductId and '>' and '<' for ProductUpdatedAt.
Select
SELECT * FROM ProductOptions WHERE ProductId = '123'
SELECT * FROM ProductOptions WHERE ProductUpdatedAt > '2018-05-10'
Update
To update a product option, you must include the ProductId. For example:
UPDATE ProductOptions SET Name='test' where ProductId='123'"
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The id of the product option. | |
| ProductId | Long | True |
Products.Id |
The id of the product. |
| ProductUpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| Name | String | False |
The name of the product option. | |
| Position | Int | True |
The position of the product option. | |
| Values | String | True |
The values of the product option. |
ProductResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ProductResourceFeedbacks
SELECT * FROM ProductResourceFeedbacks WHERE ProductId = '123'
SELECT * FROM ProductResourceFeedbacks WHERE ProductId IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ProductResourceFeedbacks] ([ProductId], [State], [Messages], [ResourceUpdatedAt], [FeedbackGeneratedAt]) VALUES (6578879004695, 'requires_action', 'My message.', '2023-05-05 09:00:00', '2023-05-05 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| ProductId | Long | False |
Products.Id |
Unique id of the resource. |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
Products
List of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the following columns: Id, Title, Vendor, Handle, ProductType, PublishedStatus, CreatedAt, PublishedAt, and UpdatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Products WHERE Id = '123'
SELECT * FROM Products WHERE Id IN ('123', '456')
SELECT * FROM Products WHERE CreatedAt > '2017-10-25'
SELECT * FROM Products WHERE Title = 'just a title'
SELECT * FROM Products WHERE Vendor = 'just a vendor'
Insert
-
Create a new product with the default product variant.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air') -
Create a new unpublished product.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags, Published) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air', false)
Update
To update a product you must specify its Id.
UPDATE Products SET Published = true WHERE Id = '123'
UPDATE Products SET MetafieldsGlobalTitleTag = 'Brand new title', MetafieldsGlobalDescriptionTag = 'Brand new description' WHERE Id = '123'
Delete
To delete a product you must specify its Id.
DELETE FROM Products WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Variants | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| Status | String | False |
The status of the product. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| PublishedStatus | String | True |
Return products by their published status: published: show only published products;unpublished: show only unpublished products; any: show all products. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it. |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductVariants
List of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and ProductId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM ProductVariants WHERE Id = '123'
SELECT * FROM ProductVariants WHERE Id IN ('123', '456')
SELECT * FROM ProductVariants WHERE ProductId = '456'
Insert
You must specify the ProductId to insert a product variant.
INSERT INTO ProductVariants (ProductId, Option1, Price) VALUES ('123', 'Yellow', 3.5)
Update
You must specify the Id of the variant to edit a product variant.
-
Update the title and price of an existing variant.
UPDATE ProductVariants SET Option1 = 'Pink', Price = 99.99 WHERE Id = '123'
Delete
You must specify the ProductId and the Id of the variant to delete a product variant.
DELETE FROM ProductVariants WHERE Id = '123' AND ProductId = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product variant. | |
| ProductId | Long | False |
A unique numeric identifier for the product this variant belongs to. | |
| InventoryItemId | Long | False |
The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information. | |
| ImageId | Long | False |
A unique numeric identifier for the image this variant belongs to. | |
| Price | Decimal | False |
The price of the product variant. | |
| CompareAtPrice | String | False |
The competitors prices for the same item. | |
| Title | String | False |
The name of the product. | |
| Grams | Int | False |
The weight of the product variant in grams. | |
| Barcode | String | False |
A human-friendly unique string for the Product automatically generated from its title. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified. | |
| WeightUnit | String | True |
The unit of measurement that applies to the product's variant weight. | |
| FulfillmentService | String | False |
Service which is doing the fulfillment. | |
| InventoryManagement | String | False |
Specifies whether or not Shopify tracks the number of items in stock for this product variant. | |
| InventoryPolicy | String | True |
Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock. Valid values are deny or continue. | |
| InventoryQuantity | Int | True |
The number of items in stock for this product variant. Default value 1. | |
| Option1 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option2 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option3 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Position | Int | False |
The order of the product variant in the list of product variants. | |
| RequiresShipping | Bool | False |
Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant. | |
| Sku | String | False |
A unique identifier for the product in the shop. | |
| Taxable | Bool | False |
Specifies whether or not a tax is charged when the product variant is sold. | |
| CreatedAt | Datetime | True |
The date and time when the product variant was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
Provinces
Query and update information regarding different provinces.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CountryId and Id columns. The supported SQL operator is '=' for ProductId and Id columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Provinces WHERE CountryId = '123'
SELECT * FROM Provinces WHERE CountryId = '123' and Id = '456'
Update
You must specify the CountryId and Id to update a province. For example:
UPDATE Provinces SET Tax = '3.4' WHERE CountryId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the province. | |
| CountryId [KEY] | Long | True |
Countries.Id |
The ID for the country that the province belongs to. |
| Name | String | False |
The full name of the province. | |
| Code | String | False |
The standard abbreviation for the province. | |
| Tax | Decimal | False |
The sales tax rate to be applied to orders made by customers from this province.. | |
| TaxPercentage | Double | False |
The province's tax in percent format. | |
| TaxName | String | False |
The name of the tax for this province. | |
| TaxType | String | False |
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. | |
| ShippingZoneId | Long | True |
The ID for the shipping zone that the province belongs to. |
RecurringApplicationCharges
Create, update, delete, and query Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM RecurringApplicationCharges
SELECT * FROM RecurringApplicationCharges WHERE Id = '123'
Update
UPDATE RecurringApplicationCharges SET Test = 'true', Name = 'cd' WHERE Id = '2'
Delete
You must specify the Id of the recurring application charge to delete it.
DELETE FROM RecurringApplicationCharges WHERE Id = '2'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the recurring application charge. | |
| Name | String | False |
The name of the recurring application charge. | |
| ApiClientId | String | False |
The API Client Id | |
| Price | Decimal | False |
The price of the recurring application charge. The maximum price is 10,000. | |
| Status | String | False |
The status of the recurring charge | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting the charge. | |
| BillingOn | Date | False |
The date and time (ISO 8601 format) when the customer was billed. | |
| Test | String | False |
Whether the application charge is a test transaction. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was created. | |
| UpdatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was last updated. | |
| ActivatedOn | Datetime | False |
The date and time (ISO 8601 format) when the customer activated the recurring application charge. | |
| CancelledOn | Datetime | False |
The date and time (ISO 8601 format) when the merchant canceled their recurring application charge. | |
| TrialDays | Int | False |
The number of days that the customer is eligible for a free trial. | |
| TrialEndsOn | Datetime | False |
The date and time (ISO 8601 format) when the free trial ends. | |
| DecoratedReturnUrl | String | False |
The decorated return url. | |
| CappedAmount | String | False |
The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property. | |
| ConfirmationUrl | String | False |
The URL where the merchant accepts or declines the recurring application charge. | |
| Terms | String | False |
The terms and conditions of usage based billing charges. Must be present in order to create usage charges, |
Redirects
Create, read, update or delete redirects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Redirects
SELECT * FROM Redirects WHERE Id = '123'
SELECT * FROM Redirects WHERE Target = '/pqr.jsp'
SELECT * FROM Redirects WHERE Path = '/abc.php'
Insert
You must specify path and target to create a Redirect.
INSERT INTO Redirects (path, target) VALUES ('/abc.php', '/pqr.jsp')
Update
You must specify the id to update a Redirect. For example:
UPDATE Redirects SET Path = '/abc.php' WHERE Id = '77171130'
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM Redirects WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the redirect. | |
| Path | String | False |
The old path to be redirected. | |
| Target | String | False |
The target location where the user will be redirected. |
Refunds
Create and query refunds.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
If you specify the unique identifier of the Order, then this view will only list refund information concerning that order.
SELECT * FROM Refunds WHERE OrderId = '179098550295'
SELECT * FROM Refunds WHERE OrderId = '179098550295' AND Id = '7382073367'
Insert
You must specify the OrderId when inserting a refund.
-
Create a new refund for an order using aggregates.
INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]') -
Create a new refund for an order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, 'OrdersItems#TEMP') -
Create a new refund for an order and attach a transaction to the refund as well using aggregates.
INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]', '[{\"kind\":\"refund\",\"amount\":5.5,\"gateway\":\"gw\",\"parent_id\":\"789\"}]') -
Create a new refund for an order and attach a transaction to the refund as well using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Transactions#TEMP (TransactionItemParentId, TransactionItemAmount, TransactionItemKind, TransactionItemGateway) VALUES ('789', 5.5, 'refund', 'gw') INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', 'OrdersItems#TEMP', 'Transactions#TEMP') -
Refund a specific amount of shipping using aggregates.
INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, '[{\"parent_id\":\"456\"}]') -
Refund a specific amount of shipping using temporary table.
INSERT INTO Transactions#TEMP (TransactionItemParentId) VALUES ('456') INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, 'Transactions#TEMP')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique identifier for the refund. | |
| OrderId | Long | False |
Orders.Id |
The id of the order. |
| OrderUpdatedAt | Datetime | True |
Orders.UpdatedAt |
The date and time when the order was last modified. |
| Note | String | False |
The optional note attached to a refund. | |
| Restock | Bool | True |
Whether or not the line items were added back to the store inventory. | |
| UserId | Long | True |
The unique identifier of the user who performed the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| ProcessedAt | Datetime | True |
The date and time when the refund was imported. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the refund. | |
| OrderTransactionAggregate | String | False |
A JSON aggregate of transactions associated with the refund. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Notify | Bool |
Whether or not to send a refund notification to the customer. |
| DiscrepancyReason | String |
An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other) |
| ShippingAmount | Decimal |
Set specific amount of shipping to refund. Takes precedence over FullRefund. |
| ShippingFullRefund | Bool |
Whether or not to to refund all remaining shipping. |
ResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ResourceFeedbacks
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ResourceFeedbacks] ([State], [Messages], [FeedbackGeneratedAt]) VALUES ('requires_action', 'Wow wow.', '2023-09-13 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
ScriptTags
Create, read, update or delete script tags.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. For CreatedAt and UpdatedAt the supported SQL operators are '>' and '<'. The following queries are the only ones processed server-side:SELECT * FROM ScriptTags
SELECT * FROM ScriptTags WHERE Id = '123'
SELECT * FROM ScriptTags WHERE CreatedAt > '2018-05-02'
SELECT * FROM ScriptTags WHERE UpdatedAt < '2017-08-15'
SELECT * FROM ScriptTags WHERE Src = 'https://example.com/my_script.js'
Insert
You must specify event and src to create a ScriptTag.
INSERT INTO Scripttags (event, src) VALUES ('onload', 'https://js-aplenty.com/abc.js')
Update
You must specify the id to update a ScriptTag. For example:
UPDATE ScriptTags SET src = 'https://js-aplenty.com/abc.js' WHERE Id = '77171130'
Delete
You must specify the Id of the ScriptTag to delete it.
DELETE FROM ScriptTags WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the script tag. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was created. | |
| DisplayScope | String | False |
The page or pages on the online store where the script should be included. | |
| Event | String | False |
The DOM event that triggers the loading of the script. Valid values: onload. | |
| Src | String | False |
The URL of the remote script. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was last updated. |
SmartCollections
Query, insert, update, or delete information regarding different smart collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, PublishedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for the ProductId, Title, Handle, and PublishedStatus columns and '>' and '<' for the UpdatedAt and PublishedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM SmartCollections WHERE Id = '123'
SELECT * FROM SmartCollections WHERE Id IN ('123', '456')
SELECT * FROM SmartCollections WHERE ProductId = '123'
SELECT * FROM SmartCollections WHERE Title = 'Ducks'
SELECT * FROM SmartCollections WHERE Handle = 'frontpage'
SELECT * FROM SmartCollections WHERE PublishedStatus = 'published'
SELECT * FROM SmartCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM SmartCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title and Rules to create a smart collection. For example:
INSERT INTO SmartCollections (Title, Rules) VALUES ('IPods', '[{"column": "vendor","relation": "equals","condition": "Apple"}]')
Update
You must specify the smart collection Id to update a smart collection. For example:
UPDATE SmartCollections SET BodyHtml = '5000 songs in your pocket' WHERE Id = '123'
Delete
You must specify the Id of the smart collection to delete it.
DELETE FROM SmartCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the smart collection. | |
| Title | String | False |
The name of the smart collection. Maximum length: 255 characters. | |
| BodyHtml | String | False |
The description of the smart collection. Includes HTML markup. Many shop themes display this on the smart collection page. | |
| Image | String | False |
A JSON aggregate with information regarding the image of smart collection. | |
| Rules | String | False |
A JSON aggregate with the list of rules that define what products go into the smart collection. Valid values for each rule field: column: tag, title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title; relation: equals, greater_than, less_than, starts_with, ends_with, contains; condition: any string | |
| Handle | String | False |
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) | |
| Disjunctive | Bool | False |
Whether the product must match all the rules to be included in the smart collection. Valid values: true: products only need to match one or more of the rules to be included in the smart collection, false: products must match all of the rules to be included in the smart collection. | |
| SortOrder | String | False |
The order in which products in the smart collection appear. | |
| TemplateSuffix | String | False |
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. | |
| PublishedScope | String | False |
Whether the smart collection is published to Point of Sale. Valid values: web: The smart collection is published to the shop's online channels and not published to the Point of Sale channel, global: The smart collection is published to both the online channels and the Point of Sale channel. | |
| UpdatedAt | Datetime | True |
The date and time when the smart collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the smart collection was published. Returns null when the collection is hidden. | |
| ProductId | String | True |
Show smart collections that include a given product. | |
| PublishedStatus | String | True |
Show smart collection with a given published status: published: show only published smart collections, unpublished: show only unpublished smart collections, any: show all smart collections. (default: any). |
Themes
Create, read, update or delete themes
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Theme
SELECT * FROM Themes WHERE Id = '123'
Insert
You must specify name to create a Theme.
INSERT INTO Themes (name) VALUES ('NewTheme')
Update
You must specify the id to update a Theme. For example:
UPDATE Themes SET name = 'NewTheme' WHERE Id = '77171130'
Delete
You must specify the Id of the Theme to delete it.
DELETE FROM Themes WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the theme. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the theme was created. | |
| Name | String | False |
The name of the theme. | |
| Previewable | Bool | True |
Whether the theme can currently be previewed. | |
| Processing | Bool | True |
Whether files are still being copied into place for this theme. | |
| Role | String | False |
Specifies how the theme is being used within the shop. | |
| ThemeStoreId | Long | True |
A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store. | |
| UpdatedAt | Datetime | True |
The date and time ( ISO 8601 format) when the theme was last updated. |
UsageCharges
Create or view Usage Charges for Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM UsageCharges WHERE Id = 123
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619 AND Id = 123
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the usage charge. | |
| Description | String | False |
The name of the usage charge. | |
| Price | Decimal | False |
The price of the usage charge. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the usage charge was created. | |
| BillingOn | Date | False |
The date and time (ISO 8601 format) when the customer is billed. | |
| BalanceUsed | Decimal | False |
The used balance | |
| BalanceRemaining | Decimal | False |
The remaining balance | |
| RiskLevel | Int | False |
The risk Level | |
| RecurringApplicationId | Long | False |
The Id of the RecurringApplication Charge |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| AbandonedCheckouts | Query abandoned checkouts. |
| AbandonedCheckoutsItems | Query abandoned checkouts items. |
| AssignedFulfillmentOrders | The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level. |
| DiscountApplications | Query note attributes belonging to an order or draft order. |
| DraftOrderItemProperties | Query order item properties. |
| DraftOrderItems | Query draft order items. |
| DraftOrderItemTaxLines | Query draft order items tax lines. |
| Events | Retrieve events which have happened in your shop. |
| FulfillmentOrders | Query fulfillment orders. |
| Locations | Retrieve information regarding store locations. |
| NoteAttributes | Query note attributes belonging to an order or draft order. |
| OrderDiscountCodes | Query note attributes belonging to an order or draft order. |
| OrderItemDiscountAllocations | Query order item discount allocations. |
| OrderItemProperties | Query order item properties. |
| OrdersItems | Query order items. |
| Payouts | Retrieves a list of all payouts ordered by payout date, with the most recent being first. |
| PayoutTransactions | Retrieves a list of all balance transactions ordered by processing time, with the most recent being first. |
| RefundAdjustments | Create and query transactions. |
| RefundsItems | Get data on OrdersItems that have been refunded. |
| RefundTransactions | Query transactions for Refund Object. |
| Reports | To query all the Reports. |
| ShippingItemDiscountAllocations | Query Shipping item discount allocations. |
| ShippingItems | Query order shipping. |
| ShippingZones | Retrieve information regarding shipping zones. |
| Shop | Contains general settings and information about the shop. |
| TaxItems | Query order taxes. |
| Users | Query Users. |
AbandonedCheckouts
Query abandoned checkouts.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckouts WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the order. | |
| AbandonedCheckoutUrl | String | The full recovery URL to be sent to a customer to recover their abandoned checkout. | |
| BuyerAcceptsMarketing | Bool | Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | The reason why the order was cancelled. | |
| CartToken | String | Unique identifier for a particular cart that is attached to a particular order. | |
| Currency | String | The three letter code (ISO 4217) for the currency used for the payment. | |
| CustomerId | Long |
Customers.Id | A unique numeric identifier for the customer. |
| DiscountCodes | String | Applicable discount codes that can be applied to the order. | |
| String | The customer's email address. | ||
| Note | String | The text of an optional note that a shop owner can attach to the order. | |
| LandingSite | String | The URL for the page where the buyer landed when entering the shop. | |
| ReferringSite | String | The website that the customer clicked on to come to the shop. | |
| SourceName | String | Where the order originated. | |
| SubtotalPrice | Decimal | Price of the order before shipping and taxes. | |
| TotalDiscounts | Decimal | The total amount of the discounts to be applied to the price of the order. | |
| TotalLineItemsPrice | Decimal | The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | The sum of all the prices of all the items in the order, taxes and discounts included. | |
| TotalTax | Decimal | The sum of all the taxes applied to the order. | |
| TotalWeight | Double | The sum of all the weights of the line items in the order, in grams. | |
| TaxesIncluded | Bool | States whether or not taxes are included in the order subtotal. | |
| Token | String | Unique identifier for a particular order. | |
| BillingAddressFirstName | String | The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | The last name of the person associated with the payment method. | |
| BillingAddressAdress1 | String | The street address of the billing address. | |
| BillingAddressAdress2 | String | An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | The phone number at the billing address. | |
| BillingAddressCity | String | The city of the billing address. | |
| BillingAddressCompany | String | The company of the person associated with the billing address. | |
| BillingAddressZip | String | The zip or postal code of the billing address. | |
| BillingAddressProvince | String | The name of the state or province of the billing address. | |
| BillingAddressCountry | String | The name of the country of the billing address. | |
| BillingAddressLatitude | Double | The latitude of the billing address. | |
| BillingAddressLongitude | Double | The longitude of the billing address. | |
| BillingAddressName | String | The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | The first name of the person associated with the shipping address. | |
| ShippingAddressLastName | String | The last name of the person associated with the shipping address. | |
| ShippingAddressAdress1 | String | The street address of the shipping address. | |
| ShippingAddressAdress2 | String | An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | The phone number at the shipping address. | |
| ShippingAddressCity | String | The city of the shipping address. | |
| ShippingAddressCompany | String | The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | The longitude of the shipping address. | |
| ShippingAddressName | String | The full name of the person associated with the shipping address. | |
| ShippingAddressCountryCode | String | The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | Whether this address is the default one or not. | |
| ClosedAt | Datetime | The date and time when the order was closed. | |
| CompletedAt | Datetime | CompletedAt | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AbandonedCheckoutsItems
Query abandoned checkouts items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckoutsItems WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| AbandonedCheckoutId [KEY] | Long | The unique numeric identifier for the order. | |
| ProductId [KEY] | Long |
Products.Id | The product ID od the item. |
| ItemVariantId [KEY] | Long | The product variant ID of item. | |
| ItemTitle | String | The title of the product. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item in presentment currency. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier for the item in the shop. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the item's supplier. | |
| FulFillmentsService | String | The fulfillment service provider for the item. | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AssignedFulfillmentOrders
The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the AssignedLocationId and RequestStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationId IN (1, 2)
SELECT * FROM AssignedFulfillmentOrders WHERE RequestStatus = 'cancellation_requested'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| FulfillmentServiceHandle | String | A unique numeric identifier for the order. | |
| RequestStatus | String | The status of the fulfillment. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| Status | String | The status of the fulfillment order. | |
| Operation | String | An operation to apply to the fulfillment. Complete, Open, or Cancel. |
DiscountApplications
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM DiscountApplications WHERE OrderId = '1'
SELECT * FROM DiscountApplications WHERE OrderId IN ('1', '2')
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt <= '2020-07-20 08:28:03.0'
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt > '2020-07-20 08:28:03.0'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Type | String | The name of the note attribute. | |
| Title | String | The value of the note attribute. | |
| Description | String | The value of the note attribute. | |
| Value | String | The value of the note attribute. | |
| ValueType | String | The value of the note attribute. | |
| AllocationMethod | String | The value of the note attribute. | |
| TargetSelection | String | The value of the note attribute. | |
| TargetType | String | The value of the note attribute. |
DraftOrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId column. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItemProperties WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the order item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. |
DraftOrderItems
Query draft order items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItems WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the line item. | |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| ProductId | Long |
Products.Id | The ID of the product corresponding to the line item product variant. |
| Custom | Bool | States whether this is a custom line item or a product variant line item | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| FulFillmentsService | String | Service provider responsible for fulfillment. | |
| ItemGrams | Int | The weight of the item in grams. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| ItemTitle | String | The title of the product or variant. | |
| ItemVariantId | Long | The id of the product variant. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the supplier of the item. | |
| Name | String | The name of the product variant. | |
| GiftCard | Bool | States whether or not the product is a gift card. | |
| Properties | String | Shows custom properties for this order item. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| TaxLines | String | Shows tax lines for this order item. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
DraftOrderItemTaxLines
Query draft order items tax lines.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the draft line item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| TaxTitle | String | The name of the tax. | |
| TaxRate | Decimal | The rate of tax to be applied. | |
| TaxPrice | Decimal | The amount of tax to be charged. |
Events
Retrieve events which have happened in your shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, OrderId, Verb, and CreatedAt columns. The supported SQL operators are '=' for the Id, ProductId, OrderId, and Verb columns and ">" and "<" for CreatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Events WHERE Id = '123'
SELECT * FROM Events WHERE ProductId = '123'
SELECT * FROM Events WHERE OrderId = '123'
SELECT * FROM Events WHERE Verb = 'Confirmed'
SELECT * FROM Events WHERE CreatedAt > '2018-05-02'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the event. | |
| Description | String | A human readable description of the event. | |
| Message | String | A human readable description of the event. Can contain some HTML formatting. | |
| Body | String | A text field containing information about the event. | |
| Path | String | A relative URL to the resource the event is for, if applicable. | |
| SubjectId | Long | The ID of the resource that generated the event. | |
| SubjectType | String | he type of the resource that generated the event. Valid values: Article, Blog, Collection, Comment, Order, Page, Product, ApiPermission. | |
| Verb | String | The type of event that occurred. Different resources generate different types of event. | |
| Author | String | The author of the event. | |
| Arguments | String | Refers to a certain event and its resources. | |
| CreatedAt | Datetime | The date and time when the event was created. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| OrderId | Long | The ID of the Order to retrieve events from. | |
| ProductId | Long | The ID of the Product to retrieve events from. |
FulfillmentOrders
Query fulfillment orders.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and Id columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM FulfillmentOrders WHERE OrderId = '1'
SELECT * FROM FulfillmentOrders WHERE Id = '1'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | An ID for the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId [KEY] | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| FullfillAt | Datetime | The datetime (in UTC) when the fulfillment order is ready for fulfillment. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| RequestStatus | String | The status of the fulfillment. | |
| Status | String | The status of the fulfillment order. | |
| SupportedActions | String | The actions that can be performed on this fulfillment order. | |
| MerchantRequests | String | A list of requests sent by the merchant to the fulfillment service for this fulfillment order.. | |
| FulfillmentHolds | String | Represents the fulfillment holds applied on the fulfillment order. | |
| InternationalDuties | String | The international duties relevant to the fulfillment order. | |
| AssignedLocationAddress1 | String | The street address of the assigned location | |
| AssignedLocationAddress2 | String | An optional additional field for the street address of the assigned location. | |
| AssignedLocationCity | String | The city of the assigned location. | |
| AssignedLocationCountryCode | String | The two-letter code for the country of the assigned location | |
| AssignedLocationName | String | The name of the assigned location. | |
| AssignedLocationPhone | String | The phone number of the assigned location. |
Locations
Retrieve information regarding store locations.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Locations WHERE Id = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID for the location. | |
| Name | String | The name of the location. | |
| Legacy | Bool | 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. | |
| Address1 | String | The first line of the address. | |
| Address2 | String | The second line of the address. | |
| City | String | The city the location is in. | |
| Zip | String | The zip or postal code. | |
| Province | String | The province the location is in. | |
| Country | String | The country the location is in. | |
| Phone | String | The phone number of the location. This value can contain special characters like - and +. | |
| CountryCode | String | The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in. | |
| CountryName | String | The name of the country the location is in. | |
| CreatedAt | Datetime | The date and time when the location was created. | |
| UpdatedAt | Datetime | The date and time when the location was last updated. | |
| DeletedAt | Datetime | The date and time when the location was deleted. |
NoteAttributes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM NoteAttributes WHERE OrderId = '123'
SELECT * FROM NoteAttributes WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Name | String | The name of the note attribute. | |
| Value | String | The value of the note attribute. |
OrderDiscountCodes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM OrderDiscountCodes WHERE OrderId = '1'
SELECT * FROM OrderDiscountCodes WHERE OrderId IN ('1', '2')
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt <= '2019-05-13 09:23:06.0'
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt >= '2019-05-13 09:23:06.0'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Code [KEY] | String | The name of the note attribute. | |
| Amount | String | The value of the note attribute. | |
| Type | String | The value of the note attribute. |
OrderItemDiscountAllocations
Query order item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| amount | String | The Amount of the item discount allocations. | |
| ApplicationIndex | Int | The ApplicationIndex of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The supported SQL operators are '=' for OrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side. You can set the Type pseudo column to "DraftOrder" to list order items belonging to draft orders instead of orders, or you can set Type to "AbandonedCheckout" to list order items belonging to abandoned checkouts.
SELECT * FROM OrderItemProperties WHERE OrderId = '123'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrdersItems
Query order items.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the order item. Only available for orders. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Type | String | The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout). | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
Payouts
Retrieves a list of all payouts ordered by payout date, with the most recent being first.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status and Date columns. The supported SQL operator is '=' for Id, Status and Date columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Payouts WHERE Id = '123'
SELECT * FROM Payouts WHERE Status = 'pending'
SELECT * FROM Payouts WHERE Date = '2018-10-30'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the payout. | |
| Status | String | The transfer status of the payout. | |
| Currency | String | The ISO 4217 currency code of the payout. | |
| Amount | Decimal | The total amount of the payout, in a decimal formatted string. | |
| Date | Datetime | The date the payout was issued. |
PayoutTransactions
Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the transaction. | |
| Type | String | The type of the balance transaction. | |
| Test | Bool | If the transaction was created for a test mode Order or payment. | |
| PayoutId | Long |
Payouts.Id | The id of the payout the transaction was paid out in. |
| PayoutStatus | String | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout. | |
| Currency | String | The ISO 4217 currency code of the transaction. | |
| Amount | Decimal | The gross amount of the transaction, in a decimal formatted string. | |
| Fee | Decimal | The total amount of fees deducted from the transaction amount. | |
| Net | Decimal | The net amount of the transaction. | |
| SourceId | Long | The id of the resource leading to the transaction. | |
| SourceType | String | The type of the resource leading to the transaction. | |
| SourceOrderTransactionId | String | The id of the Order Transaction that resulted in this balance transaction. | |
| SourceOrderId | String | The id of the Order that this transaction ultimately originated from. | |
| ProcessedAt | Datetime | The time the transaction was processed. |
RefundAdjustments
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundAdjustments WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundAdjustments WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the refund adjustment. | |
| OrderId | Long |
Orders.Id | The unique identifier for the order that the order adjustment is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund that the order adjustment is associated with. |
| Amount | Decimal | The value of the discrepancy between the calculated refund and the actual refund. | |
| TaxAmount | Decimal | The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund. | |
| Kind | String | The order adjustment type. | |
| Reason | String | The reason for the order adjustment. | |
| AmountShopMoney | Decimal | The amount of the order adjustment in shop. | |
| AmountShopCurrency | String | The currency of the order adjustment in shop. | |
| AmountPresentmentMoney | Decimal | The amount of the order adjustment in presentment. | |
| AmountPresentmentCurrency | String | The currency of the order adjustment in presentment. | |
| TaxAmountShopMoney | Decimal | The tax amount of the order adjustment in shop. | |
| TaxAmountShopCurrency | String | The tax currency of the order adjustment in shop. | |
| TaxAmountPresentmentMoney | Decimal | The tax amount of the order adjustment in presentment. | |
| TaxAmountPresentmentCurrency | String | The tax currency of the order adjustment in presentment. |
RefundsItems
Get data on OrdersItems that have been refunded.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderID [KEY] | Long |
Orders.Id | The id of the refund this refunded item belongs to. |
| RefundId [KEY] | Long |
Refunds.Id | The id of the refund this refunded item belongs to. |
| LocationId | Long | The unique identifier of the location tied to the refund item | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| RefundSubtotal | Decimal | The refunded amount for this item. This is calculated by multiplying ItemPrice with RefundQuantity. | |
| RefundQuantity | Int | The quantity of the item refunded. | |
| RefundRestockType | String | The type of the restock action. | |
| RefundSubtotalPresentmentAmount | Decimal | The total amount of the presentment money. | |
| RefundSubtotalPresentmentCurrencyCode | String | The currency code of the presentment money. | |
| RefundSubtotalShopAmount | Decimal | The total amount of the shop money. | |
| RefundSubtotalShopCurrencyCode | String | The currency code of the shop money. | |
| RefundTotalTax | Decimal | Total tax for the refunded item. | |
| RefundTotalTaxPresentmentAmount | Decimal | Total tax amount for the presentment money. | |
| RefundTotalTaxPresentmentCurrencyCode | String | Currency code for the tax on presentment money. | |
| RefundTotalTaxShopAmount | Decimal | Total tax amount for the shop money. | |
| RefundTotalTaxShopCurrencyCode | String | Currency code for the tax on shop money. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
RefundTransactions
Query transactions for Refund Object.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundTransactions WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| TransactionsId [KEY] | Long | The ID for the refund transaction. | |
| OrderId | Long |
Orders.Id | The ID for the order that the transaction is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund associated with. |
| Amount | Decimal | The amount of money included in the transaction. | |
| Authorization | String | The authorization code associated with the transaction.. | |
| CreatedAt | Datetime | The date and time (ISO 8601 format) when the transaction was created. | |
| Currency | String | The three-letter code (ISO 4217 format) for the currency used for the payment. | |
| DeviceId | String | The ID for the device. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| GraphqlAPIId | String | The order adjustment type. | |
| Gateway | String | The name of the gateway the transaction was issued through. | |
| Kind | String | The transaction's type. | |
| LocationId | String | The ID of the physical location where the transaction was processed. | |
| Message | String | A string generated by the payment provider with additional information about why the transaction succeeded or failed. | |
| ParentId | Long | The ID of an associated transaction.. | |
| ProcessedAt | Datetime | The date and time (ISO 8601 format) when a transaction was processed. | |
| Status | String | The status of the transaction. | |
| SourceName | String | The origin of the transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| UserId | String | The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable. |
Reports
To query all the Reports.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Reports WHERE Id = '123'
SELECT * FROM Reports WHERE UpdatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the report. | |
| Name | String | The name of the report. | |
| ShopifyQl | String | The ShopifyQL query that generates the report. | |
| UpdatedAt | Datetime | The date and time (ISO 8601) when the report was last modified. | |
| Category | String | The category for the report. When you create a report, the API will return custom_app_reports. |
ShippingItemDiscountAllocations
Query Shipping item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
ShippingItems.ItemId | The id of the shipping item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Amount | String | The Amount of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| DiscountApplicationIndex | Int | The Discount application index for an order. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
ShippingItems
Query order shipping.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.
SELECT * FROM ShippingItems WHERE OrderId = '123'
SELECT * FROM ShippingItems WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The id of the shipping item. | |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Price | Decimal | The price of this shipping method. | |
| Code | String | A reference to the shipping method. | |
| Title | String | The title of the shipping method. | |
| Source | String | The source of the shipping method. | |
| CarrierIdentifier | String | A reference to the carrier service that provided the rate. | |
| RequestedFulfillmentServiceId | String | A reference to the fulfillment service that is being requested for the shipping method. |
ShippingZones
Retrieve information regarding shipping zones.
View-Specific Information
Select
The Sync App processes all filters client-side within the Sync App.The following query is the only one processed server-side:
SELECT * FROM ShippingZones
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the shipping zone. | |
| Name | String | The name of the shipping zone, specified by the user. | |
| ProfileId | String | The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates. | |
| LocationGroupId | String | 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. | |
| Countries | String | A list of countries that belong to the shipping zone. | |
| CarrierShippingRateProviders | String | Information about carrier shipping providers and the rates used. | |
| PriceBasedShippingRates | String | Information about price based shipping rates used. | |
| WeightBasedShippingRates | String | Information about weight based shipping rates used. |
Shop
Contains general settings and information about the shop.
View-Specific Information
Select
The Sync App processes the WHERE clause client-side within the Sync App for all queries to this table. For example, the following query is the only query processed server-side:SELECT * FROM Shop
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the shop. | |
| Name | String | The name of the shop. | |
| String | The contact email address for the shop. | ||
| Address1 | String | The shop's street address. | |
| Address2 | String | The shop's additional street address (apt, suite, etc.). | |
| City | String | The city in which the shop is located. | |
| Country | String | The shop's country (by default equal to the two-letter country code). | |
| CountryCode | String | The two-letter country code corresponding to the shop's country. | |
| CountryName | String | The shop's normalized country name. | |
| CustomerEmail | String | The customer's email. | |
| Currency | String | The three-letter code for the currency that the shop accepts. | |
| Domain | String | The shop's domain. | |
| GoogleAppsDomain | String | The URL of the domain if the shop has a google apps domain. | |
| GoogleAppsLoginEnabled | String | Indicated whether the shop has google apps login enabled. | |
| Latitude | Double | Geographic coordinate specifying the north/south location of a shop. | |
| Longitude | Double | Geographic coordinate specifying the east/west location of a shop. | |
| MoneyFormat | String | A string representing the way currency is formatted when the currency isn't specified. | |
| MoneyWithCurrencyFormat | String | A string representing the way currency is formatted when the currency is specified. | |
| WeightUnit | String | A string representing the default unit of weight measurement for the shop. | |
| MyshopifyDomain | String | The shop's 'myshopify.com' domain. | |
| PlanName | String | The name of the Shopify plan the shop is on. | |
| HasDiscounts | Bool | Indicates if any active discounts exist for the shop. | |
| HasGiftCards | Bool | Indicates if any active gift cards exist for the shop. | |
| PlanDisplayName | String | The display name of the Shopify plan the shop is on. | |
| PasswordEnabled | Bool | Indicates whether the Storefront password protection is enabled. | |
| Phone | String | The contact phone number for the shop. | |
| PrimaryLocale | String | The shop's primary locale. | |
| Province | String | The shop's normalized province or state name. | |
| ProvinceCode | String | The two-letter code for the shop's province or state. | |
| ShopOwner | String | The username of the shop owner. | |
| Source | String | Source | |
| TaxShipping | Bool | Specifies whether or not taxes were charged for shipping. | |
| TaxesIncluding | Bool | The setting for whether applicable taxes are included in product prices. | |
| CountryTaxes | Bool | The setting for whether the shop is applying taxes on a per-county basis or not (US-only). | |
| Timezone | String | The name of the timezone the shop is in. | |
| IANATimezone | String | The named timezone assigned by the IANA. | |
| Zip | String | The zip or postal code of the shop's address. | |
| HasStorefront | Bool | Indicates whether the shop has web-based storefront or not. | |
| CreatedAt | Datetime | The date and time when the shop was created. | |
| UpdatedAt | Datetime | The date and time when the shop was last updated. | |
| SetupRequired | Bool | Indicates whether the shop has any outstanding setup steps or not. |
TaxItems
Query order taxes.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM TaxItems WHERE OrderId = '123'
SELECT * FROM TaxItems WHERE OrderUpdatedAt > '2018-05-21'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. | |
| TaxItemPrice | Decimal | The amount of tax to be charged. | |
| TaxItemRate | Decimal | The rate of tax to be applied. | |
| TaxItemTitle | String | The name of the tax. |
Users
Query Users.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the user. | |
| FirstName | String | The first name of the user. | |
| String | The email of the user. | ||
| Url | String | The url of the user. | |
| IM | String | The IM of the user. | |
| ScreenName | String | The screen name of the user. | |
| Phone | String | The phone number of the of the user. | |
| LastName | String | The last name of the user. | |
| AccountOwner | Bool | If the user is the account owner. | |
| ReceiveAnnouncements | Bool | If the user receives announcements. | |
| Bio | String | The bio of the user. | |
| Permissions | String | The list of permissions of the user. | |
| Locale | String | The Locale of the user. | |
| UserType | String | The type of the user. | |
| AdminGraphQLAPIId | String | The Admin GraphQL API Id of the user. | |
| TFAEnabled | Bool | If TFA is enabled. |
GRAPHQL Data Model
CData Sync App は、Shopify API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
GraphQL データモデルを使用するには、Schema をGraphQL に設定します。
テーブル
テーブル は変更可能なテーブルです。
ビュー
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なモデルデータはビューとして表されます。
ストアドプロシージャ
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Bulk API の使用
UseBulkApi がTrue に設定されている場合、CData Sync App はShopify Bulk Operations を実行します。このオプションは、Shopify から多くのデータを選択またはエクスポートする必要がある場合に、優れたパフォーマンスを発揮します。
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| AppFeedbacks | Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store. |
| AppSubscriptionLineItems | Returns the plans attached to the app subscription. |
| AppSubscriptions | Lists all subscriptions created for a shop on the installed application. |
| Catalogs | The catalogs belonging to the shop. |
| Collections | Returns a list of collections. |
| Companies | Returns the list of companies in the shop. |
| CompanyLocations | Returns a list of locations in the company. |
| Customers | Retrieves a list of customers. |
| DeliveryProfiles | Returns a list of saved delivery profiles. |
| DiscountsAutomaticApp | Returns a list of discounts. |
| DiscountsAutomaticBasic | Returns a list of discounts. |
| DiscountsAutomaticBxgy | Returns a list of discounts. |
| DiscountsCodeApp | Returns a list of discounts. |
| DiscountsCodeBasic | Returns a list of discounts. |
| DiscountsCodeBxgy | Returns a list of discounts. |
| DraftOrders | Returns a list of saved draft orders. |
| FulfillmentEvents | Retrieves the history of events associated with one or many fulfillments. |
| FulfillmentOrders | Retrieves a paginated list of merchant-managed and third-party fulfillment orders. |
| Fulfillments | Fulfillment represents a shipment of one or more items in an order. |
| FulfillmentServices | Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner. |
| FulfillmentTrackingInfo | Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL. |
| GiftCards | Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription) |
| InventoryItems | Returns a list of inventory items. |
| Metafields | Retrieves a list of metafields that belong to one or many resource IDs. |
| Orders | Retrieves a list of orders. |
| OrderTransactions | Retrieves the transactions associated with the resource. |
| PriceLists | All price lists for a shop. |
| ProductImages | Returns the images associated with the product. |
| ProductResourceFeedbacks | Returns the product resource feedback for the currently authenticated app. |
| Products | Returns a list of products. |
| ProductVariants | Returns a list of the product variants. |
| Publications | Returns the list of publications. |
| Refunds | Represents a refund of items or transactions in an order. |
| Returns | Retrieves a list of returns for the order. |
| ScriptTags | Returns a list of script tags. |
| SellingPlanGroups | Returns a list Selling Plan Groups. |
| StorefrontAccessTokens | Retrieves the storefront access token of a private application. These are scoped per-application. |
| UrlRedirects | Returns a list of redirects for a shop. |
AppFeedbacks
Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.For example, the following queries are processed client-side:
SELECT * FROM AppFeedbacks WHERE Id = 'VALUE'
Insert
INSERT statements are mapped to the 'shopResourceFeedbackCreate' GraphQL mutation.
The following column can be used to create a new record:
Message
The following pseudo-columns can be used to create a new record:
State, FeedbackGeneratedAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | True |
Name of the app. | |
| Message | String | True |
The feedback message presented to the merchant. | |
| Url | String | True |
The URL that the link visits. | |
| Label | String | True |
A context-sensitive label for the link. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| State | String |
The state of the feedback and whether it requires merchant action. |
| FeedbackGeneratedAt | Datetime |
The date and time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. |
AppSubscriptionLineItems
Returns the plans attached to the app subscription.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppSubscriptionLineItems WHERE AppInstallationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'appSubscriptionLineItemUpdate' GraphQL mutation.
The following columns can be updated:
UsagePricingPlanCappedAmount, UsagePricingPlanCappedAmountCurrencyCode
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppSubscriptionId | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| RecurringPricingPlanDiscountDurationLimitInIntervals | Int | True |
The total number of billing intervals to which the discount will be applied. The discount will be applied to an indefinite number of billing intervals if this value is blank. | |
| RecurringPricingPlanDiscountPriceAfterDiscountAmount | Decimal | True |
The price of the subscription after the discount is applied. Decimal money amount. | |
| RecurringPricingPlanDiscountPriceAfterDiscountCurrencyCode | String | True |
The price of the subscription after the discount is applied. Currency of the money. | |
| RecurringPricingPlanDiscountRemainingDurationInIntervals | Int | True |
The remaining number of billing intervals to which the discount will be applied. | |
| RecurringPricingPlanValueAmount | Decimal | True |
The value of the discount applied every billing interval. Decimal money amount. | |
| RecurringPricingPlanValueAmountCurrencyCode | String | True |
The value of the discount applied every billing interval. Currency of the money. | |
| RecurringPricingPlanValuePercentage | Double | True |
The value of the discount applied every billing interval. The percentage value of a discount. | |
| RecurringPricingPlanInterval | String | True |
The frequency at which the subscribing shop is billed for an app subscription. | |
| RecurringPricingPlanPriceAmount | Decimal | True |
The amount to be charged to the subscribing shop every billing interval. Decimal money amount. | |
| RecurringPricingPlanPriceCurrencyCode | String | True |
The currency to be charged to the subscribing shop every billing interval. Currency of the money. | |
| UsagePricingPlanBalanceUsedAmount | Decimal | True |
The total usage records for interval. Decimal money amount. | |
| UsagePricingPlanBalanceUsedCurrencyCode | String | True |
The total usage records for interval. Currency of the money. | |
| UsagePricingPlanCappedAmount | Decimal | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Decimal money amount. | |
| UsagePricingPlanCappedAmountCurrencyCode | String | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Currency of the money. | |
| UsagePricingPlanInterval | String | True |
The frequency with which the app usage records are billed. | |
| UsagePricingPlanTerms | String | True |
The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges. |
AppSubscriptions
Lists all subscriptions created for a shop on the installed application.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- AppInstallationId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM AppSubscriptions
SELECT * FROM AppSubscriptions WHERE AppInstallationId = 'Val1'
Insert
Insert statements are mapped to the 'appSubscriptionCreate' GraphQL mutation.
The following columns can be used to create a new record:
Name, Test, ReturnUrl, TrialDays
The following pseudo-columns can be used to create a new record:
LineItem
Delete
Delete statements are mapped to the 'appSubscriptionCancel' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| Name | String | True |
The name of the app subscription. | |
| Status | String | True |
The status of the app subscription. | |
| Test | Bool | True |
Specifies whether the app subscription is a test transaction. | |
| ReturnUrl | String | True |
The URL that the merchant is redirected to after approving the app subscription. | |
| TrialDays | Int | True |
The number of free trial days, starting at the subscription's creation date, by which billing is delayed. | |
| CurrentPeriodEnd | Datetime | True |
The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active. | |
| CreatedAt | Datetime | True |
The date and time when the app subscription was created. | |
| LineItemIds | String | True |
The IDs of the plans attached to the app subscription. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| LineItem | String |
LineItem |
Catalogs
The catalogs belonging to the shop.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the catalog. | |
| Title | String | False |
The name of the catalog. | |
| PriceListId | String | False |
A globally-unique ID. | |
| PublicationId | String | False |
A globally-unique ID. | |
| OperationId | String | True |
A globally-unique ID. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| CompanyLocationIds | String |
The IDs of the company locations to associate to the catalog. |
Collections
Returns a list of collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Collections WHERE Id='VALUE'
SELECT * FROM Collections WHERE Title='VALUE'
SELECT * FROM Collections WHERE UpdatedAt<'2000-01-01 01:00:00.0'
UPDATE
UPDATE statements are mapped to the 'collectionUpdate' GraphQL mutation.
The following column can be updated:
SortOrder
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Title | String | True |
The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. | |
| Handle | String | True |
A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title 'Summer Catalog 2022' might have the handle 'summer-catalog-2022'. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. | |
| DescriptionHtml | String | True |
The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. | |
| ProductsCount | Int | True |
The number of products in the collection. | |
| SortOrder | String | False |
The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. | |
| TemplateSuffix | String | True |
The suffix of the Liquid template being used to show the collection in an online store. 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' template. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| PublishedOnCurrentPublication | Bool | True |
Check to see whether the resource is published to the calling app's publication. | |
| UpdatedAt | Datetime | True |
The date and time when the collection was last modified. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| RuleSetAppliedDisjunctively | Bool | True |
Whether products must match any or all of the rules to be included in the collection. If true, then products must match at least one of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection. | |
| SeoTitle | String | True |
SEO Title. | |
| SeoDescription | String | True |
SEO Description. |
Companies
Returns the list of companies in the shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExternalId supports the '=,!=' comparison operators.
- Name supports the '=,!=' comparison operators.
- CustomerSince supports the '=,!=' comparison operators.
- CreatedAt supports the '=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Companies WHERE Id='VALUE'
SELECT * FROM Companies WHERE ExternalId='VALUE'
SELECT * FROM Companies WHERE Name='VALUE'
SELECT * FROM Companies WHERE CustomerSince='2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'companyCreate' GraphQL mutation.
The following columns can be used to create a new record:
ExternalId, Name, Note, CustomerSince
UPDATE
UPDATE statements are mapped to the 'companyUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Note
DELETE
DELETE statements are mapped to the 'companyDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ExternalId | String | False |
A unique externally-supplied ID for the company. | |
| Name | String | False |
The name of the company. | |
| Note | String | False |
A note about the company. | |
| ContactCount | Int | True |
The number of contacts that belong to the company. | |
| CustomerSince | Datetime | True |
The date and time at which the company became the customer. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| LifetimeDuration | String | True |
The lifetime duration of the company, since it became a customer of the shop. Examples: '2 days', '3 months', '1 year'. | |
| LocationCount | Int | True |
The number of locations that belong to the company. | |
| OrderCount | Int | True |
The total number of orders placed for this company, across all its locations. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company. | |
| CreatedAt | Datetime | True |
The date and time at which the company was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company was last modified. | |
| DefaultRoleId | String | True |
A globally-unique ID. | |
| DefaultRoleName | String | True |
The name of a role. For example, 'admin' or 'buyer'. | |
| DefaultRoleNote | String | True |
A note for the role. | |
| MainContactId | String | True |
A globally-unique ID. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
CompanyLocations
Returns a list of locations in the company.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CompanyId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyLocations WHERE CompanyId='VALUE'
Insert
INSERT statements are mapped to the 'companyLocationCreate' GraphQL mutation.
The following columns can be used to create a new record:
CompanyId, ExternalId, TaxRegistrationId, Name, Locale, Note, Phone, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressPhone, BillingAddressRecipient, BillingAddressZip, BillingAddressCountryCode, BillingAddressZoneCode, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressPhone, ShippingAddressRecipient, ShippingAddressZip, ShippingAddressCountryCode, ShippingAddressZoneCode
UPDATE
UPDATE statements are mapped to the 'companyLocationUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Locale, Note, Phone
DELETE
DELETE statements are mapped to the 'companyLocationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| CompanyId | String | True |
Companies.Id |
A globally-unique ID. |
| ExternalId | String | False |
A unique externally-supplied ID for the company location. | |
| TaxRegistrationId | String | True |
The tax registration ID for the company location. | |
| Name | String | False |
The name of the company location. | |
| Currency | String | True |
The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. | |
| Locale | String | False |
The preferred locale of the company location. | |
| Note | String | False |
A note about the company location. | |
| Phone | String | False |
The phone number of the company location. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| OrderCount | Int | True |
The total number of orders placed for the location. | |
| TaxExemptions | String | True |
The list of tax exemptions applied to the location. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company location. | |
| CreatedAt | Datetime | True |
The date and time at which the company location was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company location was last modified. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCompanyName | String | True |
The name of the company. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| BillingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| BuyerExperienceConfigurationCheckoutToDraft | Bool | True |
Whether to checkout to draft order for merchant review. | |
| BuyerExperienceConfigurationPayNowOnly | Bool | True |
Whether a buyer must pay at checkout or they can also choose to pay later using net terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplateId | String | True |
A globally-unique ID. | |
| BuyerExperienceConfigurationPaymentTermsTemplateName | String | True |
The name of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName | String | True |
The translated payment terms template name. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDescription | String | True |
The description of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDueInDays | Int | True |
The number of days between the issued date and due date if this is the net type of payment terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType | String | True |
The type of the payment terms template. | |
| MarketId | String | True |
A globally-unique ID. | |
| ShippingAddressId | String | True |
A globally-unique ID. | |
| ShippingAddressCompanyName | String | True |
The name of the company. | |
| ShippingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | True |
The name of the city, district, village, or town. | |
| ShippingAddressCountry | String | True |
The name of the country. | |
| ShippingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| ShippingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| ShippingAddressZip | String | True |
The zip or postal code of the address. | |
| ShippingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| ShippingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
Customers
Retrieves a list of customers.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Email supports the '=,!=' comparison operators.
- Phone supports the '=,!=' comparison operators.
- State supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AmountSpentAmount supports the '=,!=' comparison operators.
SELECT * FROM Customers WHERE Id='VALUE'
SELECT * FROM Customers WHERE Email='VALUE'
SELECT * FROM Customers WHERE Phone='VALUE'
SELECT * FROM Customers WHERE State='VALUE'
SELECT * FROM Customers WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Customers WHERE AmountSpentAmount='100.000000'
Insert
INSERT statements are mapped to the 'customerCreate' GraphQL mutation.
The following columns can be used to create a new record:
FirstName, LastName, Email, Locale, Note, Phone, TaxExempt, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt
DELETE
DELETE statements are mapped to the 'customerDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| MultipassIdentifier | String | True |
A unique identifier for the customer that's used with Multipass login. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| ValidEmailAddress | Bool | True |
Whether the email address is formatted correctly. Returns 'true' when the email is formatted correctly and belongs to an existing domain. This doesn't guarantee that the email address actually exists. | |
| DisplayName | String | True |
The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. | |
| FirstName | String | True |
The customer's first name. | |
| LastName | String | True |
The customer's last name. | |
| String | True |
The customer's email address. | ||
| Locale | String | True |
The customer's locale. | |
| Note | String | True |
A note about the customer. | |
| Phone | String | True |
The customer's phone number. | |
| State | String | True |
The state of the customer's account with the shop. | |
| Tags | String | True |
A comma separated list of tags that have been added to the customer. | |
| CanDelete | Bool | True |
Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store. | |
| LifetimeDuration | String | True |
The amount of time since the customer was first added to the store. Example: 'about 12 years'. | |
| TaxExempt | Bool | True |
Whether the customer is exempt from being charged taxes on their orders. | |
| TaxExemptions | String | True |
The list of tax exemptions applied to the customer. | |
| UnsubscribeUrl | String | True |
The URL to unsubscribe the customer from the mailing list. | |
| VerifiedEmail | Bool | True |
Whether the customer has verified their email address. Defaults to 'true' if the customer is created through the Shopify admin or API. | |
| HasTimelineComment | Bool | True |
Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. | |
| NumberOfOrders | String | True |
The number of orders that the customer has made at the store in their lifetime. | |
| ProductSubscriberStatus | String | True |
Possible subscriber states of a customer defined by their subscription contracts. | |
| CreatedAt | Datetime | True |
The date and time when the customer was added to the store. | |
| UpdatedAt | Datetime | True |
The date and time when the customer was last updated. | |
| AcceptsMarketing | Bool | True |
Whether the customer has agreed to receive marketing materials. | |
| AmountSpentAmount | Decimal | True |
Decimal money amount. | |
| AmountSpentCurrencyCode | String | True |
Currency of the money. | |
| AverageOrderAmountV2Amount | Decimal | True |
Decimal money amount. | |
| AverageOrderAmountV2CurrencyCode | String | True |
Currency of the money. | |
| DefaultAddressId | String | True |
A globally-unique ID. | |
| DefaultAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DefaultAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DefaultAddressFirstName | String | True |
The first name of the customer. | |
| DefaultAddressLastName | String | True |
The last name of the customer. | |
| DefaultAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| DefaultAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DefaultAddressCity | String | True |
The name of the city, district, village, or town. | |
| DefaultAddressCompany | String | True |
The name of the customer's company or organization. | |
| DefaultAddressCountry | String | True |
The name of the country. | |
| DefaultAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DefaultAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DefaultAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DefaultAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| DefaultAddressZip | String | True |
The zip or postal code of the address. | |
| DefaultAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DefaultAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| DefaultAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| EmailMarketingConsentMarketingState | String | True |
The current email marketing state for the customer. | |
| EmailMarketingConsentMarketingOptInLevel | String | True |
The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email. | |
| EmailMarketingConsentConsentUpdatedAt | Datetime | True |
The date and time at which the customer consented to receive marketing material by email. The customer's consent state reflects the consent record with the most recent 'consent_updated_at' date. If no date is provided, then the date and time at which the consent information was sent is used. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| LastOrderId | String | True |
A globally-unique ID. | |
| MarketId | String | True |
A globally-unique ID. | |
| MergeableReason | String | True |
The reason why the customer can't be merged with another customer. | |
| MergeableErrorFields | String | True |
The list of fields preventing the customer from being merged. | |
| MergeableIsMergeable | Bool | True |
Whether the customer can be merged with another customer. | |
| MergeableMergeInProgressJobId | String | True |
The UUID of the merge job. | |
| MergeableMergeInProgressResultingCustomerId | String | True |
The ID of the customer resulting from the merge. | |
| MergeableMergeInProgressStatus | String | True |
The status of the customer merge request. | |
| SmsMarketingConsentMarketingState | String | True |
The current SMS marketing state for the customer. | |
| SmsMarketingConsentConsentCollectedFrom | String | True |
The source from which the SMS marketing information for the customer was collected. | |
| SmsMarketingConsentMarketingOptInLevel | String | True |
The marketing subscription opt-in level that was set when the customer consented to receive marketing information. | |
| SmsMarketingConsentConsentUpdatedAt | Datetime | True |
The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used. | |
| StatisticsPredictedSpendTier | String | True |
The predicted spend tier of a customer with a shop. |
DeliveryProfiles
Returns a list of saved delivery profiles.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- MerchantOwnedOnly supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DeliveryProfiles WHERE Id='VALUE'
SELECT * FROM DeliveryProfiles WHERE MerchantOwnedOnly='true'
Insert
INSERT statements are mapped to the 'deliveryProfileCreate' GraphQL mutation.
The following column can be used to create a new record:
Name
UPDATE
UPDATE statements are mapped to the 'deliveryProfileUpdate' GraphQL mutation.
The following column can be updated:
Name
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Name | String | False |
The name of the delivery profile. | |
| Default | Bool | True |
Whether this is the default profile. | |
| LegacyMode | Bool | True |
Whether this shop has enabled legacy compatibility mode for delivery profiles. | |
| OriginLocationCount | Int | True |
The number of active origin locations for the profile. | |
| ZoneCountryCount | Int | True |
The number of countries with active rates to deliver to. | |
| ActiveMethodDefinitionsCount | Int | True |
The number of active shipping rates for the profile. | |
| LocationsWithoutRatesCount | Int | True |
The number of locations without rates defined. | |
| ProductVariantsCountV2Capped | Bool | True |
Whether the count has reached the cap of 500. | |
| ProductVariantsCountV2Count | Int | True |
The product variant count. | |
| MerchantOwnedOnly | Bool | True |
If 'true', returns only delivery profiles that were created by the merchant. |
DiscountsAutomaticApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticApp WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountAutomaticAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
UPDATE
UPDATE statements are mapped to the 'discountAutomaticAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount was updated. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. |
DiscountsAutomaticBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticBasic WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, MinimumQuantity, MinimumSubtotal
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | True |
The minimum quantity of items that's required for the discount to be applied. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| MinimumQuantity | String |
The minimum quantity of items that's required for the discount to be applied. |
| MinimumSubtotal | String |
The minimum subtotal that's required for the discount to be applied. |
DiscountsAutomaticBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
SELECT * FROM DiscountsAutomaticBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountQuantityToBuy | String |
The quantity of prerequisite items. |
| DiscountAmountToBuy | String |
The value of the discount. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
DiscountsCodeApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeApp WHERE Title='VALUE'
SELECT * FROM DiscountsCodeApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountCodeAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be used to create a new record:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be updated:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | True |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBasic WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be used to create a new record:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be updated:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | False |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | False |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | False |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | False |
The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | True |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | True |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | True |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountAmountToBuy | String |
The value of the discount. |
| DiscountQuantityToBuy | Double |
The quantity of prerequisite items. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DraftOrders
Returns a list of saved draft orders.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM DraftOrders
SELECT * FROM DraftOrders WHERE Id = 'Val1'
SELECT * FROM DraftOrders WHERE Status = 'Val1'
SELECT * FROM DraftOrders WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE CustomerId = 'Val1'
Insert
Insert statements are mapped to the 'draftOrderCreate' GraphQL mutation.
The following columns can be used to create a new record:
Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount
The following pseudo-columns can be used to create a new record:
DraftOrderLineItems
Update
Update statements are mapped to the 'draftOrderUpdate' GraphQL mutation.
The following columns can be updated:
Id, Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount
The following pseudo-columns can be updated:
DraftOrderLineItems
Delete
Delete statements are mapped to the 'draftOrderDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Name | String | True |
The identifier for the draft order, which is unique within the store. For example, _#D1223_. | |
| MarketName | String | True |
The name of the selected market. | |
| String | False |
Email address of the customer, which is used to send notifications to. | ||
| Note2 | String | True |
The text from an optional note attached to the draft order. | |
| Phone | String | True |
The phone number assigned to the draft order. | |
| Ready | Bool | True |
Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish. | |
| Status | String | True |
Status of the draft order. | |
| Tags | String | True |
A comma separated list of tags associated with the draft order. Updating 'tags' overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the mutation. | |
| CompletedAt | Datetime | True |
The date and time when the draft order converted to a new order, and the draft order's status changed to **Completed**. | |
| CurrencyCode | String | True |
The three letter code for the currency of the store at the time of the most recent update to the draft order. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| InvoiceUrl | String | True |
The link to the checkout, which is sent to the customer in the invoice email. | |
| SubtotalPrice | Decimal | True |
The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. | |
| TaxExempt | Bool | True |
Whether the draft order is tax exempt. | |
| TaxesIncluded | Bool | True |
Whether the line item prices include taxes. | |
| TotalPrice | Decimal | True |
The total amount of the draft order, including taxes, shipping charges, and discounts. | |
| TotalTax | Decimal | True |
The total amount of taxes for the draft order. | |
| TotalWeight | String | True |
The total weight in grams of the draft order. | |
| HasTimelineComment | Bool | True |
Whether the merchant has added timeline comments to the draft order. | |
| InvoiceSentAt | Datetime | True |
The date and time when the invoice was last emailed to the customer. | |
| PresentmentCurrencyCode | String | True |
The payment currency of the customer for this draft order. | |
| ReserveInventoryUntil | Datetime | True |
The time after which inventory will automatically be restocked. | |
| TotalShippingPrice | Decimal | True |
The total shipping charge for the draft order. | |
| VisibleToCustomer | Bool | True |
Whether the draft order will be visible to the customer on the self-serve portal. | |
| InvoiceEmailTemplateSubject | String | True |
The subject defined for the draft invoice email template. | |
| MarketRegionCountryCode | String | True |
The selected market region country code for the draft order. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CreatedAt | Datetime | True |
The date and time when the draft order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the draft order was last changed. The format is YYYY-MM-DD HH: mm: ss. For example, 2016-02-05 17: 04: 01. | |
| OrderId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | False |
Customers.Id |
Customer who will be sent an invoice for the draft order, if there is one. |
| BillingAddressId | String | False |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | False |
The first name of the customer. | |
| BillingAddressLastName | String | False |
The last name of the customer. | |
| BillingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | False |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | False |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | False |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | False |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| AppliedDiscountTitle | String | False |
Name of the order-level discount. | |
| AppliedDiscountDescription | String | False |
Description of the order-level discount. | |
| AppliedDiscountValue | Double | False |
Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount). | |
| AppliedDiscountValueType | String | False |
Type of the order-level discount. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsOrderId | String | True |
A globally-unique ID. | |
| AppliedDiscountAmountV2Amount | Decimal | False |
Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPricePresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPricePresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPriceShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPriceShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DraftOrderLineItems | String |
The list of the line items in the draft order. |
FulfillmentEvents
Retrieves the history of events associated with one or many fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentEvents WHERE FulfillmentId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentEventCreate' GraphQL mutation.
The following columns can be used to create a new record:
FulfillmentId, Status, Address1, City, Country, Latitude, Longitude, Message, Province, Zip, EstimatedDeliveryAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| FulfillmentId | String | True |
Fulfillments.Id |
A globally-unique ID. |
| OrderId | String | True |
Orders.Id |
A globally-unique identifier. |
| Status | String | True |
The status of this fulfillment event. | |
| HappenedAt | Datetime | True |
The time at which this fulfillment event happened. | |
| Address1 | String | True |
The street address where this fulfillment event occurred. | |
| City | String | True |
The city where this fulfillment event occurred. | |
| Country | String | True |
The country where this fulfillment event occurred. | |
| Latitude | Double | True |
The latitude where this fulfillment event occurred. | |
| Longitude | Double | True |
The longitude where this fulfillment event occurred. | |
| Message | String | True |
A message associated with this fulfillment event. | |
| Province | String | True |
The province where this fulfillment event occurred. | |
| Zip | String | True |
The zip code of the location where this fulfillment event occurred. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated delivery date and time of the fulfillment. |
FulfillmentOrders
Retrieves a paginated list of merchant-managed and third-party fulfillment orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- AssignedLocationLocationId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentOrders WHERE Id='VALUE'
SELECT * FROM FulfillmentOrders WHERE Status='VALUE'
SELECT * FROM FulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'dynamic_depends_on_status' GraphQL mutation.
The following column can be updated:
Status
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the fulfillment order. | |
| FulfillAt | Datetime | True |
The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | True |
The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| RequestStatus | String | True |
The request status of the fulfillment order. | |
| CreatedAt | Datetime | True |
Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment order was last updated. | |
| AssignedLocationName | String | True |
The name of the location. | |
| AssignedLocationAddress1 | String | True |
The first line of the address for the location. | |
| AssignedLocationAddress2 | String | True |
The second line of the address for the location. | |
| AssignedLocationCity | String | True |
The city of the location. | |
| AssignedLocationPhone | String | True |
The phone number of the location. | |
| AssignedLocationProvince | String | True |
The province of the location. | |
| AssignedLocationZip | String | True |
The ZIP code of the location. | |
| AssignedLocationCountryCode | String | True |
The two-letter country code of the location. | |
| AssignedLocationLocationId | String | True |
A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | True |
The name of the location. | |
| AssignedLocationLocationActivatable | Bool | True |
Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | True |
Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | True |
Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | True |
Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | True |
The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | True |
Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | True |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | True |
Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | True |
Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | True |
Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | True |
A globally-unique ID. | |
| DeliveryMethodMethodType | String | True |
The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | True |
The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | True |
The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | True |
A globally-unique ID. | |
| DestinationFirstName | String | True |
The first name of the customer at the destination. | |
| DestinationLastName | String | True |
The last name of the customer at the destination. | |
| DestinationAddress1 | String | True |
The first line of the address of the destination. | |
| DestinationAddress2 | String | True |
The second line of the address of the destination. | |
| DestinationCity | String | True |
The city of the destination. | |
| DestinationCompany | String | True |
The company of the destination. | |
| DestinationEmail | String | True |
The email of the customer at the destination. | |
| DestinationPhone | String | True |
The phone number of the customer at the destination. | |
| DestinationProvince | String | True |
The province of the destination. | |
| DestinationZip | String | True |
The ZIP code of the destination. | |
| DestinationCountryCode | String | True |
The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | True |
The method of duties payment. Example values: 'DDP', 'DAP'. | |
| OrderId | String | True |
A globally-unique ID. |
Fulfillments
Fulfillment represents a shipment of one or more items in an order.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderIdcolumn, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Fulfillments WHERE OrderId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentCreateV2' GraphQL mutation.
The following columns can be used to create a new record:
OriginAddressAddress1, OriginAddressAddress2, OriginAddressCity, OriginAddressCountryCode, OriginAddressProvinceCode, OriginAddressZip, TrackingInfoNumber, TrackingInfoUrl, FulfillmentOrderIds
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Globally unique identifier. | |
| Name | String | True |
Human readable reference identifier for this fulfillment. | |
| Status | String | True |
The status of the fulfillment. | |
| DeliveredAt | Datetime | True |
The date that this fulfillment was delivered. | |
| DisplayStatus | String | True |
Human readable display status for this fulfillment. | |
| RequiresShipping | Bool | True |
Whether any of the line items in the fulfillment require shipping. | |
| TotalQuantity | Int | True |
Sum of all line item quantities for the fulfillment. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated date that this fulfillment will arrive. | |
| InTransitAt | Datetime | True |
The date and time when the fulfillment went into transit. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LocationId | String | True |
A globally-unique ID. | |
| ServiceId | String | True |
The ID of the fulfillment service. | |
| OriginAddressAddress1 | String | True |
The street address of the fulfillment location. | |
| OriginAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| OriginAddressCity | String | True |
The city in which the fulfillment location is located. | |
| OriginAddressCountryCode | String | True |
The country code of the fulfillment location. | |
| OriginAddressProvinceCode | String | True |
The province code of the fulfillment location. | |
| OriginAddressZip | String | True |
The zip code of the fulfillment location. | |
| TrackingInfoNumber | String | True |
TrackingInfoNumber | |
| TrackingInfoUrl | String | True |
TrackingInfoUrl |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FulfillmentOrderIds | String |
An aggregated object containing the FulfillmentOrder ids. Ex: [{'fulfillmentOrderId': 'gid://shopify/FulfillmentOrder/xxx'}] |
FulfillmentServices
Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'fulfillmentServiceCreate' GraphQL mutation.
The following columns can be used to create a new record:
ServiceName, InventoryManagement, FulfillmentOrdersOptIn, CallbackUrl
UPDATE
UPDATE statements are mapped to the 'fulfillmentServiceUpdate' GraphQL mutation.
The following columns can be updated:
ServiceName, FulfillmentOrdersOptIn, CallbackUrl
DELETE
DELETE statements are mapped to the 'fulfillmentServiceDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the fulfillment service. | |
| ServiceName | String | False |
The name of the fulfillment service as seen by merchants. | |
| Handle | String | True |
Human-readable unique identifier for this fulfillment service. | |
| Type | String | True |
Type associated with the fulfillment service. | |
| CallbackUrl | String | False |
The callback URL the fulfillment service has registered for requests. | |
| InventoryManagement | Bool | True |
Whether the fulfillment service tracks product inventory and provides updates to Shopify. | |
| ProductBased | Bool | True |
Whether the fulfillment service supports local deliveries. | |
| PermitsSkuSharing | Bool | True |
Whether the fulfillment service can stock inventory alongside other locations. | |
| FulfillmentOrdersOptIn | Bool | False |
Whether the fulfillment service has opted into fulfillment order based requests. | |
| LocationId | String | True |
Globally unique identifier. |
FulfillmentTrackingInfo
Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentTrackingInfo WHERE FulfillmentId='VALUE'
UPDATE
UPDATE statements are mapped to the 'fulfillmentTrackingInfoUpdateV2' GraphQL mutation.
The following columns can be updated:
FulfillmentId, Company, Number, Url
Columns
| Name | Type | ReadOnly | References | Description |
| FulfillmentId [KEY] | String | True |
Fulfillments.Id |
The ID of the Fulfillment to return. |
| Company | String | False |
The name of the tracking company. | |
| Number | String | False |
The tracking number of the fulfillment. | |
| Url | String | False |
The URLs to track the fulfillment. |
GiftCards
Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription)
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExpiresOn supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InitialValueAmount supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM GiftCards WHERE Id='VALUE'
SELECT * FROM GiftCards WHERE ExpiresOn<'2000-01-01'
SELECT * FROM GiftCards WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM GiftCards WHERE InitialValueAmount<'100.000000'
Insert
INSERT statements are mapped to the 'giftCardCreate' GraphQL mutation.
The following columns can be used to create a new record:
Note, ExpiresOn, InitialValueAmount, CustomerId
UPDATE
UPDATE statements are mapped to the 'giftCardUpdate' GraphQL mutation.
The following columns can be updated:
Note, ExpiresOn, CustomerId
DELETE
DELETE statements are mapped to the 'giftCardDisable' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Enabled | Bool | True |
Whether the gift card is enabled. | |
| Note | String | False |
The note associated with the gift card, which is not visible to the customer. | |
| DisabledAt | Datetime | True |
The date and time at which the gift card was disabled. | |
| ExpiresOn | Date | False |
The date at which the gift card will expire. | |
| LastCharacters | String | True |
The final four characters of the gift card code. | |
| MaskedCode | String | True |
The gift card code. Everything but the final four characters is masked. | |
| CreatedAt | Datetime | True |
The date and time at which the gift card was created. | |
| BalanceAmount | Decimal | True |
Decimal money amount. | |
| BalanceCurrencyCode | String | True |
Currency of the money. | |
| InitialValueAmount | Decimal | True |
Decimal money amount. | |
| InitialValueCurrencyCode | String | True |
Currency of the money. | |
| CustomerId | String | False |
A globally-unique ID. | |
| OrderId | String | True |
A globally-unique ID. |
InventoryItems
Returns a list of inventory items.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Sku supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM InventoryItems
SELECT * FROM InventoryItems WHERE Id = 'Val1'
SELECT * FROM InventoryItems WHERE Sku = 'Val1'
SELECT * FROM InventoryItems WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM InventoryItems WHERE UpdatedAt = '2023-01-01 11:10:00'
Update
Update statements are mapped to the 'inventoryItemUpdate' GraphQL mutation.
The following columns can be updated:
Id, Tracked, HarmonizedSystemCode, CountryCodeOfOrigin, ProvinceCodeOfOrigin, UnitCostAmount
The following pseudo-columns can be updated:
InventoryItemCountryHarmonizedSystemCodes
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| VariantId | String | True |
A globally-unique ID. | |
| Sku | String | True |
Inventory item SKU. | |
| Tracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| LocationsCount | Int | True |
The number of locations where this inventory item is stocked. | |
| RequiresShipping | Bool | True |
Whether the inventory item requires shipping. | |
| DuplicateSkuCount | Int | True |
The number of inventory items that share the same SKU with this item. | |
| HarmonizedSystemCode | String | False |
The harmonized system code of the item. | |
| InventoryHistoryUrl | String | True |
The URL that points to the inventory history for the item. | |
| CountryCodeOfOrigin | String | False |
The ISO 3166-1 alpha-2 country code of where the item originated from. | |
| ProvinceCodeOfOrigin | String | False |
The ISO 3166-2 alpha-2 province code of where the item originated from. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was updated. | |
| TrackedEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| TrackedEditableReason | String | True |
The reason the attribute is locked for editing. | |
| UnitCostAmount | Decimal | False |
Decimal money amount. | |
| UnitCostCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| InventoryItemCountryHarmonizedSystemCodes | String |
List of country-specific harmonized system codes. |
Metafields
Retrieves a list of metafields that belong to one or many resource IDs.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=' comparison operator.
- OwnerId supports the '=,IN' comparison operators.
- OwnerResource supports the '=' comparison operator.
OwnerResource is a required column, and eligible values include "product","variant","shop","draft_order","order","customer","collection".
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND Id = 'gid://shopify/Metafield/19334473318423'
SELECT * FROM Metafields WHERE OwnerId = 'gid://shopify/ProductVariant/39378393497623' AND OwnerResource = 'variant'
SELECT * FROM Metafields WHERE OwnerId IN ('gid://shopify/ProductVariant/39378393497623', 'gid://shopify/Product/1418248224791') AND OwnerResource = 'variant'
Insert
INSERT statements are mapped to the 'metafieldsSet' GraphQL mutation.
The following columns can be used to create a new record:
Namespace, Key, Value, Type, OwnerId
DELETE
DELETE statements are mapped to the 'metafieldDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique ID of the metafield. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Namespace | String | True |
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. | |
| Key | String | True |
The name of the metafield. | |
| Value | String | True |
The information to be stored as metadata. | |
| Type | String | True |
The metafield's information type. | |
| Description | String | True |
A description of the information that the metafield contains. | |
| OwnerId | String | True |
The ID of the resource that the metafield is attached to. | |
| OwnerResource | String | True |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time when the metafield was last updated. |
Orders
Retrieves a list of orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- Email supports the '=,!=' comparison operators.
- Test supports the '=,!=' comparison operators.
- DiscountCode supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- RiskLevel supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = 'gid://shopify/Order/232220695'
SELECT * FROM Orders WHERE Id IN ('gid://shopify/Order/232220695', 'gid://shopify/Order/23220695')
SELECT * FROM Orders WHERE Name='VALUE'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId != 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Test = true
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel = 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel != 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email = '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email != '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode = 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode != 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt = '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt != '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt <= '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt >= '2022-01-18 02:32:26.0' AND UpdatedAt <= '2022-05-10 07:52:22.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt >= '2017-09-19 06:10:39.0' AND ProcessedAt <= '2021-10-07 23:45:38.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt >= '2017-09-19 06:10:39.0' AND CreatedAt <= '2021-10-07 23:45:38.0'
UPDATE
UPDATE statements are mapped to the 'orderUpdate' GraphQL mutation.
The following columns can be updated:
Email, Note, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Unpaid | Bool | True |
Whether no payments have been made for the order. | |
| FullyPaid | Bool | True |
Whether the order has been paid in full. | |
| SourceIdentifier | String | True |
A unique POS or third party order identifier. For example, '1234-12-1000' or '111-98567-54'. The 'receipt_number' field is derived from this value for POS orders. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| CanMarkAsPaid | Bool | True |
Whether the order can be manually marked as paid. | |
| Name | String | True |
The unique identifier for the order that appears on the order page in the Shopify admin and the order status page. For example, '#1001', 'EN1001', or '1001-A'. This value isn't unique across multiple stores. | |
| PaymentGatewayNames | String | True |
A list of the names of all payment gateways used for the order. For example, 'Shopify Payments' and 'Cash on Delivery (COD)'. | |
| Capturable | Bool | True |
Whether payment for the order can be captured. | |
| Closed | Bool | True |
Whether the order is closed. | |
| Confirmed | Bool | True |
Whether inventory has been reserved for the order. | |
| Edited | Bool | True |
Whether the order has had any edits applied. | |
| String | False |
The email address associated with the customer. | ||
| Fulfillable | Bool | True |
Whether there are line items that can be fulfilled. This field returns 'false' when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the object. | |
| Note | String | False |
The contents of the note associated with the order. | |
| Phone | String | True |
The phone number associated with the customer. | |
| Refundable | Bool | True |
Whether the order can be refunded. | |
| Restockable | Bool | True |
Whether any line item on the order can be restocked. | |
| Tags | String | True |
A comma separated list of tags associated with the order. Updating 'tags' overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the mutation. | |
| Test | Bool | True |
Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order cannot be converted into a real order and vice versa. | |
| CancelReason | String | True |
The reason provided when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| ClientIp | String | True |
The IP address of the API client that created the order. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. Returns 'null' if the order is not closed. | |
| CurrencyCode | String | True |
The shop currency when the order was placed. | |
| CustomerLocale | String | True |
A two-letter or three-letter language code, optionally followed by a region modifier. | |
| DiscountCode | String | True |
The discount code used for the order. | |
| DiscountCodes | String | True |
The discount codes used for the order. | |
| EstimatedTaxes | Bool | True |
Whether taxes on the order are estimated. This field returns 'false' when taxes on the order are finalized and aren't subject to any changes. | |
| MerchantEditable | Bool | True |
Whether the order can be edited by the merchant. For example, canceled orders can't be edited. | |
| ProcessedAt | Datetime | True |
The date and time when the order was processed. This date and time might not match the date and time when the order was created. | |
| RequiresShipping | Bool | True |
Whether the order has shipping lines or at least one line item on the order that requires shipping. | |
| ReturnStatus | String | True |
The order's aggregated return status for display purposes. | |
| RiskLevel | String | True |
The fraud risk level of the order. | |
| TaxesIncluded | Bool | True |
Whether taxes are included in the subtotal price of the order. | |
| TotalWeight | String | True |
The total weight of the order before returns, in grams. | |
| CanNotifyCustomer | Bool | True |
Whether a customer email exists for the order. | |
| CurrentTotalWeight | String | True |
The total weight of the order after returns, in grams. | |
| CustomerAcceptsMarketing | Bool | True |
Whether the customer agreed to receive marketing materials. | |
| DisplayFinancialStatus | String | True |
The financial status of the order that can be shown to the merchant. This field does not capture all the details of an order's financial state. It should only be used for display summary purposes. | |
| DisplayFulfillmentStatus | String | True |
The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the object. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the order. | |
| MerchantEditableErrors | String | True |
A list of reasons why the order can't be edited. For example, 'Canceled orders can't be edited'. | |
| PresentmentCurrencyCode | String | True |
The payment 'CurrencyCode' of the customer for the order. | |
| RegisteredSourceUrl | String | True |
The URL of the source that the order originated from, if found in the domain registry. | |
| SubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's subtotal price. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CurrentSubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's current subtotal price. | |
| CreatedAt | Datetime | True |
Date and time when the order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the order was modified last. | |
| AppId | String | True |
The application ID. | |
| MerchantOfRecordAppId | String | True |
The application ID. | |
| PhysicalLocationId | String | True |
A globally-unique ID. | |
| ChannelInformationId | String | True |
A globally-unique ID. | |
| ChannelInformationChannelId | String | True |
The unique ID for the channel. | |
| ChannelInformationAppId | String | True |
A globally-unique ID. | |
| PublicationId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | True |
A globally-unique ID. | |
| CustomerFirstName | String | True |
The customer's first name. | |
| CustomerLastName | String | True |
The customer's last name. | |
| CustomerJourneySummaryReady | Bool | True |
Whether the attributed sessions for the order have been created yet. | |
| CustomerJourneySummaryMomentsCount | Int | True |
The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. | |
| CustomerJourneySummaryCustomerOrderIndex | Int | True |
The position of the current order within the customer's order history. Test orders aren't included. | |
| CustomerJourneySummaryDaysToConversion | Int | True |
The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. | |
| CustomerJourneySummaryFirstVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryFirstVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryFirstVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryFirstVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryFirstVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryFirstVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryFirstVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryFirstVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryFirstVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryFirstVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| CustomerJourneySummaryLastVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryLastVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryLastVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryLastVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryLastVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryLastVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryLastVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryLastVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryLastVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryLastVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| DisplayAddressId | String | True |
A globally-unique ID. | |
| DisplayAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DisplayAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DisplayAddressFirstName | String | True |
The first name of the customer. | |
| DisplayAddressLastName | String | True |
The last name of the customer. | |
| DisplayAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| DisplayAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DisplayAddressCity | String | True |
The name of the city, district, village, or town. | |
| DisplayAddressCompany | String | True |
The name of the customer's company or organization. | |
| DisplayAddressCountry | String | True |
The name of the country. | |
| DisplayAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DisplayAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DisplayAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DisplayAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| DisplayAddressZip | String | True |
The zip or postal code of the address. | |
| DisplayAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DisplayAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| DisplayAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | True |
The first name of the customer. | |
| BillingAddressLastName | String | True |
The last name of the customer. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | True |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsDraftOrderId | String | True |
A globally-unique ID. | |
| CartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| ChannelInformationChannelDefinitionId | String | True |
The unique ID for the channel definition. | |
| CurrentCartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentCartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| PaymentCollectionDetailsAdditionalPaymentCollectionUrl | String | True |
The URL to use for collecting an additional payment on the order. | |
| RefundDiscrepancySetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| RefundDiscrepancySetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
OrderTransactions
Retrieves the transactions associated with the resource.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTransactions WHERE ResourceId='VALUE'
Insert
INSERT statements are mapped to the 'orderCapture' GraphQL mutation.
The following columns can be used to create a new record:
ResourceId, ParentTransactionId, Amount, Currency
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ResourceId [KEY] | String | True |
Orders.Id |
A globally-unique ID. |
| PaymentId | String | True |
The payment ID associated with the transaction. | |
| ParentTransactionId | String | True |
The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | True |
The masked account number associated with the payment method. | |
| Gateway | String | True |
The payment gateway used to process the transaction. | |
| Kind | String | True |
The kind of transaction. | |
| Status | String | True |
The status of this transaction. | |
| Test | Bool | True |
Whether the transaction is a test transaction. | |
| AuthorizationCode | String | True |
Authorization code associated with the transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | True |
The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | True |
Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | True |
Date and time when the transaction was processed. | |
| ReceiptJson | String | True |
The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | True |
The settlement currency. | |
| AuthorizationExpiresAt | Datetime | True |
The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | True |
The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | True |
Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | True |
The holder of the credit card. | |
| CardPaymentDetailsBin | String | True |
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. | |
| CardPaymentDetailsCompany | String | True |
The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | True |
The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | True |
Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | True |
The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | True |
The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | True |
The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | True |
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. | |
| PaymentIconId | String | True |
A unique ID for the image. | |
| PaymentIconWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | True |
Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | True |
Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | True |
The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | True |
The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | True |
The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Amount | Decimal |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
| Currency | String |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
PriceLists
All price lists for a shop.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Currency | String | False |
The currency for fixed prices associated with this price list. | |
| FixedPricesCount | Int | True |
The number of fixed prices on the price list. | |
| Name | String | False |
The unique name of the price list, used as a human-readable identifier. | |
| ParentAdjustmentType | String | False |
The type of price adjustment, such as percentage increase or decrease. | |
| ParentAdjustmentValue | Double | False |
The value of price adjustment, where positive numbers reduce the prices and negative numbers increase them. | |
| ParentSettingsCompareAtMode | String | False |
The type of price list adjustment setting for compare at price. |
ProductImages
Returns the images associated with the product.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- ProductId supports the '=' comparison operator.
SELECT * FROM ProductImages WHERE ProductId='VALUE'
Insert
INSERT statements are mapped to the 'productAppendImages' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, AltText, Url
UPDATE
UPDATE statements are mapped to the 'productImageUpdate' GraphQL mutation.
The following columns can be updated:
ProductId, AltText, Url
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the image. | |
| ProductId [KEY] | String | True |
Products.Id |
A globally-unique identifier. |
| AltText | String | False |
A word or phrase to share the nature or contents of an image. | |
| Height | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Width | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Url | String | False |
The location of the image as a URL. |
ProductResourceFeedbacks
Returns the product resource feedback for the currently authenticated app.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductResourceFeedbacks WHERE Id='VALUE'
Insert
INSERT statements are mapped to the 'bulkProductResourceFeedbackCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, FeedbackGeneratedAt, Messages, ProductUpdatedAt, State
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | String | True |
Products.Id |
The product associated with the resource feedback. |
| FeedbackGeneratedAt | Datetime | True |
The time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. | |
| Messages | String | True |
The feedback messages presented to the merchant. | |
| ProductUpdatedAt | Datetime | True |
The timestamp of the product associated with the feedback. | |
| State | String | True |
Conveys the state of the feedback and whether it requires merchant action or not. |
Products
Returns a list of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- ProductType supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- Vendor supports the '=,!=' comparison operators.
- TotalInventory supports the '=,!=,<,>,>=,<=' comparison operators.
- HasOnlyDefaultVariant supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Products WHERE Id='VALUE'
SELECT * FROM Products WHERE Title='VALUE'
SELECT * FROM Products WHERE ProductType='VALUE'
SELECT * FROM Products WHERE Status='VALUE'
SELECT * FROM Products WHERE Vendor='VALUE'
SELECT * FROM Products WHERE TotalInventory<'100'
SELECT * FROM Products WHERE HasOnlyDefaultVariant='true'
SELECT * FROM Products WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Products WHERE CreatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'productCreate' GraphQL mutation.
The following columns can be used to create a new record:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, IsGiftCard, SeoTitle, SeoDescription
The following pseudo-columns can be used to create a new record:
VariantPrice, VariantTaxable, VariantRequiresShipping
UPDATE
UPDATE statements are mapped to the 'productUpdate' GraphQL mutation.
The following columns can be updated:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, SeoTitle, SeoDescription
The following pseudo-columns can be updated:
VariantPrice, VariantTaxable, VariantRequiresShipping
DELETE
DELETE statements are mapped to the 'productDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Description | String | True |
The description of the product, complete with HTML formatting. | |
| DescriptionHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Title | String | False |
The title of the product. | |
| Handle | String | False |
A unique human-friendly string of the product's title. | |
| ProductType | String | False |
The product type specified by the merchant. | |
| Tags | String | False |
A comma separated list of tags associated with the product. Updating 'tags' overwrites any existing tags that were previously added to the product. | |
| Status | String | False |
The product status. This controls visibility across all channels. | |
| Vendor | String | False |
The name of the product's vendor. | |
| OnlineStorePreviewUrl | String | True |
The online store preview URL. | |
| OnlineStoreUrl | String | True |
The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel. | |
| RequiresSellingPlan | Bool | False |
Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription ('requiresSellingPlan: true') can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store. | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product. | |
| TracksInventory | Bool | True |
Whether inventory tracking has been enabled for the product. | |
| TotalInventory | Int | True |
The quantity of inventory in stock. | |
| HasOnlyDefaultVariant | Bool | True |
Whether the product has only a single variant with the default option and value. | |
| HasOutOfStockVariants | Bool | True |
Whether the product has out of stock variants. | |
| TotalVariants | Int | True |
The number of variants that are associated with the product. | |
| TemplateSuffix | String | True |
The theme template used when viewing the product in a store. | |
| GiftCardTemplateSuffix | String | False |
The theme template used when viewing the gift card in a store. | |
| IsGiftCard | Bool | True |
Whether the product is a gift card. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified.A product's 'updatedAt' value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| PriceRangeMaxVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMaxVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| PriceRangeMinVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMinVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| SeoTitle | String | False |
SEO Title. | |
| SeoDescription | String | False |
SEO Description. | |
| MediaCount | Int | True |
Total count of media belonging to a product. | |
| FeaturedImageId | String | True |
A unique identifier for the image. | |
| FeaturedImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| FeaturedImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageUrl | String | True |
The location of the image as a URL. | |
| ResourcePublicationOnCurrentPublicationIsPublished | Bool | True |
Whether the resource publication is published. If true, then the resource publication is published to the publication. If false, then the resource publication is staged to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublishDate | Datetime | True |
The date that the resource publication was or is going to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationId | String | True |
A globally-unique identifier. | |
| ResourcePublicationOnCurrentPublicationPublicationName | String | True |
Name of the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| ProductCategoryProductTaxonomyNodeId | String | True |
The ID of the product taxonomy node. | |
| ProductCategoryProductTaxonomyNodeName | String | True |
The name of the product taxonomy node. For example, Dog Beds. | |
| ProductCategoryProductTaxonomyNodeFullName | String | True |
The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. | |
| ProductCategoryProductTaxonomyNodeIsLeaf | Bool | True |
Whether the node is a leaf node. | |
| ProductCategoryProductTaxonomyNodeIsRoot | Bool | True |
Whether the node is a root node. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| VariantPrice | Double |
The price of the variant. |
| VariantTaxable | Bool |
Whether the variant is taxable. |
| VariantRequiresShipping | Bool |
Whether the variant requires shipping. |
ProductVariants
Returns a list of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ProductId supports the '=,!=' comparison operators.
- Title supports the '=,!=' comparison operators.
- Barcode supports the '=,!=' comparison operators.
- Sku supports the '=,!=' comparison operators.
- Taxable supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InventoryQuantity supports the '=,!=,<,>,>=,<=' comparison operators.
- DeliveryProfileId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductVariants WHERE Id = 'gid://shopify/ProductVariant/6788079091735'
SELECT * FROM ProductVariants WHERE Id IN ('gid://shopify/ProductVariant/6830135181335', 'gid://ProductVariant/Product/6830135181336')
SELECT * FROM ProductVariants WHERE ProductId='VALUE'
SELECT * FROM ProductVariants WHERE Title='VALUE'
SELECT * FROM ProductVariants WHERE Barcode='VALUE'
SELECT * FROM ProductVariants WHERE Sku='VALUE'
SELECT * FROM ProductVariants WHERE Taxable='true'
SELECT * FROM ProductVariants WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE InventoryQuantity<'100'
SELECT * FROM ProductVariants WHERE DeliveryProfileId='VALUE'
Insert
INSERT statements are mapped to the 'productVariantCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
UPDATE
UPDATE statements are mapped to the 'productVariantUpdate' GraphQL mutation.
The following columns can be updated:
Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
DELETE
DELETE statements are mapped to the 'productVariantDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| ProductId | String | True |
Products.Id |
A globally-unique identifier. |
| Position | Int | False |
The order of the product variant in the list of product variants. The first position in the list is 1. | |
| AvailableForSale | Bool | True |
Whether the product variant is available for sale. | |
| SellableOnlineQuantity | Int | True |
The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture (limitations based on customer location). | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product variant. | |
| Price | Decimal | False |
The price of the product variant in the default shop currency. | |
| CompareAtPrice | Decimal | False |
The compare-at price of the variant in the default shop currency. | |
| DisplayName | String | True |
Display name of the variant, based on product's title + variant's title. | |
| Barcode | String | False |
The value of the barcode associated with the product. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified with weight_unit. | |
| WeightUnit | String | False |
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', 'lb'. | |
| Sku | String | False |
An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. | |
| Title | String | False |
The title of the product variant. | |
| Taxable | Bool | False |
Whether a tax is charged when the product variant is sold. | |
| TaxCode | String | False |
The tax code for the product variant. | |
| UpdatedAt | Datetime | True |
The date and time when the product variant was last modified. | |
| CreatedAt | Datetime | True |
The date and time when the variant was created. | |
| InventoryPolicy | String | False |
Whether customers are allowed to place an order for the product variant when it's out of stock. | |
| InventoryQuantity | Int | True |
The total sellable quantity of the variant. | |
| InventoryItemId | String | True |
A globally-unique identifier. | |
| InventoryItemTracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| ImageId | String | False |
A unique identifier for the image. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| DeliveryProfileId | String | True |
A globally-unique identifier. | |
| FulfillmentServiceEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| FulfillmentServiceEditableReason | String | True |
The reason the attribute is locked for editing. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Options | String |
The custom properties that a shop owner uses to define product variants. |
Publications
Returns the list of publications.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- CatalogType supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Publications WHERE Id='VALUE'
SELECT * FROM Publications WHERE CatalogType='VALUE'
Insert
INSERT statements are mapped to the 'publicationCreate' GraphQL mutation.
The following columns can be used to create a new record:
AutoPublish, CatalogId, DefaultState
UPDATE
UPDATE statements are mapped to the 'publicationUpdate' GraphQL mutation.
The following columns can be updated:
AutoPublish, PublishablesToAdd, PublishablesToRemove
DELETE
DELETE statements are mapped to the 'publicationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AutoPublish | Bool | False |
Whether new products are automatically published to this publication. | |
| SupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| CatalogId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationStatus | String | True |
The status of this operation. | |
| AddAllProductsOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| AddAllProductsOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| AddAllProductsOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogCsvOperationId | String | True |
A globally-unique ID. | |
| CatalogCsvOperationStatus | String | True |
The status of this operation. | |
| CatalogCsvOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| CatalogCsvOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| CatalogCsvOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| PublicationResourceOperationId | String | True |
A globally-unique ID. | |
| PublicationResourceOperationStatus | String | True |
The status of this operation. | |
| PublicationResourceOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| PublicationResourceOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| PublicationResourceOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogType | String | True |
Filter publications by catalog type. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DefaultState | String |
Whether to create an empty publication or prepopulate it with all products. |
| PublishablesToAdd | String |
A simple, comma-separated list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50. |
| PublishablesToRemove | String |
A simple, comma-separated list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50. |
Refunds
Represents a refund of items or transactions in an order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrderId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Refunds
SELECT * FROM Refunds WHERE OrderId = 'Val1'
Insert
Insert statements are mapped to the 'refundCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrderId, Note
The following pseudo-columns can be used to create a new record:
RefundLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Orders.Id |
A globally-unique ID. |
| Note | String | True |
The optional note associated with the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| UpdatedAt | Datetime | True |
The date and time when the refund was updated. | |
| ReturnId | String | True |
A globally-unique ID. | |
| StaffMemberId | String | True |
A globally-unique ID.(This column is available only with a ShopifyPlus subscription) | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| RefundLineItems | String |
The list of the line items in the draft order. |
Returns
Retrieves a list of returns for the order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrdersId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Returns
SELECT * FROM Returns WHERE OrdersId = 'Val1'
Insert
Insert statements are mapped to the 'returnCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrdersId
The following pseudo-columns can be used to create a new record:
ReturnLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| OrdersId | String | True |
Orders.Id |
A globally-unique ID. |
| Name | String | True |
The name of the return. | |
| Status | String | True |
The status of the return. | |
| TotalQuantity | Int | True |
The sum of all line item quantities for the return. | |
| DeclineReason | String | True |
The reason the customer's return request was declined. | |
| DeclineNote | String | True |
The notification message sent to the customer about their declined return request. Maximum length: 500 characters. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| ReturnLineItems | String |
The list of the line items in the return. |
ScriptTags
Returns a list of script tags.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Src supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ScriptTags WHERE Id='VALUE'
SELECT * FROM ScriptTags WHERE Src='VALUE'
Insert
INSERT statements are mapped to the 'scriptTagCreate' GraphQL mutation.
The following columns can be used to create a new record:
Cache, Src, DisplayScope
UPDATE
UPDATE statements are mapped to the 'scriptTagUpdate' GraphQL mutation.
The following columns can be updated:
Cache, Src, DisplayScope
DELETE
DELETE statements are mapped to the 'scriptTagDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. If 'true', then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If 'false', then the script will be served as is. | |
| Src | String | False |
The URL to the remote script. | |
| DisplayScope | String | False |
The page or pages on the online store that the script should be included. | |
| CreatedAt | Datetime | True |
The date and time when the script tag was created. | |
| UpdatedAt | Datetime | True |
The date and time when the script tag was last updated. |
SellingPlanGroups
Returns a list Selling Plan Groups.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- CreatedAt supports the '<,>,>=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM SellingPlanGroups
SELECT * FROM SellingPlanGroups WHERE Id = 'Val1'
SELECT * FROM SellingPlanGroups WHERE Name = 'Val1'
SELECT * FROM SellingPlanGroups WHERE CreatedAt < '2023-01-01 11:10:00'
Insert
Insert statements are mapped to the 'sellingPlanGroupCreate' GraphQL mutation.
The following columns can be used to create a new record:
AppId, Name, Description, Options, Position, MerchantCode
The following pseudo-columns can be used to create a new record:
SellingPlansToCreate, ProductIds, ProductVariantIds
Update
Update statements are mapped to the 'sellingPlanGroupUpdate' GraphQL mutation.
The following columns can be updated:
Id, AppId, Name, Description, Options, Position, MerchantCode
The following pseudo-columns can be updated:
SellingPlansToCreate, SellingPlansToUpdate, SellingPlansToDelete
Delete
Delete statements are mapped to the 'sellingPlanGroupDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppId | String | False |
The ID for app, exposed in Liquid and product JSON. | |
| Name | String | False |
The buyer-facing label of the selling plan group. | |
| Description | String | False |
The merchant-facing description of the selling plan group. | |
| Options | String | False |
The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | False |
The relative position of the selling plan group for display. | |
| Summary | String | True |
A summary of the policies associated to the selling plan group. | |
| MerchantCode | String | False |
The merchant-facing label of the selling plan group. | |
| ProductCount | Int | True |
A count of products associated to the selling plan group. | |
| CreatedAt | Datetime | True |
The date and time when the selling plan group was created. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| SellingPlansToCreate | String |
List of selling plans to create. |
| SellingPlansToUpdate | String |
List of selling plans to update. |
| SellingPlansToDelete | String |
List of selling plans to delete as a simple, comma-separated list. |
| ProductIds | String |
The IDs of the Products to add to the Selling Plan Group as a simple, comma-separated list. |
| ProductVariantIds | String |
The IDs of the Variants to add to the Selling Plan Group as a simple, comma-separated list. |
StorefrontAccessTokens
Retrieves the storefront access token of a private application. These are scoped per-application.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'storefrontAccessTokenCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title
DELETE
DELETE statements are mapped to the 'storefrontAccessTokenDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ShopId | String | True |
Shop.Id |
A globally-unique ID. |
| Title | String | True |
An arbitrary title for each token determined by the developer, used for reference purposes. | |
| AccessToken | String | True |
The issued public access token. | |
| CreatedAt | Datetime | True |
The date and time when the public access token was created. | |
| UpdatedAt | Datetime | True |
The date and time when the storefront access token was updated. |
UrlRedirects
Returns a list of redirects for a shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Path supports the '=,!=' comparison operators.
- Target supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM UrlRedirects WHERE Id='VALUE'
SELECT * FROM UrlRedirects WHERE Path='VALUE'
SELECT * FROM UrlRedirects WHERE Target='VALUE'
Insert
INSERT statements are mapped to the 'urlRedirectCreate' GraphQL mutation.
The following columns can be used to create a new record:
Path, Target
UPDATE
UPDATE statements are mapped to the 'urlRedirectUpdate' GraphQL mutation.
The following columns can be updated:
Path, Target
DELETE
DELETE statements are mapped to the 'urlRedirectDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the URL redirect. | |
| Path | String | False |
The old path to be redirected from. When the user visits this path, they will be redirected to the target location. | |
| Target | String | False |
The target location where the user will be redirected to. |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| Abandonment | Returns abandonment. |
| AbandonmentProductsAddedToCart | Returns the products added to the cart during the customer abandoned visit. |
| AbandonmentProductsViewed | Returns the products viewed during the customer abandoned visit. |
| AppCredits | Lists credits that can be used towards future app purchases. |
| ArticleComments | Returns a list of comments posted on an article. |
| Articles | Returns a list of the shop's visible articles. |
| AssignedFulfillmentOrders | Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default. |
| Blogs | Retrieves a list of the shop's blogs. |
| CarrierServices | Returns a list of activated carrier services and associated shop locations that support them. |
| CollectionProducts | Retrieves a list of the products inside of a collection. |
| CompanyEvents | Retrieves a paginated list of events associated with the host subject. |
| CustomerEvents | Retrieves a paginated list of events associated with the host subject. |
| DeliveryProfileLocationGroupCountries | Lists countries already selected in any zone for the specified location group. |
| DeliveryProfileLocationGroupCountryProvinces | Returns the list of regions associated with this country. |
| DeliveryProfileLocationGroups | Lists the location groups using this profile. |
| DeliveryProfileLocationGroupZones | Lists the applicable zones associated to the specified location group. |
| DeliveryProfileUnassignedLocations | Lists the locations that have not been assigned to a location group for this profile. |
| DiscountEvents | Retrieves a paginated list of events associated with the host subject. |
| DiscountsCodeFreeShipping | Returns a list of discounts. |
| DraftOrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderEvents | Retrieves a paginated list of events associated with the host subject. |
| DraftOrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderLineItems | Returns a list of the line items in the draft order. |
| DraftOrderLineItemTaxLines | Represents a single tax applied to the associated resource. |
| DraftOrderTaxLines | Represents a single tax applied to the associated resource. |
| InventoryItemCountryHarmonizedSystemCodes | Returns a list of country specific harmonized system codes. |
| InventoryItemInventoryLevels | Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at. |
| Jobs | Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. |
| Locations | Returns a list of active inventory locations. |
| MarketingEvents | Returns a list of marketing events associated with the marketing app. |
| MetaobjectDefinitions | Provides the definition of a generic object structure composed of metafields. |
| MetaObjects | All metaobjects for the shop. |
| OrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderDiscountApplications | Returns a list of discounts that are applied to the order, not including order edits and refunds. |
| OrderEvents | Retrieves a paginated list of events associated with the host subject. |
| OrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderLineItemDiscountAllocations | Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds. |
| OrderLineItems | Retrieves a list of line items in the associated resource. |
| OrderNonFulfillableLineItems | Retrieves a list of line items in the associated resource. |
| OrderRisks | Lists the order risks associated with this order. |
| OrderTaxLines | Represents a single tax applied to the associated resource. |
| Pages | Returns a list of the shop's pages. |
| ProductOptions | Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. |
| PublicationCollections | Returns a list of collections published to the publication. |
| PublicationProducts | Returns the list of publication for products. |
| RefundDuties | Lists the refunded duties as part of this refund. |
| RefundLineItems | Retrieves the 'RefundLineItem' resources attached to the refund. |
| RefundTransactionFees | Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions. |
| RefundTransactions | Retrieves the transactions associated with the resource. |
| ReturnLineItems | Retrieves the return line items attached to the return. |
| SellingPlanGroupSellingPlans | Retrieves selling plans associated to the selling plan group. |
| Shop | Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop. |
| ShopifyPaymentsAccount | Returns Shopify Payments account information, including balances and payouts. |
| ShopifyPaymentsAccountBalance | Returns current balances in all currencies for the account. |
| ShopifyPaymentsAccountBankAccounts | Lists all bank accounts configured for the Shopify Payments account. |
| ShopifyPaymentsAccountDisputes | Lists all disputes related to the Shopify Payments account. |
| ShopifyPaymentsAccountPayouts | Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries. |
| ShopifyPaymentsAccountPermittedVerificationDocuments | Retrieves the permitted documents for identity verification. |
| ShopifyPaymentsAccountVerifications | Returns the verifications necessary for this account. |
| StaffMembers | Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription) |
| TenderTransactions | Returns a list of TenderTransactions associated with the shop. |
Abandonment
Returns abandonment.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- Id supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Abandonment WHERE Id='VALUE'
SELECT * FROM Abandonment WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppId | String | A globally-unique ID. | |
| CustomerId | String | A globally-unique ID. | |
| AbandonmentType | String | The abandonment type. | |
| EmailState | String | The email state (e.g., sent or not sent). | |
| InventoryAvailable | Bool | Whether the products in abandonment are available. | |
| EmailSentAt | Datetime | When the email was sent, if that is the case. | |
| MostRecentStep | String | The most recent step type. | |
| VisitStartedAt | Datetime | The date and time when the visit started. | |
| IsFromOnlineStore | Bool | Whether the abandonment event comes from the Online Store sales channel. | |
| IsFromShopApp | Bool | Whether the abandonment event comes from the Shop app sales channel. | |
| IsFromShopPay | Bool | Whether the abandonment event comes from Shop Pay. | |
| IsMostSignificantAbandonment | Bool | Whether the customer did not complete another most significant step since this abandonment. | |
| LastBrowseAbandonmentDate | Datetime | The date for the latest browse abandonment. | |
| LastCartAbandonmentDate | Datetime | The date for the latest cart abandonment. | |
| LastCheckoutAbandonmentDate | Datetime | The date for the latest checkout abandonment. | |
| DaysSinceLastAbandonmentEmail | Int | The number of days since the last abandonment email was sent to the customer. | |
| HoursSinceLastAbandonedCheckout | Double | The number of hours since the customer has last abandoned a checkout. | |
| CustomerHasNoOrderSinceAbandonment | Bool | Whether the customer has completed an order since this checkout has been abandoned. | |
| CreatedAt | Datetime | The date and time when the abandonment was created. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadDefaultCursor | String | A default cursor that returns the single next record, sorted ascending by ID. | |
| AbandonedCheckoutPayloadAbandonedCheckoutUrl | String | The URL for the buyer to recover their checkout. | |
| AbandonedCheckoutPayloadLineItemsQuantity | Int | The number of products in the checkout. |
AbandonmentProductsAddedToCart
Returns the products added to the cart during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AbandonmentProductsViewed
Returns the products viewed during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsViewed WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsViewed WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String |
Abandonment.Id | A globally-unique ID. |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId [KEY] | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AppCredits
Lists credits that can be used towards future app purchases.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppCredits WHERE AppInstallationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppInstallationId | String | A globally-unique ID. | |
| Description | String | The description of the app credit. | |
| Test | Bool | Whether the app credit is a test transaction. | |
| CreatedAt | Datetime | The date and time when the app credit was created. | |
| Amount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. |
ArticleComments
Returns a list of comments posted on an article.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ArticleId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ArticleComments WHERE ArticleId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ArticleId | String |
Articles.Id | A globally-unique ID. |
| ContentHtml | String | The content of the comment, complete with HTML formatting. | |
| AuthorName | String | The author's name. | |
| AuthorEmail | String | The author's email. |
Articles
Returns a list of the shop's visible articles.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AuthorV2Name supports the '=,!=' comparison operators.
- AuthorV2FirstName supports the '=,!=' comparison operators.
- AuthorV2LastName supports the '=,!=' comparison operators.
- BlogTitle supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Articles WHERE Id='VALUE'
SELECT * FROM Articles WHERE AuthorV2Name='VALUE'
SELECT * FROM Articles WHERE AuthorV2FirstName='VALUE'
SELECT * FROM Articles WHERE AuthorV2LastName='VALUE'
SELECT * FROM Articles WHERE BlogTitle='VALUE'
SELECT * FROM Articles WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Articles WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The article's name. | |
| Handle | String | A human-friendly unique string for the Article automatically generated from its title. | |
| Tags | String | A categorization that a article can be tagged with. | |
| ContentHtml | String | The content of the article, complete with HTML formatting. | |
| ExcerptHtml | String | The excerpt of the article, complete with HTML formatting. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| PublishedAt | Datetime | The date and time when the article was published. | |
| AuthorV2Name | String | The author's full name. | |
| AuthorV2FirstName | String | The author's first name. | |
| AuthorV2LastName | String | The author's last name. | |
| AuthorV2Bio | String | The author's bio. | |
| AuthorV2Email | String | The author's email. | |
| BlogId | String | A globally-unique ID. | |
| BlogTitle | String | The blogs's title. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the article was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the article was last updated. This column can only be used as an input for filtering. |
AssignedFulfillmentOrders
Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AssignedLocationLocationId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| OrderId | String | A globally-unique ID. | |
| Status | String | The status of the fulfillment order. | |
| FulfillAt | Datetime | The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| RequestStatus | String | The request status of the fulfillment order. | |
| CreatedAt | Datetime | Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | The date and time when the fulfillment order was last updated. | |
| AssignedLocationName | String | The name of the location. | |
| AssignedLocationAddress1 | String | The first line of the address for the location. | |
| AssignedLocationAddress2 | String | The second line of the address for the location. | |
| AssignedLocationCity | String | The city of the location. | |
| AssignedLocationPhone | String | The phone number of the location. | |
| AssignedLocationProvince | String | The province of the location. | |
| AssignedLocationZip | String | The ZIP code of the location. | |
| AssignedLocationCountryCode | String | The two-letter country code of the location. | |
| AssignedLocationLocationId | String | A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | The name of the location. | |
| AssignedLocationLocationActivatable | Bool | Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | A globally-unique ID. | |
| DeliveryMethodMethodType | String | The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | A globally-unique ID. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationEmail | String | The email of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| DestinationProvince | String | The province of the destination. | |
| DestinationZip | String | The ZIP code of the destination. | |
| DestinationCountryCode | String | The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | The method of duties payment. Example values: 'DDP', 'DAP'. |
Blogs
Retrieves a list of the shop's blogs.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Blogs WHERE Id='VALUE'
SELECT * FROM Blogs WHERE Title='VALUE'
SELECT * FROM Blogs WHERE Handle='VALUE'
SELECT * FROM Blogs WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Blogs WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The blogs's title. | |
| Handle | String | A human-friendly unique string for the Blog automatically generated from its title. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the blog was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the blog was last updated. This column can only be used as an input for filtering. |
CarrierServices
Returns a list of activated carrier services and associated shop locations that support them.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.
For example, the following queries are processed client-side:
SELECT * FROM CarrierServices WHERE Id = 'VALUE'
Columns
| Name | Type | References | Description |
| Id | String | A globally-unique ID. | |
| Name | String | The name of the shipping service provider. | |
| FormattedName | String | The properly formatted name of the shipping service provider, ready to display. | |
| IconAltText | String | A word or phrase to share the nature or contents of an image. | |
| IconHeight | Int | The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. | |
| IconId | String | A unique ID for the image. | |
| IconWidth | Int | The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. |
CollectionProducts
Retrieves a list of the products inside of a collection.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CollectionId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CollectionProducts WHERE CollectionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique identifier. | |
| CollectionId | String |
Collections.Id | A globally-unique identifier for the collection. |
| Title | String | The title of the product. | |
| Position | Int | The position in which the products are sorted. |
CompanyEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Companies.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
CustomerEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CustomerEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Customers.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DeliveryProfileLocationGroupCountries
Lists countries already selected in any zone for the specified location group.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| CountryId [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Zone | String | The name of the shipping zone. | |
| CountryName | String | The full name of the country. | |
| CountryTranslatedName | String | The translated name of the country. The translation returned is based on the system's locale. | |
| CountryCodeCountryCode | String | The country code in the ISO 3166-1 alpha-2 format. | |
| CountryCodeRestOfWorld | Bool | Whether the country is a part of the 'Rest of World' shipping zone. |
DeliveryProfileLocationGroupCountryProvinces
Returns the list of regions associated with this country.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| CountryId | String | A globally-unique ID. | |
| Code | String | The code of the region. | |
| Name | String | The full name of the region. | |
| TranslatedName | String | The translated name of the region. The translation returned is based on the system's locale. |
DeliveryProfileLocationGroups
Lists the location groups using this profile.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| LocationsCount | Int | A count of all locations that are part of this location group. |
DeliveryProfileLocationGroupZones
Lists the applicable zones associated to the specified location group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileLocationGroupZones WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | Filter the location groups of the profile by location group ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Name | String | The name of the zone. | |
| MethodDefinitionCountsParticipantDefinitionsCount | Int | The number of participant method definitions for the specified zone. | |
| MethodDefinitionCountsRateDefinitionsCount | Int | The number of merchant-defined method definitions for the specified zone. |
DeliveryProfileUnassignedLocations
Lists the locations that have not been assigned to a location group for this profile.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileUnassignedLocations WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| DeliveryProfileId [KEY] | String | A globally-unique ID. | |
| LocationId [KEY] | String |
Locations.Id | A globally-unique ID. |
DiscountEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DiscountEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String | A globally-unique ID. | |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DiscountsCodeFreeShipping
Returns a list of discounts.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeFreeShipping WHERE Title='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE StartsAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the discount. | |
| Status | String | The status of the discount. | |
| Summary | String | A detailed summary of the discount. | |
| CodeCount | Int | The number of redeem codes for the discount. | |
| DiscountClass | String | The class of the discount for combining purposes. | |
| EndsAt | Datetime | The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | A short summary of the discount. | |
| StartsAt | Datetime | The date and time when the discount starts. | |
| UsageLimit | Int | The maximum number of times that the discount can be used. | |
| AppliesOnSubscription | Bool | Whether the discount applies on subscription shipping lines. | |
| AsyncUsageCount | Int | The number of times that the discount has been used. | |
| HasTimelineComment | Bool | Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | Whether the discount can be applied only once per customer. | |
| AppliesOnOneTimePurchase | Bool | Whether the discount applies on regular one-time-purchase shipping lines. | |
| CreatedAt | Datetime | The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountCountriesCountries | String | The codes for the countries where the discount can be applied. | |
| DiscountCountriesIncludeRestOfWorld | Bool | Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. | |
| DiscountCountryAllAllCountries | Bool | Whether the discount can be applied to all countries as shipping destination. This value is always 'true'. | |
| MaximumShippingPriceAmount | Decimal | Decimal money amount. | |
| MaximumShippingPriceCurrencyCode | String | Currency of the money. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | Decimal money amount. | |
| TotalSalesCurrencyCode | String | Currency of the money. |
DraftOrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
DraftOrders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DraftOrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderLineItems
Returns a list of the line items in the draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DraftOrderId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItems WHERE DraftOrderId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DraftOrderId | String |
DraftOrders.Id | A globally-unique ID. |
| Name | String | The name of the product. | |
| Title | String | The title of the product or variant. This field only applies to custom line items. | |
| VariantTitle | String | The name of the variant. | |
| Custom | Bool | Whether the line item is a custom line item ('true') or a product variant line item ('false'). | |
| Quantity | Int | The number of product variants that are requested in the draft order. | |
| Sku | String | The SKU number of the product variant. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who created the product variant. | |
| DiscountedTotal | Decimal | The line item price after discounts are applied. | |
| OriginalTotal | Decimal | The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| TotalDiscount | Decimal | The total value of the discount that is applied to the line item. | |
| DiscountedUnitPrice | Decimal | The 'discountedTotal' divided by 'quantity', resulting in the value of the discount per unit. | |
| IsGiftCard | Bool | Whether the line item is a gift card. | |
| OriginalUnitPrice | Decimal | The variant price without any discounts applied. | |
| AppliedDiscountTitle | String | Name of the order-level discount. | |
| AppliedDiscountDescription | String | Description of the order-level discount. | |
| AppliedDiscountValue | Double | The order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount. | |
| AppliedDiscountValueType | String | Type of the order-level discount. | |
| AppliedDiscountAmountV2Amount | Decimal | Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ProductId | String | A globally-unique ID. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| VariantId | String | A globally-unique ID. | |
| WeightValue | Double | The weight value using the unit system specified with 'unit'. | |
| WeightUnit | String | The unit of measurement for 'value'. |
DraftOrderLineItemTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
DraftOrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
InventoryItemCountryHarmonizedSystemCodes
Returns a list of country specific harmonized system codes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemCountryHarmonizedSystemCodes WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| InventoryItemId | String | A globally-unique ID. | |
| CountryCode | String | The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. | |
| HarmonizedSystemCode [KEY] | String | The country-specific harmonized system code. These are usually longer than 6 digits. |
InventoryItemInventoryLevels
Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemInventoryLevels WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| InventoryItemId | String | A globally-unique ID. | |
| LocationId | String | A globally-unique ID. | |
| CanDeactivate | Bool | Whether the inventory items associated with the inventory level can be deactivated. | |
| DeactivationAlert | String | Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. | |
| CreatedAt | Datetime | The date and time when the inventory level was created. | |
| UpdatedAt | Datetime | The date and time when the inventory level was updated. |
Jobs
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Jobs WHERE Id='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID that's returned when running an asynchronous mutation. | |
| Done | Bool | This indicates if the job is still queued or has been run. |
Locations
Returns a list of active inventory locations.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- IsActive supports the '=,!=' comparison operators.
- AddressAddress1 supports the '=,!=' comparison operators.
- AddressAddress2 supports the '=,!=' comparison operators.
- AddressCity supports the '=,!=' comparison operators.
- AddressCountry supports the '!=' comparison operators.
- AddressProvince supports the '=,!=' comparison operators.
- AddressZip supports the '=,!=' comparison operators.
- IncludeInactive supports the '=' comparison operator.
- IncludeLegacy supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Locations WHERE Id='VALUE'
SELECT * FROM Locations WHERE Name='VALUE'
SELECT * FROM Locations WHERE IsActive='true'
SELECT * FROM Locations WHERE AddressAddress1='VALUE'
SELECT * FROM Locations WHERE AddressAddress2='VALUE'
SELECT * FROM Locations WHERE AddressCity='VALUE'
SELECT * FROM Locations WHERE AddressCountry != 'VALUE'
SELECT * FROM Locations WHERE AddressProvince='VALUE'
SELECT * FROM Locations WHERE AddressZip='VALUE'
SELECT * FROM Locations WHERE IncludeInactive='true'
SELECT * FROM Locations WHERE IncludeLegacy='true'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| Name | String | The name of the location. | |
| Activatable | Bool | Whether this location can be reactivated. | |
| Deactivatable | Bool | Whether this location can be deactivated. | |
| Deletable | Bool | Whether this location can be deleted. | |
| AddressVerified | Bool | Whether the location address has been verified. | |
| DeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| IsActive | Bool | Whether the location is active. | |
| ShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| FulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| HasActiveInventory | Bool | Whether this location has active inventory. | |
| HasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| AddressAddress1 | String | The first line of the address for the location. | |
| AddressAddress2 | String | The second line of the address for the location. | |
| AddressCity | String | The city of the location. | |
| AddressCountry | String | The country of the location. | |
| AddressFormatted | String | A formatted version of the address for the location. | |
| AddressLatitude | Double | The latitude coordinates of the location. | |
| AddressLongitude | Double | The longitude coordinates of the location. | |
| AddressPhone | String | The phone number of the location. | |
| AddressProvince | String | The province of the location. | |
| AddressZip | String | The ZIP code of the location. | |
| AddressCountryCode | String | The country code of the location. | |
| AddressProvinceCode | String | The code for the province, state, or district of the address of the location. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| LocalPickupSettingsV2Instructions | String | Additional instructions or information related to the local pickup. | |
| LocalPickupSettingsV2PickupTime | String | The estimated pickup time to show customers at checkout. | |
| IncludeInactive | Bool | If true, also include the locations that are deactivated. | |
| IncludeLegacy | Bool | If true, also include the legacy locations of fulfillment services. |
MarketingEvents
Returns a list of marketing events associated with the marketing app.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AppId supports the '=,!=' comparison operators.
- Type supports the '=,!=' comparison operators.
- StartedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM MarketingEvents WHERE Id='VALUE'
SELECT * FROM MarketingEvents WHERE AppId='VALUE'
SELECT * FROM MarketingEvents WHERE Type='VALUE'
SELECT * FROM MarketingEvents WHERE StartedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| RemoteId | String | An optional ID that helps Shopify validate engagement data. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AppId | String | A globally-unique ID. | |
| Channel | String | The marketing channel used by the marketing event. | |
| Description | String | A human-readable description of the marketing event. | |
| Type | String | The marketing event type. | |
| EndedAt | Datetime | The date and time when the marketing event ended. | |
| ManageUrl | String | The URL where the marketing event can be managed. | |
| PreviewUrl | String | The URL where the marketing event can be previewed. | |
| StartedAt | Datetime | The date and time when the marketing event started. | |
| UtmCampaign | String | The name of the marketing campaign. | |
| UtmMedium | String | The medium that the marketing campaign is using. Example values: 'cpc', 'banner'. | |
| UtmSource | String | The referrer of the marketing event. Example values: 'google', 'newsletter'. | |
| SourceAndMedium | String | Where the 'MarketingEvent' occurred and what kind of content was used. Because 'utmSource' and 'utmMedium' are often used interchangeably, this is based on a combination of 'marketingChannel', 'referringDomain', and 'type' to provide a consistent representation for any given piece of marketing regardless of the app that created it. | |
| ScheduledToEndAt | Datetime | The date and time when the marketing event is scheduled to end. |
MetaobjectDefinitions
Provides the definition of a generic object structure composed of metafields.
Columns
| Name | Type | References | Description |
| ID | ID | A globally-unique ID. | |
| Name | String | The human-readable name. | |
| MetaobjectsCount | Int | The count of metaobjects created for the definition. | |
| Type | String | The type of the object definition. Defines the namespace of associated metafields. | |
| Description | String | The administrative description. | |
| DisplayNameKey | String | The key of a field to reference as the display name for each object. |
MetaObjects
All metaobjects for the shop.
Columns
| Name | Type | References | Description |
| ID [KEY] | ID | A globally-unique ID. | |
| Handle | String | The unique handle of the object, useful as a custom ID. | |
| DisplayName | String | The preferred display name field value of the metaobject. | |
| Type | String | The type of the metaobject. | |
| Key [KEY] | String | The object key of this field. | |
| Value | String | The assigned field value, always stored as a string regardless of the field type. | |
| UpdatedAt | Datetime | When the object was last updated. |
OrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderDiscountApplications
Returns a list of discounts that are applied to the order, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderDiscountApplications WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String |
Orders.Id | A globally-unique ID. |
| AllocationMethod | String | The method by which the discount's value is applied to its entitled items. | |
| Index [KEY] | Int | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| TargetSelection | String | How the discount amount is distributed on the discounted lines. | |
| TargetType | String | Whether the discount is applied on line items or shipping lines. | |
| ValueAmount | Decimal | The value of the discount application. Decimal money amount. | |
| ValueCurrencyCode | String | The value of the discount application. Currency of the money. | |
| ValuePercentage | Double | The value of the discount application. The percentage value of the object. This is a number between -100 (free) and 0 (no discount). | |
| AutomaticDiscountApplicationTitle | String | The title of the discount application. | |
| DiscountCodeApplicationCode | String | The string identifying the discount code that was used at the time of application. | |
| ManualDiscountApplicationTitle | String | The title of the discount application. | |
| ManualDiscountApplicationDescription | String | The description of the discount application. | |
| ScriptDiscountApplicationTitle | String | The title of the discount application. |
OrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Orders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
OrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderLineItemDiscountAllocations
Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderLineItemId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemDiscountAllocations WHERE OrderLineItemId='VALUE'
Columns
| Name | Type | References | Description |
| OrderLineItemId | String | The ID of the Order to return. | |
| DiscountApplicationIndex [KEY] | Decimal | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| AllocatedAmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AllocatedAmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderNonFulfillableLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderNonFulfillableLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderRisks
Lists the order risks associated with this order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderRisks WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String | The order which this order risk is associated. | |
| Display | Bool | Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. | |
| Level | String | The likelihood that an order is fraudulent, based on this order risk. The level can be set by Shopify risk analysis or by an app. | |
| Message [KEY] | String | The risk message that's shown to the merchant in the Shopify admin. |
OrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
Pages
Returns a list of the shop's pages.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Pages WHERE Title='VALUE'
SELECT * FROM Pages WHERE Handle='VALUE'
SELECT * FROM Pages WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Pages WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the page. | |
| Body | String | The description of the page, complete with HTML formatting. | |
| Handle | String | A human-friendly unique string for the page automatically generated from its title. | |
| BodySummary | String | Summary of the page body. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| CreatedAt | Datetime | The timestamp of the page creation. | |
| UpdatedAt | Datetime | The timestamp of the latest page update. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. |
ProductOptions
Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ProductId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ProductOptions WHERE ProductId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique identifier. | |
| ProductId | String |
Products.Id | A globally-unique identifier. |
| Name | String | The product option's name. | |
| Position | Int | The product option's position. | |
| Values | String | The corresponding value to the product option name. |
PublicationCollections
Returns a list of collections published to the publication.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationCollections WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| PublicationId | String |
Publications.Id | A globally-unique ID. |
PublicationProducts
Returns the list of publication for products.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationProducts WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| ProductId [KEY] | String | A globally-unique ID. | |
| PublishDate | Datetime | The date that the resource publication was or is going to be published to the publication. | |
| IsPublished | Bool | Whether the resource publication is published. | |
| PublicationId [KEY] | String | A globally-unique ID. | |
| PublicationName | String | Name of the publication. |
RefundDuties
Lists the refunded duties as part of this refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundDuties WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| OriginalDutyId [KEY] | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| OriginalDutyHarmonizedSystemCode | String | The harmonized system code of the item used in calculating the duty. | |
| OriginalDutyCountryCodeOfOrigin | String | The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundLineItems
Retrieves the 'RefundLineItem' resources attached to the refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundLineItems WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| LineItemId | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| LineItemName | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| LineItemTitle | String | The title of the product at time of order creation. | |
| LineItemVariantTitle | String | The title of the variant at time of order creation. | |
| LineItemQuantity | Int | The number of variant units ordered. | |
| LineItemRestockable | Bool | Whether the line item can be restocked. | |
| LineItemSku | String | The variant SKU number. | |
| LineItemTaxable | Bool | Whether the variant is taxable. | |
| LineItemVendor | String | The name of the vendor who made the variant. | |
| LineItemCurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemMerchantEditable | Bool | Whether the line item can be edited or not. | |
| LineItemRefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemNonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| LineItemRequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| LineItemUnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| LineItemImageId | String | A unique ID for the image. | |
| LineItemImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| LineItemImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageUrl | String | The location of the image as a URL. | |
| LineItemProductId | String | A globally-unique ID. | |
| LineItemVariantId | String | A globally-unique ID. | |
| LineItemSellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| LineItemStaffMemberId | String | A globally-unique ID.(This column is available only with a ShopifyPlus subscription) | |
| Quantity | Int | The quantity of a refunded line item. | |
| Restocked | Bool | Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. | |
| RestockType | String | The type of restock for the refunded line item. | |
| LocationId | String | A globally-unique ID. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundTransactionFees
Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactionFees WHERE TransactionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| TransactionId | String | A globally-unique ID. | |
| RateName | String | Name of the credit card rate. | |
| FlatFeeName | String | Name of the credit card flat fee. | |
| Rate | Decimal | Percentage charge. | |
| Type | String | Name of the type of fee. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| FlatFeeAmount | Decimal | Decimal money amount. | |
| FlatFeeCurrencyCode | String | Currency of the money. | |
| TaxAmountAmount | Decimal | Decimal money amount. | |
| TaxAmountCurrencyCode | String | Currency of the money. |
RefundTransactions
Retrieves the transactions associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactions WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| PaymentId | String | The payment ID associated with the transaction. | |
| ParentTransactionId | String | The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | The masked account number associated with the payment method. | |
| Gateway | String | The payment gateway used to process the transaction. | |
| Kind | String | The kind of transaction. | |
| Status | String | The status of this transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| AuthorizationCode | String | Authorization code associated with the transaction. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| ReceiptJson | String | The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | The settlement currency. | |
| AuthorizationExpiresAt | Datetime | The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | The holder of the credit card. | |
| CardPaymentDetailsBin | String | 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. | |
| CardPaymentDetailsCompany | String | The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | 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. | |
| PaymentIconId | String | A unique ID for the image. | |
| PaymentIconWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Amount | Decimal | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. | |
| Currency | String | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
ReturnLineItems
Retrieves the return line items attached to the return.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ReturnLineItems WHERE ReturnId='VALUE'
Insert
INSERT statements are mapped to the 'priceListCreate' GraphQL mutation.
The following columns can be used to create a new record:
Quantity, ReturnReason, ReturnReasonNote, FulfillmentLineItemId
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ReturnId [KEY] | String |
Returns.Id | A globally-unique ID. |
| Quantity | Int | The quantity being returned. | |
| CustomerNote | String | A note from the customer that describes the item to be returned. Maximum length: 300 characters. | |
| RefundableQuantity | Int | The quantity that can be refunded. | |
| RefundedQuantity | Int | The quantity that was refunded. | |
| ReturnReason | String | The reason for returning the item. | |
| ReturnReasonNote | String | Additional information about the reason for the return. Maximum length: 255 characters. | |
| TotalWeightUnit | String | The unit of measurement for `value`. | |
| TotalWeightValue | Double | The weight value using the unit system specified with `unit`. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| WithCodeDiscountedTotalPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentLineItemId | String | A globally-unique ID. |
SellingPlanGroupSellingPlans
Retrieves selling plans associated to the selling plan group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the SellingPlanGroupId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM SellingPlanGroupSellingPlans WHERE SellingPlanGroupId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| SellingPlanGroupId | String | A globally-unique ID. | |
| Name | String | A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies. | |
| Category | String | The category used to classify the selling plan for reporting purposes. | |
| Description | String | Buyer facing string which describes the selling plan commitment. | |
| Options | String | The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | Relative position of the selling plan for display. A lower position will be displayed before a higher position. | |
| CreatedAt | Datetime | The date and time when the selling plan was created. | |
| InventoryPolicyReserve | String | When to reserve inventory for the order. | |
| FixedBillingPolicyCheckoutChargeType | String | The charge type for the checkout charge. | |
| FixedBillingPolicyCheckoutChargeValueAmount | Decimal | The charge value for the checkout charge. Decimal money amount. | |
| FixedBillingPolicyCheckoutChargeValueCurrencyCode | String | The charge value for the checkout charge. Currency of the money. | |
| FixedBillingPolicyCheckoutChargeValuePercentage | Double | The charge value for the checkout charge. The percentage value of the price used for checkout charge. | |
| FixedBillingPolicyRemainingBalanceChargeExactTime | Datetime | The exact time when to capture the full payment. | |
| FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout | String | The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. | |
| FixedBillingPolicyRemainingBalanceChargeTrigger | String | When to capture payment for amount due. | |
| RecurringBillingPolicyAnchors | String | Specific anchor dates upon which the billing interval calculations should be made. Aggregate value. | |
| RecurringBillingPolicyCreatedAt | Datetime | The date and time when the selling plan billing policy was created. | |
| RecurringBillingPolicyInterval | String | The billing frequency, it can be either: day, week, month or year. | |
| RecurringBillingPolicyIntervalCount | Int | The number of intervals between billings. | |
| RecurringBillingPolicyMaxCycles | Int | Maximum number of billing iterations. | |
| RecurringBillingPolicyMinCycles | Int | Minimum number of billing iterations. | |
| FixedDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| FixedDeliveryPolicyCutoff | Int | A buffer period for orders to be included in next fulfillment anchor. | |
| FixedDeliveryPolicyFulfillmentExactTime | Datetime | The date and time when the fulfillment should trigger. | |
| FixedDeliveryPolicyFulfillmentTrigger | String | What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. | |
| FixedDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| FixedDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| RecurringDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| RecurringDeliveryPolicyCreatedAt | Datetime | The date and time when the selling plan delivery policy was created. | |
| RecurringDeliveryPolicyCutoff | Int | Number of days which represent a buffer period for orders to be included in a cycle. | |
| RecurringDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| RecurringDeliveryPolicyInterval | String | The delivery frequency, it can be either: day, week, month or year. | |
| RecurringDeliveryPolicyIntervalCount | Int | The number of intervals between deliveries. | |
| RecurringDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| FixedPricingPolicies | String | Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value. | |
| RecurringPricingPolicies | String | Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value. |
Shop
Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Name | String | The shop's name. | |
| RichTextEditorUrl | String | The URL of the rich text editor that can be used for mobile devices. | |
| Description | String | The shop's meta description used in search engine results. | |
| String | The shop owner's email address. Shopify will use this email address to communicate with the shop owner. | ||
| Url | String | The URL of the shop's online store. | |
| ContactEmail | String | The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. | |
| CurrencyCode | String | The three letter code for the currency that the shop sells in. | |
| CustomerAccounts | String | Whether customer accounts are required, optional, or disabled for the shop. | |
| IanaTimezone | String | The shop's time zone as defined by the IANA. | |
| MyshopifyDomain | String | The shop's . myshopify. com domain name. | |
| PublicationCount | Int | The number of publications for the shop. | |
| SetupRequired | Bool | Whether the shop has outstanding setup steps. | |
| TaxShipping | Bool | Whether the shop charges taxes for shipping. | |
| TaxesIncluded | Bool | Whether applicable taxes are included in the shop's product prices. | |
| TimezoneAbbreviation | String | The shop's time zone abbreviation. | |
| TimezoneOffset | String | The shop's time zone offset. | |
| UnitSystem | String | The shop's unit system for weights and measures. | |
| WeightUnit | String | The shop's primary unit of weight for products and shipping. | |
| CheckoutApiSupported | Bool | Specifies whether the shop supports checkouts via Checkout API. | |
| EnabledPresentmentCurrencies | String | The presentment currencies enabled for the shop. | |
| ShipsToCountries | String | The list of countries that the shop ships to. | |
| TimezoneOffsetMinutes | Int | The shop's time zone offset expressed as a number of minutes. | |
| TransactionalSmsDisabled | Bool | Whether transactional SMS sent by Shopify have been disabled for a shop. | |
| OrderNumberFormatPrefix | String | The prefix that appears before order numbers. | |
| OrderNumberFormatSuffix | String | The suffix that appears after order numbers. | |
| BillingAddressId | String | A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | Whether the address coordinates are valid. | |
| BillingAddressAddress1 | String | The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | The name of the city, district, village, or town. | |
| BillingAddressCompany | String | The name of the company or organization. | |
| BillingAddressCountry | String | The name of the country. | |
| BillingAddressLatitude | Double | The latitude coordinate of the address. | |
| BillingAddressLongitude | Double | The longitude coordinate of the address. | |
| BillingAddressPhone | String | A phone number associated with the address. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | The two-letter code for the country of the address. For example, US. | |
| CountriesInShippingZonesCountryCodes | String | The list of all the countries from all the combined shipping zones. | |
| CountriesInShippingZonesIncludeRestOfWorld | Bool | Whether 'Rest of World' has been defined in any of the shipping zones. | |
| CurrencyFormatsMoneyFormat | String | Money without currency in HTML. | |
| CurrencyFormatsMoneyInEmailsFormat | String | Money without currency in emails. | |
| CurrencyFormatsMoneyWithCurrencyFormat | String | Money with currency in HTML. | |
| CurrencyFormatsMoneyWithCurrencyInEmailsFormat | String | Money with currency in emails. | |
| FeaturesInternationalPriceOverrides | Bool | Whether a shop can enable international price overrides. | |
| FeaturesBranding | String | The branding of the shop, which influences its look and feel in the Shopify admin. | |
| FeaturesCaptcha | Bool | Whether a shop's online store can have CAPTCHA protection. | |
| FeaturesReports | Bool | Whether a shop has access to all reporting features. | |
| FeaturesStorefront | Bool | Whether a shop has an online store. | |
| FeaturesAvalaraAvatax | Bool | Whether a shop has access to Avalara AvaTax. | |
| FeaturesDynamicRemarketing | Bool | Whether a shop has access to the Google Analytics dynamic remarketing feature. | |
| FeaturesGiftCards | Bool | Whether a shop can create gift cards. | |
| FeaturesInternationalDomains | Bool | Whether a shop can enable international domains. | |
| FeaturesLiveView | Bool | Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial or don't have a storefront. | |
| FeaturesSellsSubscriptions | Bool | Whether a shop has ever had subscription products. | |
| FeaturesShowMetrics | Bool | Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. | |
| FeaturesCaptchaExternalDomains | Bool | Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. | |
| FeaturesEligibleForSubscriptions | Bool | Whether a shop is configured properly to sell subscriptions. | |
| FeaturesHarmonizedSystemCode | Bool | Whether a shop displays Harmonized System codes on products. This is used for customs when shipping internationally. | |
| FeaturesInternationalPriceRules | Bool | Whether a shop can enable international price rules. | |
| FeaturesEligibleForSubscriptionMigration | Bool | Whether a shop can be migrated to use Shopify subscriptions. | |
| FeaturesLegacySubscriptionGatewayEnabled | Bool | Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. | |
| FeaturesPaypalExpressSubscriptionGatewayStatus | String | Whether a shop is configured to sell subscriptions with PayPal Express. | |
| LimitedPendingOrderCountCount | Int | The number of pendings orders on the shop. Limited to a maximum of 10000. | |
| LimitedPendingOrderCountAtMax | Bool | This is set when the number of pending orders has reached the maximum. | |
| PaymentSettingsSupportedDigitalWallets | String | List of the digital wallets which the shop supports. | |
| PlanDisplayName | String | The name of the shop's billing plan. | |
| PlanPartnerDevelopment | Bool | Whether the shop is a partner development shop for testing purposes. | |
| PlanShopifyPlus | Bool | Whether the shop has a Shopify Plus subscription. | |
| PrimaryDomainId | String | A globally-unique ID. | |
| PrimaryDomainHost | String | The host name of the domain. For example, 'example. com'. | |
| PrimaryDomainUrl | String | The URL of the domain (for example, 'https: //example. com'). | |
| PrimaryDomainSslEnabled | Bool | Whether SSL is enabled. | |
| PrimaryDomainLocalizationCountry | String | The ISO code for the country assigned to the domain. For example, 'CA' or '*' for a domain set to 'Rest of world'. | |
| PrimaryDomainLocalizationAlternateLocales | String | The ISO codes for the domain's alternate locales. For example, '['en']'. | |
| PrimaryDomainLocalizationDefaultLocale | String | The ISO code for the domain's default locale. For example, 'en'. | |
| PrimaryDomainMarketWebPresenceId | String | A globally-unique ID. | |
| PrimaryDomainMarketWebPresenceAlternateLocales | String | The ISO codes for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and 'example. ca' is the market's domain, then 'example. ca/en' will load in English. | |
| PrimaryDomainMarketWebPresenceDefaultLocale | String | The ISO code for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and 'example. ca' is the market's domian, then 'example. ca' will load in French. | |
| PrimaryDomainMarketWebPresenceSubfolderSuffix | String | The market-specific suffix of the subfolders defined by the web presence. Example: in '/en-us' the subfolder suffix is 'us'. This field will be null if 'domain' isn't null. | |
| ResourceLimitsLocationLimit | Int | Maximum number of locations allowed. | |
| ResourceLimitsMaxProductOptions | Int | Maximum number of product options allowed. | |
| ResourceLimitsMaxProductVariants | Int | The maximum number of variants allowed per product. | |
| ResourceLimitsRedirectLimitReached | Bool | Whether the shop has reached the limit of the number of URL redirects it can make for resources. | |
| ResourceLimitsSkuResourceLimitsAvailable | Bool | Whether the resource is available. | |
| ResourceLimitsSkuResourceLimitsQuantityAvailable | Int | Quantity available. If null the quantity available is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityLimit | Int | Quantity limit of the resource. If null the quantity is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityUsed | Int | Quantity used of the resource. If null the quantity used cannot be retrieved. |
ShopifyPaymentsAccount
Returns Shopify Payments account information, including balances and payouts.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Activated | Bool | Whether the Shopify Payments setup is completed. | |
| Country | String | The Shopify Payments account country. | |
| Onboardable | Bool | Whether the Shopify Payments account can be onboarded. | |
| DefaultCurrency | String | The default payout currency for the Shopify Payments account. | |
| PayoutStatementDescriptor | String | The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout. | |
| FraudSettingsDeclineChargeOnAvsFailure | Bool | Decline a charge if there is an AVS failure. | |
| FraudSettingsDeclineChargeOnCvcFailure | Bool | Decline a charge if there is an CVC failure. | |
| NotificationSettingsPayouts | Bool | Receive email notifications when new payouts are sent or payouts fail. | |
| PayoutScheduleInterval | String | The interval at which payouts are sent to the connected bank account. | |
| PayoutScheduleMonthlyAnchor | Int | The day of the month funds will be paid out. The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. | |
| PayoutScheduleWeeklyAnchor | String | The day of the week funds will be paid out. The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used. |
ShopifyPaymentsAccountBalance
Returns current balances in all currencies for the account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Amount | Decimal | Decimal money amount. | |
| CurrencyCode [KEY] | String | Currency of the money. |
ShopifyPaymentsAccountBankAccounts
Lists all bank accounts configured for the Shopify Payments account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| BankName | String | The name of the bank. | |
| Country | String | The country of the bank. | |
| Currency | String | The currency of the bank account. | |
| Status | String | The status of the bank account. | |
| AccountNumber | String | The account number of the bank account. | |
| RoutingNumber | String | The routing number of the bank account. | |
| AccountNumberLastDigits | String | The last digits of the account number (the rest is redacted). | |
| CreatedAt | Datetime | The date that the bank account was created. |
ShopifyPaymentsAccountDisputes
Lists all disputes related to the Shopify Payments account.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- InitiatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Id='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Status='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE InitiatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| EvidenceDueBy | Date | The deadline for evidence submission. | |
| EvidenceSentOn | Date | The date when evidence was sent. Returns null if evidence has not yet been sent. | |
| Status | String | The current state of the dispute. | |
| Type | String | Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. | |
| FinalizedOn | Date | The date when this dispute was resolved. Returns null if the dispute is not yet resolved. | |
| InitiatedAt | Datetime | The date when this dispute was initiated. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| OrderId | String | A globally-unique ID. | |
| ReasonDetailsReason | String | The reason for the dispute provided by the cardholder's banks. | |
| ReasonDetailsNetworkReasonCode | String | The raw code provided by the payment network. |
ShopifyPaymentsAccountPayouts
Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionType column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ShopifyPaymentsAccountPayouts WHERE TransactionType='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The transfer status of the payout. | |
| IssuedAt | Datetime | The exact time when the payout was issued. The payout only contains balance transactions that were available at this time. | |
| TransactionType | String | The direction of the payout. | |
| BankAccountId | String | A globally-unique ID. | |
| NetAmount | Decimal | Decimal money amount. | |
| NetCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsFeeAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsFeeCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsGrossAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsGrossCurrencyCode | String | Currency of the money. | |
| SummaryChargesFeeAmount | Decimal | Decimal money amount. | |
| SummaryChargesFeeCurrencyCode | String | Currency of the money. | |
| SummaryChargesGrossAmount | Decimal | Decimal money amount. | |
| SummaryChargesGrossCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeGrossAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeGrossCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsGrossAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsGrossCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsGrossAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsGrossCurrencyCode | String | Currency of the money. |
ShopifyPaymentsAccountPermittedVerificationDocuments
Retrieves the permitted documents for identity verification.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Type [KEY] | String | The type of the document which can be used for verification. | |
| BackRequired | Bool | True if the back side of the document is required. | |
| FrontRequired | Bool | True if the front side of the document is required. |
ShopifyPaymentsAccountVerifications
Returns the verifications necessary for this account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The status of the verification. | |
| SubjectFamilyName | String | The family name of the individual to verify. | |
| SubjectGivenName | String | The given name of the individual to verify. |
StaffMembers
Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription)
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| Name | String | The staff member's full name. | |
| FirstName | String | The staff member's first name. | |
| LastName | String | The staff member's last name. | |
| Active | Bool | Whether the staff member is active. | |
| String | The staff member's email address. | ||
| Exists | Bool | Whether the staff member's account exists. | |
| Initials | String | The staff member's initials, if available. | |
| Locale | String | The staff member'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' | |
| Phone | String | The staff member's phone number. | |
| IsShopOwner | Bool | Whether the staff member is the shop owner. | |
| PrivateDataAccountSettingsUrl | String | The URL to the staff member's account settings page. | |
| PrivateDataCreatedAt | Datetime | The date and time when the staff member was created. |
TenderTransactions
Returns a list of TenderTransactions associated with the shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Test supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TenderTransactions WHERE Id='VALUE'
SELECT * FROM TenderTransactions WHERE Test='true'
SELECT * FROM TenderTransactions WHERE ProcessedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| PaymentMethod | String | Information about the payment method used for the transaction. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| RemoteReference | String | The remote gateway reference associated with the tender transaction. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| TenderTransactionCreditCardDetailsCreditCardCompany | String | The name of the company that issued the customer's credit card. Example: 'Visa'. | |
| TenderTransactionCreditCardDetailsCreditCardNumber | String | The customer's credit card number, with all digits except the last 4 redacted. Example: '???? ???? ???? 1234' | |
| UserId | String | A globally-unique ID.(This column is available only with a ShopifyPlus subscription) |
API Version 2023-07
CData Sync App は、Shopify API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
主要機能
- Include Custom Fields 接続プロパティを使用すると、Products およびProductVariants テーブルのカスタムフィールドを取得できます。この機能を有効にするには、このプロパティをTrue に設定します。
- Row Scan Depth 接続プロパティは、カスタムフィールドに対してフィルタリングされる行数を設定します。このプロパティのデフォルト値は50です。低い値を設定するとすべてのカスタムフィールドを取得できなくなる可能性がありますが、高い値を設定するとドライバーのパフォーマンスが低下します。この機能を使用するには、Include Custom Fields 接続プロパティをTrue に設定します。
- Flexible Schema は、Products およびProductVariants テーブルのカスタムフィールドを取得します。この機能は、Include Custom Fields 接続プロパティがTrue に設定されている場合に有効です。Flexible Schema は、カスタムフィールドを最大250行検索します。より多くのフィールドを取得するには、Row Scan Depth をより大きな値に設定します。
REST API の使用
REST API で利用可能なエンティティについては、REST Data Model を参照してください。
GraphQL API の使用
GraphQL API で利用可能なエンティティについては、GRAPHQL Data Model を参照してください。
REST Data Model
CData Sync App は、Shopify API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
REST データモデルを使用するには、Schema をREST に設定します。
テーブル
テーブル は、Orders、Products などの変更可能なテーブルです。
ビュー
ビュー は、Events、Patouts、Reports などの変更ができないテーブルです。一般的に、読み取り専用のモデルデータはビューとして表示されます。
ストアドプロシージャ
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらのインターフェイスを使用して、データソース内の情報を検索、更新、および変更できます。
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| ApplicationCharges | Create or view Application Charges for Billing. |
| ApplicationCredit | Create or view Application Credit for Billing. |
| Articles | Create, read, update or delete articles |
| Assets | Create, read, update or delete assets. CUD support is no longer accessible for public apps. |
| Blogs | Create, read, update or delete blogs |
| CarrierServices | Returns a list of resource feedback objects.. |
| CollectionListings | Query and delete information regarding different collects. |
| Collects | Query, insert, or delete information regarding different collects. |
| Comments | Create, read, update and delete the comments. |
| Countries | Create, select, update, and delete information regarding countries. |
| CustomCollections | Query, insert, update, or delete information regarding different custom collections. |
| CustomerAddresses | Create, update, delete, and query customer addresses. |
| Customers | Create, update, delete, and query customers. |
| DiscountCodes | Create, select, update, and delete information regarding discount codes. |
| DraftOrders | Create, update, delete, and query draft orders. |
| FulfillmentEvents | Create, delete, and query information regarding fulfillment events. |
| Fulfillments | Create, update, and query fulfillments. |
| FulfillmentServices | Query, create, update, and delete information regarding different fulfillment services. |
| GiftCards | Create, update, delete, and query gift cards. |
| InventoryItems | Query and update information regarding different inventory items. |
| InventoryLevels | Query, create, and update information regarding different inventory levels. |
| MarketingEvents | Create, update, delete, and query marketing events. |
| Metafields | Retrieves a list of metafields that belong to a resource. |
| OrderRisks | Create, update, delete, and query order risks. |
| Orders | Create, update, delete, and query orders. |
| OrderTransactions | Create and query transactions. |
| Pages | Create, read, update or delete pages |
| PriceRules | Create, update, delete, and query price rules. |
| ProductImages | Query, Update and Delete Product Images |
| ProductListings | Query and delete product listings. |
| ProductOptions | Query product options. |
| ProductResourceFeedbacks | Returns a list of resource feedback objects.. |
| Products | List of products. |
| ProductVariants | List of the product variants. |
| Provinces | Query and update information regarding different provinces. |
| RecurringApplicationCharges | Create, update, delete, and query Recurring Application Charges. |
| Redirects | Create, read, update or delete redirects. |
| Refunds | Create and query refunds. |
| ResourceFeedbacks | Returns a list of resource feedback objects.. |
| ScriptTags | Create, read, update or delete script tags. |
| SmartCollections | Query, insert, update, or delete information regarding different smart collections. |
| Themes | Create, read, update or delete themes |
| UsageCharges | Create or view Usage Charges for Recurring Application Charges. |
ApplicationCharges
Create or view Application Charges for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCharges WHERE Id = '123'
Insert
INSERT INTO ApplicationCharges ( Test ) VALUES ( 'true' )
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The Unique Identifier of the Application Charge | |
| Name | String | False |
The Order Number | |
| ApiClientId | Long | True |
The API Client ID | |
| Price | Decimal | False |
The price of the application charge | |
| Status | String | True |
The status of the application charge. Valid Values are: pending, active, declined, expired | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting a charge. | |
| Test | String | False |
Whether the application charge is a test transaction. Valid values:true,null | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was last updated. | |
| ChargeType | String | True |
The type of the application charge | |
| DecoratedReturnUrl | String | True |
The decorated return url |
ApplicationCredit
Create or view Application Credit for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCredit WHERE Id = '123'
Insert
INSERT INTO ApplicationCredit (Amount, Description, Test) VALUES ('100', 'success or failure', 'true')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the application credit. | |
| Amount | Decimal | False |
The amount refunded by the application credit. | |
| Description | String | False |
The description of the application credit. | |
| Test | String | False |
Whether the application credit is a test transaction. Valid values: true,null |
Articles
Create, read, update or delete articles
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '123'
Insert
You must specify the Title to create an Article.
INSERT INTO Articles (BlogId, Author, Title) VALUES ('599421749', 'Adam', 'New Article')
Update
You must specify the blog id and id to update an article. For example:
UPDATE Articles SET Author = 'Harry' WHERE BlogId = '599421749' AND Id = '5557081211'
Delete
You must specify the Id and the Blog Id of the article to delete it.
DELETE FROM Articles WHERE BlogId = '599421749' AND Id = '5556952105'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the article. | |
| BlogId [KEY] | Long | False |
Blogs.Id |
The ID of the blog containing the article. |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the author of the article. | |
| BodyHtml | String | False |
The text of the body of the article, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was created. | |
| Handle | String | False |
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. | |
| ImageAlt | String | False |
Alternative text that describes the image. | |
| ImageCreatedAt | Datetime | True |
The date and time when image is created. | |
| ImageHeight | Int | False |
Height of the image. | |
| ImageSrc | String | False |
A source URL that specifies the location of the image. | |
| ImageWidth | Int | False |
Width of the image. | |
| ImageAttachment | String | False |
An image attached to article returned as Base64-encoded binary data. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the article was published. | |
| SummaryHtml | String | False |
A summary of the article, complete with HTML markup. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the article. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was last updated. | |
| UserId | Long | True |
A unique numeric identifier for the author of the article. | |
| PublishedStatus | String | False |
Filter articles by their publish status. Valid values are: published, unpublished and any ; default: any. |
Assets
Create, read, update or delete assets. CUD support is no longer accessible for public apps.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Assets WHERE Key = 'assets/abc.gif'
Insert
You must specify the Theme Id and Key to insert an Asset. For example:
INSERT INTO Assets(Key, Value, ThemeId) VALUES('assets/abc.gif', '
Update
You must specify the Theme Id and Key to update an Asset. For example:
UPDATE Assets SET value = 'pqrs' WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Delete
You must specify the Id and the Theme Id of the Asset to delete it.
DELETE FROM Assets WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Columns
| Name | Type | ReadOnly | References | Description |
| Key [KEY] | String | False |
The path to the asset within a theme. | |
| ThemeId [KEY] | Long | True |
Themes.Id |
The ID for the theme that an asset belongs to. |
| Attachment | String | False |
A base64-encoded image. | |
| Checksum | String | True |
The MD5 representation of the content, consisting of a string of 32 hexadecimal digits. May be null if an asset has not been updated recently. | |
| ContentType | String | True |
The MIME representation of the content, consisting of the type and subtype of the asset. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the asset was created. | |
| PublicUrl | String | True |
The public-facing URL of the asset. | |
| Size | Int | True |
The asset size in bytes. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when an asset was last updated. | |
| Value | String | False |
The text content of the asset, such as the HTML and Liquid markup of a template file. |
Blogs
Create, read, update or delete blogs
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Handle column and Id. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- Handle supports the '=,IN' comparison.
SELECT * FROM Blogs WHERE Id = '123'
SELECT * FROM Blogs WHERE Id IN ('123', '345')
SELECT * FROM Blogs WHERE Handle = 'new-blog-5927';
SELECT * FROM Blogs WHERE Handle IN ('new-blog-5927', 'new-blog-5926');
Insert
You must specify the Title to create a Blog.
INSERT INTO Blogs (title) VALUES ('new blog')
INSERT INTO Blogs (Title, Metafields) VALUES ('new blog','[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]')
Update
You must specify the id to update a Blog. For example:
UPDATE Blogs SET title = 'new blog' WHERE Id = '77171130'
UPDATE Blogs SET Metafields='[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]' WHERE Id='77171130'
Delete
You must specify the Id of the Blog to delete it.
DELETE FROM Blogs WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the blog. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Commentable | String | False |
Indicates whether readers can post comments to the blog and if comments are moderated or not. | |
| CreatedAt | Datetime | True |
The date and time when the blog was created. | |
| Feedburner | String | False |
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. | |
| FeedburnerLocation | String | False |
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 | String | False |
A human-friendly unique string for a blog automatically generated from its title. | |
| Metafields | String | False |
Attaches additional metadata to a store's resources. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the blog. | |
| UpdatedAt | Datetime | True |
The date and time when changes were last made to the blog's properties. |
CarrierServices
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CarrierServices
SELECT * FROM CarrierServices WHERE Id = '123'
SELECT * FROM CarrierServices WHERE Id IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [CarrierServices] (Name, Type, CallbackUrl) VALUES ('ApiServiceType', 'api', 'https://test.com');
Update
You must specify the id to update a Redirect. For example:
UPDATE [CarrierServices] SET [Active] = 'false' WHERE [Id] = 59103608855;
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM [CarrierServices] WHERE [Id] = 59103608855;
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the carrier service. | |
| Active | Bool | False |
Whether this carrier service is active. If true, then the service will be available to serve rates in checkout. | |
| Name | String | False |
The name of the shipping service as seen by merchants and their customers. | |
| CallbackUrl | String | False |
The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL. | |
| Type | String | False |
Distinguishes between API or legacy carrier services. | |
| Format | String | False |
The format of the data returned by the URL endpoint. json is the only valid value. | |
| ServiceDiscovery | String | False |
Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. | |
| AdminGraphqlApiId | String | False |
The GraphQL GID for this carrier service. |
CollectionListings
Query and delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CollectionListings WHERE Id = '123'
Delete
You must specify the Id of the collection listing to delete it.
DELETE FROM CollectionListings WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The Id of the collection this listing belongs to. | |
| Title | String | True |
The titke of the collection listing. | |
| BodyHtml | String | True |
The HTML body/description for this listing. | |
| DefaultProductImage | String | True |
The default product image in this listing. | |
| ImageCreatedAt | String | True |
The date and time the image for this listing was created at. | |
| ImageSource | String | True |
The source/link of the image for this listing. | |
| Handle | String | True |
The handle of this listing. | |
| UpdatedAt | Datetime | True |
The date and time when the collection listing was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the collection listing was created. |
Collects
Query, insert, or delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Collects WHERE Id = '123'
Insert
You must specify the ProductId and CollectionId to create a collect.
INSERT INTO Collects (ProductId, CollectionId) VALUES ('512433520663', '22892937239')
Delete
You must specify the Id of the collect to delete it.
DELETE FROM Collects WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the collect. | |
| CollectionId | Long | False |
The Id of the collection this collection is linked with. | |
| ProductId | Long | False |
Products.Id |
The Id of the product this collection is linked with. |
| Position | Int | True |
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. | |
| SortValue | String | True |
This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. | |
| CreatedAt | Datetime | True |
The date and time when the collect was created. | |
| UpdatedAt | Datetime | True |
The date and time when the collect was last modified. |
Comments
Create, read, update and delete the comments.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Comments WHERE Id = '123'
Insert
You must specify Article Id, Author, Body, Email to create a Comment.
INSERT INTO Comments (articleid, author, body, email) VALUES ('5557001', 'Harry', 'test', '[email protected]')
Update
You must specify the Id to update a Comment. For example:
UPDATE Comments SET Author = 'Adam' WHERE Id = '77171130'
Delete
You must specify the Id of the Comments to delete it.
DELETE FROM Comments WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the comment. | |
| BlogId | Long | False |
Blogs.Id |
A unique numeric identifier for the blog containing the article that the comment belongs to. |
| ArticleId | Long | False |
Articles.Id |
A unique numeric identifier for the article that the comment belongs to. |
| Author | String | False |
The name of the author of the comment. | |
| Body | String | False |
The basic Textile markup of a comment. | |
| BodyHtml | String | False |
The text of the comment, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was created. | |
| String | False |
The email address of the author of the comment. | ||
| Ip | String | False |
The IP address from which the comment was posted. | |
| PublishedAt | String | False |
The date and time (ISO 8601 format) when the comment was published. | |
| Status | String | True |
The status of the comment. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was last modified. | |
| UserAgent | String | False |
The user agent string provided by the software used to create the comment. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
Countries
Create, select, update, and delete information regarding countries.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Countries
SELECT * FROM Countries WHERE Id = '123'
Insert
You must specify the Code to create a country.
INSERT INTO Countries (Code) VALUES ("FR")
Update
You must specify the country Id to update a country. For example:
UPDATE Countries SET Tax = 0.1 WHERE Id = '123'
Delete
You must specify the Id of the country to delete it.
DELETE FROM Countries WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the country. | |
| Name | String | True |
The name of the country. | |
| Code | String | False |
The code of the country. | |
| Tax | Decimal | False |
The amount of tax which should be applied for this country. | |
| Provinces | String | False |
The sub-regions of a country, such as its provinces or states. Each sub-region has the following properties: code: The two letter province or state code, country_id: The ID for the country to which this sub-region belongs, id: The ID for the particular sub-region, name: The name of the sub-region, tax: The tax value in decimal format, tax_name: The name of the tax as it is referred to in the applicable sub-region. For example, in Canada, the sales tax in the province Ontario is referred to as HST, tax_type: The tax type. Valid values: null, normal, or harmonized. If the value is harmonized, then the tax is compounded of the provincial and federal sales taxes, tax_percentage: The tax value in percent format |
CustomCollections
Query, insert, update, or delete information regarding different custom collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, and PublishedAt columns. The supported SQL operators are 'IN' for Id and Handle, '=' for the ProductId, Title and PublishedStatus columns, '>' and '<' for UpdatedAt and PublishedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM CustomCollections WHERE Id = '123'
SELECT * FROM CustomCollections WHERE Id IN ('123', '456')
SELECT * FROM CustomCollections WHERE ProductId = '123'
SELECT * FROM CustomCollections WHERE Title = 'Ducks'
SELECT * FROM CustomCollections WHERE Handle = 'frontpage'
SELECT * FROM CustomCollections WHERE Handle IN ('frontpage', 'lastpage')
SELECT * FROM CustomCollections WHERE PublishedStatus = 'published'
SELECT * FROM CustomCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM CustomCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title to create a custom collection.
INSERT INTO CustomCollections (Title) VALUES ('Macbooks')
INSERT INTO CustomCollections (Title, Published) VALUES ('Macbooks', false)
Update
You must specify the custom collection Id to update a custom collection. For example:
UPDATE CustomCollections SET Title = 'Updated title' WHERE Id = '123'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM CustomCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the custom collection. | |
| Title | String | False |
The title of the custom collection. | |
| BodyHtml | String | False |
The body/description of the custom collection. | |
| Image | String | False |
A JSON aggregate with information regarding the image of custom collection. | |
| Metafields | String | False |
Attaches additional metadata to a shop's resources: key: An identifier for the metafield. (maximum: 30 characters), namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters), value: Information to be stored as metadata, value_type: The information type being stored. Valid values: string or integer, description (optional): Additional information about the metafield . | |
| Handle | String | False |
A human-friendly unique string for the custom collection automatically generated from its title. | |
| SortOrder | String | False |
The order in which products in the custom collection appear. | |
| TemplateSuffix | String | False |
The suffix of the liquid template being used. | |
| PublishedScope | String | False |
The sales channels in which the custom collection is visible. | |
| UpdatedAt | Datetime | True |
The date and time when the custom collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the custom collection was published to the Online Store channel. | |
| ProductId | String | False |
Show custom collections that include a given product. | |
| PublishedStatus | String | False |
Show custom collection with a given published status: published: show only published custom collections, unpublished: show only unpublished custom collections, any: show custom collections of any published status. (default: any). |
CustomerAddresses
Create, update, delete, and query customer addresses.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- CustomerId supports the '=,IN' comparison.
- CustomerUpdatedAt supports the '<,>,<=,>=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM CustomerAddresses WHERE CustomerId = '123'
SELECT * FROM CustomerAddresses WHERE CustomerId IN ('123', '456')
SELECT * FROM CustomerAddresses WHERE CustomerUpdatedAt >= '2018-05-04'
Insert
You must specify the customer Id to create an address.
INSERT INTO CustomerAddresses (CustomerId, Address1, City, Company) VALUES ('123', '1 Rue des Carrieres', 'Suite 1234', 'Montreal')
Update
You must specify the customer Id and the Id of the customer address to update an address.
UPDATE CustomerAddresses SET Zip = '90210' WHERE CustomerId = '123' AND Id = '456'
Delete
You must specify the customer Id and the Id of the customer address to delete an address. You cannot delete a customer's default address.
DELETE FROM CustomerAddresses WHERE CustomerId = '183467180055' AND Id = '292265787415'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the address. | |
| CustomerId [KEY] | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerUpdatedAt | Datetime | True |
The date and time when the customer information was last updated. | |
| Name | String | False |
The customer's name. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| Company | String | False |
The customer's company. | |
| Address1 | String | False |
The customer's mailing address. | |
| Address2 | String | False |
An additional field for the customer's mailing address. | |
| City | String | False |
The customer's city. | |
| Province | String | False |
The customer's province or state name. | |
| Country | String | False |
The customer's country. | |
| Zip | String | False |
The customer's zip or postal code. | |
| Phone | String | False |
The customer's phone number for this mailing address. | |
| ProvinceCode | String | False |
The two-letter pcode for the customer's province or state. | |
| CountryCode | String | False |
The two-letter country code corresponding to the customer's country. | |
| CountryName | String | False |
The customer's normalized country name. | |
| Default | Bool | True |
Indicates whether this address is the default address for the customer. |
Customers
Create, update, delete, and query customers.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- FirstName supports the '=' comparison.
- LastName supports the '=' comparison.
- Email supports the '=' comparison.
- Phone supports the '=' comparison.
- TotalSpent supports the '=' comparison.
- OrdersCount supports the '=' comparison.
- AcceptsMarketing supports the '=' comparison.
- State supports the '=' comparison.
- VerifiedEmail supports the '=' comparison.
- CreatedAt supports the '>=,<=' comparison.
- UpdatedAt supports the '>=,<=,=' comparison.
SELECT * FROM Customers WHERE Id = '123'
SELECT * FROM Customers WHERE Id IN ('123', '456')
SELECT * FROM Customers WHERE CreatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE CreatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE FirstName = 'abc'
SELECT * FROM Customers WHERE LastName = 'xyz'
SELECT * FROM Customers WHERE Email = '[email protected]'
SELECT * FROM Customers WHERE OrdersCount = 5
SELECT * FROM Customers WHERE Phone = '999999999'
SELECT * FROM Customers WHERE VerifiedEmail = true
SELECT * FROM Customers WHERE UpdatedAt = '2017-10-25'
Insert
The Email field is required to insert.
INSERT INTO Customers (Email, Phone) VALUES ('[email protected]', '+15142546011')
INSERT INTO Customers (Email, Phone, SendEmailInvite) VALUES ('[email protected]', '+15142546011', true)
Update
You must specify the Id of the customer to update a customer.
UPDATE Customers SET Note = 'Customer is a great guy' WHERE Id = '123'
UPDATE Customers SET Tags = 'New Customer, Repeat Customer' WHERE Id = '123'
Delete
You must specify the Id of the customer to delete a customer.
DELETE FROM Customers WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the customer. | |
| LastOrderId | Long | True |
Orders.Id |
The id of the customer's last order. |
| LastOrderName | String | True |
The name of the customer's last order. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| String | False |
The unique email address of the customer. | ||
| Phone | String | False |
The unique phone number for this customer. | |
| TaxExempt | Bool | False |
Indicates whether the customer should be charged taxes when placing orders. | |
| TotalSpent | Decimal | True |
The total amount of money that the customer has spent at the shop. | |
| OrdersCount | Int | True |
The number of orders associated with this customer. | |
| MultipassIdentifier | String | True |
The customer's identifier used with Multipass login. | |
| Note | String | False |
A note about the customer. | |
| EmailMarketingState | String | False |
The current email marketing state for the customer. | |
| EmailMarketingLevel | String | False |
The marketing subscription opt-in level. | |
| EmailMarketingUpdatedAt | Datetime | False |
The date and time when the customer consented to receive marketing material by email. | |
| State | String | True |
The state of the customer's account in a shop. | |
| Tags | String | False |
The tags for this customer. Separate with comma for multiple tags. | |
| VerifiedEmail | Bool | True |
States whether or not the email address has been verified. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| UpdatedAt | Datetime | True |
The date and time when the customer information was updated. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Password | String |
Password of the customer. |
| PasswordConfirmation | String |
Password confirmation of the customer. |
| SendEmailWelcome | Bool |
Whether to send a welcome email to the customer or not. |
| SendEmailInvite | Bool |
Whether to send an invite email to the customer or not. |
DiscountCodes
Create, select, update, and delete information regarding discount codes.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the PriceRuleId and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123'
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Insert
You must specify the PriceRuleId and Code to create a discount code.
INSERT INTO DiscountCodes (PriceRuleId, Code) VALUES ('290807676951', 'SUMMERSALE100OFF')
Update
You must specify the PriceRuleId and Id to update a discount code. For example:
UPDATE DiscountCodes SET Code = 'WINTERSALE500OFF' WHERE PriceRuleId = '123' AND Id = '456'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the discount code. | |
| PriceRuleId [KEY] | Long | False |
PriceRules.Id |
The Id for the price rule that this discount code belongs to. |
| Code | String | False |
The case-insensitive discount code that customers use at checkout. | |
| UsageCount | Int | True |
The number of times that the discount code has been redeemed. | |
| CreatedAt | Datetime | True |
The date and time when the discount code was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount code was last modified. |
DraftOrders
Create, update, delete, and query draft orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status, and UpdatedAt columns. The supported SQL operators are "=" and "IN" for Id, "=" for Status, and ">" and "<" for UpdatedAt. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DraftOrders WHERE Id = '123'
SELECT * FROM DraftOrders WHERE Id IN ('123', '456')
SELECT * FROM DraftOrders WHERE Status = 'completed'
SELECT * FROM DraftOrders WHERE UpdatedAt > '2018-02-05'
Insert
-
Create a simple draft order with only a product variant Id using aggregates.
INSERT INTO DraftOrders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple draft order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO DraftOrders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a custom draft order using aggregates.
INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('[{\"title\":\"Custom Tee\",\"price\":20.15,\"quantity\":5}]', '709015339031', true) -
Create a custom draft order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemQuantity) VALUES ('Custom Tee', 20.15, 5) INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('OrdersItems#TEMP', '709015339031', true)
Update
-
Add a Note to a draft order:
UPDATE DraftOrders SET Note = 'Customer contacted us about a custom engraving on this iPod' WHERE Id = '123'
-
Set a discount on a draft order:
UPDATE DraftOrders SET AppliedDiscountDescription = 'Custom discount', AppliedDiscountValueType = 'percentage', AppliedDiscountValue = 10.0, AppliedDiscountAmount = 19.90, AppliedDiscountTitle = 'Custom' WHERE Id = '123'
Delete
You must specify the Id of the draft order to delete it.
DELETE FROM DraftOrders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| Tags | String | False |
Additional short descriptors. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| Status | String | True |
The status of the order. Valid values are: open (all open orders), invoice_sent (only closed orders), and completed (cancelled orders). Defaults to 'open'. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the draft order. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| CompletedAt | Datetime | True |
The date and time when the order was completed at. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| UseCustomerDefaultAddress | Bool |
Optional boolean that you can send as part of a draft order object to load customer shipping information. Valid values: true or false. |
FulfillmentEvents
Create, delete, and query information regarding fulfillment events.
Table-Specific Information
Select
The OrderId and FulfillmentId are required to query this table. The Sync App uses the Shopify API to process search criteria that refer to the OrderId, FulfillmentId, and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456'
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456' AND Id = '789'
Insert
You must specify the OrderId, FulfillmentId, and Status to create a fulfillment event.
INSERT INTO FulfillmentEvents (Orderid, FulfillmentId, Status, Message, EstimatedDeliveryAt) VALUES ('202520330263', '206541914135', 'in_transit', 'test', '2018-08-02 10:15:25 PM')
Delete
You must specify the OrderId, FulfillmentId, and Id of the fulfillment event to delete it.
DELETE FROM FulfillmentEvents WHERE Orderid = '202520330263' AND FulfillmentId = '206541914135' AND Id = '2374424264727'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A numeric unique identifier for the fulfillment event. | |
| OrderId [KEY] | Long | False |
Orders.Id |
The id of the order the fulfillment event belongs to. |
| FulfillmentId [KEY] | Long | False |
Fulfillments.Id |
A numeric unique identifier for the fulfillment to which the fulfillment event belongs. |
| ShopId | Long | True |
Shop.Id |
A numeric unique identifier for the shop to which the fulfillment event belongs. |
| Status | String | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| EstimatedDeliveryAt | Datetime | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| Message | String | False |
An arbitrary message describing the status. Can be provided by a shipping carrier. | |
| City | String | False |
The city in which the fulfillment event occurred. | |
| Province | String | False |
The province in which the fulfillment event occurred. | |
| Zip | String | False |
The zip code in the location in which the fulfillment event occurred. | |
| Country | String | False |
The country in which the fulfillment event occurred. | |
| Address1 | String | False |
The fulfillment event's street address. | |
| Latitude | Double | False |
Geographic coordinate specifying the north/south location of a fulfillment event. | |
| Longitude | Double | False |
Geographic coordinate specifying the east/west location of a fulfillment event. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment event was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment event was updated. | |
| HappenedAt | Datetime | True |
The date and time when the fulfillment event occurred. |
Fulfillments
Create, update, and query fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, OrderId, CreatedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
-
If you specify the unique identifier of the order, then this view will only list fulfillment information concerning that order. You can also retrieve a specific fulfillment by specifying OrderId and Id. To retrieve fulfillments associated with a fulfillment order you need to specify the FulfillmentOrderId.
SELECT * FROM Fulfillments WHERE OrderId = '123' SELECT * FROM Fulfillments WHERE OrderId = '123' AND Id = '567' SELECT * FROM Fulfillments WHERE FulfillmentOrderId = '123'
-
This view supports filtering by the CreatedAt and UpdatedAt columns on the server-side.
SELECT * FROM Fulfillments WHERE CreatedAt > '2017-10-25'
Insert
You must specify the FulfillmentOrderId column to insert a fulfillment.
-
Fulfill one line item using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"}]') -
Fulfill one line item using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
Insert INTO OrdersItems#TEMP (ItemId) VALUES ('123')Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LinesAggregate) VALUES ('123', 'OrdersItems#TEMP')In cases that two ore more shop locations are specified in your Shopify account the LocationId needs to be added. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LocationId, LinesAggregate) VALUES ('123', '456', 'OrdersItems#TEMP') -
Fulfill many line items using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"},{\"id\":\"456\"},{\"id\":\"789\"}]') -
Fulfill many line items using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('123') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('456') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('789') INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', 'OrdersItems#TEMP') -
Fulfill all line items, notify the customer, and set a tracking number.
INSERT INTO Fulfillments (FulfillmentOrderId, TrackingNumbers, NotifyCustomer) VALUES ('123', 'FEDEX1', true) -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":5}]') -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 5) INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('456', 'OrdersItems#TEMP') -
Complete a fulfillment (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Complete') -
Transition a fulfillment from pending to open (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Open') -
Cancel a fulfillment (you must specify Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Cancel')
Update
You must specify the OrderId and Id of the fulfillment to fulfill an order.
UPDATE Fulfillments SET TrackingNumbers = 'FedEx123,UPS123' WHERE OrderId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| LocationId [KEY] | Long | False |
A unique numeric identifier for the Location. | |
| NotifyCustomer | Bool | False |
A flag indicating whether the customer should be notified | |
| Status | String | False |
The status of the fulfillment. | |
| Receipt | String | True |
Provides information about the receipt of this fulfillment. | |
| TrackingCompany | String | False |
The name of the tracking company. | |
| TrackingNumbers | String | False |
A list of comma-separated tracking numbers, provided by the shipping company. | |
| TrackingUrls | String | False |
The sum of all the prices of all the items in the fulfillment. | |
| VariantInventoryManagement | String | True |
States the name of the inventory management service. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the fulfillment. | |
| OrderUpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| OrderCreatedAt | Datetime | True |
The date and time when the order was last created. | |
| FulfillmentOrderId | Long | False |
The ID of the fulfillment order that is associated with the fulfillments. |
FulfillmentServices
Query, create, update, and delete information regarding different fulfillment services.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM FulfillmentServices WHERE Id = '123'
Insert
You must specify the Name, CallbackUrl, and Format to create a fulfillment service.
INSERT INTO FulfillmentServices (Name, CallbackUrl, Format) VALUES ('testing fulfillment services', 'http://google.com', 'json')
Update
You must specify the Id to update a fulfillment service. For example:
UPDATE FulfillmentServices SET Name = 'test32', IncludePendingStock = true WHERE Id = '123'
Delete
You must specify the Id of the fulfillment service to delete it.
DELETE FROM FulfillmentServices WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment service. | |
| LocationId | Long | True |
Locations.Id |
The unique identifier of the location tied to the fulfillment service. |
| ProviderId | String | True |
A unique identifier for the fulfillment service provider. | |
| Name | String | False |
The name of the fulfillment service as seen by merchants and their customers. | |
| Handle | String | True |
A human-friendly unique string for the fulfillment service generated from its title. | |
| ServiceName | String | True |
The name of the fulfillment service. | |
| String | False |
The email of the fulfillment service. | ||
| IncludePendingStock | Bool | False |
States if the fulfillment service includes a pending stock. | |
| RequiresShippingMethod | Bool | False |
States if the fulfillment service requires products to be physically shipped. Valid values are 'true' and 'false'. | |
| TrackingSupport | Bool | False |
States if the fulfillment service provides tracking numbers for packages. Valid values are | |
| InventoryManagement | Bool | False |
States if the fulfillment service tracks product inventory and provides updates to Shopify. Valid values are | |
| FulfillmentOrdersOptIn | Bool | False |
States if the fulfillment orders is opt in. | |
| CallbackUrl | String | False |
States the URL endpoint that Shopify needs to retrieve inventory and tracking updates. This field is necessary if either inventory_management or tracking_support is set to | |
| Format | String | False |
Specifies the format of the API output. Valid values are json and xml. |
GiftCards
Create, update, delete, and query gift cards.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the gift card. | |
| APIClientId | Long | True |
The ID of the client that issued the gift card. | |
| Balance | Decimal | True |
The balance of the gift card. | |
| Code | String | False |
The gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters) | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was created. | |
| Currency | String | True |
The currency of the gift card. | |
| CustomerId | Long | True |
Customers.Id |
The ID of the customer associated with this gift card. |
| DisabledAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was disabled. | |
| ExpiresOn | Date | False |
The date (YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date. | |
| InitialValue | Decimal | False |
The initial value of the gift card when it was created. | |
| LastCharacters | String | True |
The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved. | |
| LineItemId | Long | True |
OrdersItems.ItemId |
The ID of the line item that initiated the creation of this gift card, if it was created by an order. |
| Note | String | False |
An optional note that a merchant can attach to the gift card that isn't visible to customers. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that initiated the creation of this gift card, if it was created by an order. |
| TemplateSuffix | String | False |
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. | |
| UserId | Long | True |
Users.Id |
The ID of the user that issued the gift card, if it was issued by a user. |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was last modified. |
InventoryItems
Query and update information regarding different inventory items.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM InventoryItems WHERE Id = '123'
SELECT * FROM InventoryItems WHERE Id IN ('123', '456')
Update
You must specify the Id to update an inventory item. For example:
UPDATE InventoryItems SET Sku = 'lamo', Tracked = false WHERE Id = '123'
UPDATE InventoryItemsSET Cost = 45.95, CountryCodeOfOrigin = 'AU', CountryHarmonizedSystemCodes ='[{"harmonized_system_code":"701912","country_code":"CA"},{"harmonized_system_code":"701912","country_code":"US"}]', HarmonizedSystemCode = '701912', ProvinceCodeOfOrigin = 'NC', SKU = 'Test1', Tracked = FALSE WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| Cost | Decimal | False |
The unit cost of the inventory item. | |
| CountryCodeOfOrigin | String | False |
The two-digit code for the country where the inventory item was made. | |
| CountryHarmonizedSystemCodes | String | False |
An array of country-specific Harmonized System (HS) codes for the item. | |
| HarmonizedSystemCode | String | False |
The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code is not available. | |
| ProvinceCodeOfOrigin | String | False |
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. | |
| SKU | String | False |
The unique SKU (stock keeping unit) of the inventory item. | |
| Tracked | Bool | False |
Whether the inventory item is tracked. If true, then inventory quantity changes are tracked by Shopify. | |
| RequiresShipping | Bool | True |
Whether a customer needs to provide a shipping address when placing an order containing the inventory item. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was last updated. |
InventoryLevels
Query, create, and update information regarding different inventory levels.
Table-Specific Information
Select
To query this table InventoryItemId, LocationId or both should be specified. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123'
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123' AND LocationId = '456'
SELECT * FROM InventoryLevels WHERE InventoryItemId IN ('123', '456') AND LocationId IN ('123', '456')
Insert
-
Adjust the available quantity of an inventory item at a single location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation) VALUES (534169354263, 1448280087, 5, 'Adjust')
-
Connects an inventory item to a location by creating an inventory level at that location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Operation) VALUES (534169354263, 4484497431, 'Connect')
-
Sets the inventory level for an inventory item at a location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation, DisconnectIfNecessary) VALUES (534169354263, 4484497431, 42, 'Set', true)
Delete
You must specify the InventoryItemId and LocationId to delete an inventory level of an inventory item at a location.
DELETE FROM InventoryLevels WHERE InventoryItemId = '153681943' AND LocationId = '45678'
Columns
| Name | Type | ReadOnly | References | Description |
| InventoryItemId [KEY] | Long | False |
The ID of the inventory item that the inventory level belongs to. | |
| LocationId [KEY] | Long | False |
Locations.Id |
The ID of the location that the inventory level belongs to. To find the ID of the location, use the Locations view. |
| Available | Int | False |
The quantity of inventory items available for sale. Returns null if the inventory item is not tracked. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the inventory level was last modified. | |
| Operation | String | False |
An operation to apply to the InventoryLevel. Valid values for order: adjust, connect, set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| RelocateIfNecessary | Bool |
Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. Used in insertions. |
| DisconnectIfNecessary | Bool |
Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. Used in insertions. |
MarketingEvents
Create, update, delete, and query marketing events.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM MarketingEvents
SELECT * FROM MarketingEvents WHERE Id = '123'
Insert
You must specify the MarketingChannel, EventType, Paid, ReferringDomain, and StartedAt columns to create a marketing event. For example:
INSERT INTO MarketingEvents (MarketingChannel, EventType, Paid, ReferringDomain, StartedAt) VALUES ('social', 'ad', true, 'facebook.com', '2018-12-15')
Update
You must specify the Id to update a marketing event. You can modify only timestamps, RemoteId, and budget/currency. For example:
UPDATE MarketingEvents SET RemoteId = '1000:2000', StartedAt = '2018-02-02T00:00 +00:00', EndedAt = '2018-02-03T00:00 +00:00', ScheduledToEndAt = '2018-02-04T00:00 +00:00', Budget = 11.1, BudgetType = 'daily', Currency = 'USD' WHERE Id = '123'
Delete
You must specify the Id of the marketing event to delete it.
DELETE FROM MarketingEvents WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the marketing event. | |
| RemoteId | String | False |
An optional remote identifier for a marketing event. | |
| BreadcrumbId | String | True |
An optional identifier for the breadcrumb of a marketing event. | |
| UTMCampaign | String | True |
A unique name for the UTM campaign. | |
| UTMSource | String | True |
The source of the UTM campaign. | |
| UTMMedium | String | True |
The medium of the UTM campaign. | |
| UTMContent | String | True |
The content of the UTM campaign. | |
| UTMTerm | String | True |
The term of the UTM campaign. | |
| EventTarget | String | True |
The target of the event. | |
| Description | String | True |
A description for the marketing event. | |
| MarketingChannel | String | False |
A broader marketing event type that is focused only on the channel. Must be one of the allowed values (`search`, `display`, `social`, `email`, `referral`). | |
| EventType | String | False |
The specific type of marketing event. Must be one of the allowed values (`ad`, `post`, `message`, `retargeting`, `transactional`, `affiliate`, `loyalty`, `newsletter`, `abandoned_cart`, `receipt`). | |
| Budget | Decimal | False |
The budget of the ad campaign. | |
| Paid | Bool | False |
A boolean field to specify whether this event is paid or organic. | |
| BudgetType | String | False |
The type of the budget; must be either `daily` or `lifetime`. | |
| Currency | String | False |
The currency for the budget. | |
| ManageUrl | String | True |
A link to manage the marketing event, generally in the Shopify app's interface. | |
| PreviewUrl | String | True |
A link to view the live version of the post/ad, or to view a rendered preview of the post/ad/email in the Shopify app. | |
| ReferringDomain | String | False |
The destination domain of the marketing event. Required unless MarketingChannel is one of email/referral/display. | |
| MarketedResources | String | True |
A list of the items that were marketed in the marketing event. It's a list of dictionaries with type keys and id keys. Valid values for type are: (`product`, `collection`, `price_rule`, `page`, `article`, `homepage`). All types, other than homepage, also require an id. | |
| StartedAt | Datetime | False |
The timestamp when the marketing action was started, or when the email was sent, or when the Facebook post was made live, etc. | |
| EndedAt | Datetime | False |
For events with a duration, when the event actually ended. This may differ from ScheduledToEndAt, if the ad was stopped early, etc. | |
| ScheduledToEndAt | Datetime | False |
For events with a duration, when the event was supposed to end. |
Metafields
Retrieves a list of metafields that belong to a resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria for all columns except Value and Description. The supported SQL operators are '=,IN' for the Id, OwnerResource and OwnerId columns, '=' for the Namespace, Key, Type columns and '=,<=,<,>,>=' for the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE Id = 721389482
SELECT * FROM Metafields WHERE ID IN (SELECT Id FROM Customers)
SELECT * FROM Metafields WHERE ID IN (19422939054103, 19422939185175, 19422939250711, 19431415152663, 19431415185431)
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource IN ('product', 'customer')
SELECT * FROM Metafields WHERE OwnerId IN (64146833430, 64146833431) AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'customer' AND OwnerId IN (SELECT Id FROM Customers);
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND UpdatedAt >= '2021-10-13T05:55:08-04:00';
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND Type = 'multi_line_text_field';
Insert
You must specify the NameSpace, Key, and Value to create Metafields.
INSERT INTO Metafields (NameSpace, Key, Value, Type, Description, OwnerResource) VALUES ('inventory', 'warehouse', 25, 'number_integer', 'This is description about data', 'factory')
Update
You must specify the Id to update Metafields. For example:
UPDATE Metafields SET Value = 26 WHERE Id = 19712314851607
Delete
You must specify the Id of the Metafields to delete it.
DELETE FROM Metafields WHERE Id = 19712314851607
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique ID of the metafield. | |
| Namespace | String | False |
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. | |
| Key | String | False |
The name of the metafield. | |
| Value | String | False |
The information to be stored as metadata. | |
| Type | String | False |
The metafield's information type. | |
| Description | String | False |
A description of the information that the metafield contains. | |
| OwnerId | Long | False |
The unique ID of the resource that the metafield is attached to. | |
| OwnerResource | String | False |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was last updated. | |
| AdminGraphqlApiId | String | True |
The admin graphql api id |
OrderRisks
Create, update, delete, and query order risks.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order risk. | |
| CauseCancel | Bool | False |
Whether this order risk is severe enough to force the cancellation of the order. | |
| CheckoutId | Long | True |
The ID of the checkout that the order risk belongs to. | |
| Display | Bool | False |
Whether the order risk is displayed on the order details page in the Shopify admin. | |
| Message | String | False |
The message that's displayed to the merchant to indicate the results of the fraud check. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that the order risk belongs to. |
| Recommendation | String | False |
The recommended action given to the merchant. | |
| Score | Decimal | False |
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 | String | False |
The source of the order risk. |
Orders
Create, update, delete, and query orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, FinancialStatus, FulfillmentStatus, CreatedAt, ProcessedAt and UpdatedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for FinancialStatus, and FulfillmentStatus, and '>' and '<' for the CreatedAt, ProcessedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = '123'
SELECT * FROM Orders WHERE FinancialStatus = 'pending'
SELECT * FROM Orders WHERE CreatedAt > '2017-10-25'
Insert
-
Create a simple order with only a product variant Id using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2}]') -
Create a simple order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using aggregates.
INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, '[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, 'OrdersItems#TEMP') -
Create a simple order, with taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"}]') -
Create a simple order, with taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a simple order, with multiple taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"},{\"price\":4.25,\"rate\":0.025,\"title\":\"County Tax\"}]') -
Create a simple order, with multiple taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (4.25, 0.025, 'County Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a more comprehensive order using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ([{\"title\":\"Big Brown Bear Boots\",\"price\":74.99,\"grams\":1300,\"quantity\":3}]) -
Create a more comprehensive order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemGrams, ItemQuantity) VALUES ('Big Brown Bear Boots', 74.99, 1300, 3) INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a pending order with an existing customer using aggregates.
INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', '456', 'pending') -
Create a pending order with an existing customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('OrdersItems#TEMP', '456', 'pending') -
Create a partially paid order with a new customer and addresses using aggregates.
INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Create a partially paid order with a new customer and addresses using temporary.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('OrdersItems#TEMP', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Close an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Close') -
Reopen an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Open') -
Cancel an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Cancel')
Update
Only columns BuyerAcceptsMarketing, Email, Phone, Note, Tags, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressPhone, ShippingAddressCity, ShippingAddressCompany, ShippingAddressZip, ShippingAddressProvince, ShippingAddressCountry, ShippingAddressLatitude, ShippingAddressLongitude, ShippingAddressName, ShippingAddressCountryCode, ShippingAddressProvinceCode and ShippingAddressDefault can be updated.
-
Update the shipping address of an existing order.
UPDATE Orders SET ShippingAddressAddress1 = '123 Ship Street', ShippingAddressCity = 'Shipsville' WHERE Id = '123'
-
Update an order's tags.
UPDATE Orders SET Tags = 'External, Inbound, Outbound' WHERE Id = '123'
Delete
You must specify the Id of the order when deleting an item from this table.
DELETE FROM Orders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| Number | Long | True |
A unique identifier for the order, used by the shop owner and customer. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerFirstName | String | False |
The first name of the customer. | |
| CustomerLastName | String | False |
The last name of the customer. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalDiscounts | Decimal | True |
The total amount of the discounts to be applied to the price of the order. | |
| TotalOrderItemsPrice | Decimal | True |
The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TotalWeight | Int | True |
The sum of all the weights of the line items in the order, in grams. | |
| BrowserIp | String | True |
The IP address of the browser used by the customer when placing the order. | |
| BuyerAcceptsMarketing | Bool | False |
Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | True |
The reason why the order was canceled. | |
| CartToken | String | True |
Unique identifier for a particular cart that is attached to a particular order. | |
| OrderStatusUrl | String | True |
The URL pointing to the order status web page. | |
| Token | String | True |
Unique identifier for a particular order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| SourceName | String | True |
Where the order originated. | |
| ReferringSite | String | True |
The website that the customer clicked on to come to the shop. | |
| Phone | String | False |
The customer's phone number. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| LocationId | Long | True |
The unique numeric identifier for the physical location at which the order was processed. | |
| LandingSite | String | True |
The URL for the page where the buyer landed when entering the shop. | |
| Tags | String | False |
Additional short descriptors. | |
| FulfillmentStatus | String | False |
The fulfillment status of the order. Valid values during SELECT: shipped, partial, unshipped, any, unfulfilled. Valid values during INSERT: fulfilled, null, partial, restocked. | |
| FinancialStatus | String | False |
The financial status of the order. Valid values during SELECT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid. Valid values during INSERT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded. | |
| CustomerLocale | String | True |
The customer locale of the order. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| DiscountCodes | String | True |
Applicable discount codes that can be applied to the order. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the order. | |
| TaxAggregate | String | False |
A JSON aggregate of tax line items associated with the order. Note, these taxes are applied on the order, not on individual items. If you want them to be applied on individual items, use them in LineAggregate. Tax lines must be associated with either order or line item but not both. | |
| ShippingAggregate | String | False |
A JSON aggregate of shipping line items associated with the order. | |
| NoteAttributesAggregate | String | False |
A JSON aggregate of note attributes associated with the order. | |
| DiscountApplicationsAggregate | String | True |
An ordered list of stacked discount applications. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| PaymentTermsAmount | Long | True |
The amount that is owed according to the payment terms. | |
| PaymentTermsCurrency | String | True |
The presentment currency for the payment. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the selected payment terms template for the order. | |
| PaymentTermsPaymentTermsType | String | True |
The type of selected payment terms template for the order. | |
| PaymentTermsDueInDays | Int | True |
The number of days between the invoice date and due date that is defined in the selected payment terms template. | |
| PaymentTermsPaymentSchedules | String | True |
An array of schedules associated to the payment terms. | |
| ProcessedAt | Datetime | True |
The date and time when the order was imported, in ISO 8601 format. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| SendReceipt | Bool | False |
Determines whether an order confirmation will be sent to the customer. | |
| SendFulfillmentReceipt | Bool | False |
Determines whether a fulfillment confirmation will be sent to the customer. | |
| InventoryBehaviour | String | False |
Determines which inventory updating behavior is used. The following values are available: default, decrement_ignoring_policy, decrementobeying_policy | |
| Operation | String | False |
An operation to apply to the Order. Valid values for order: Close, Open, or Cancel. | |
| TotalShippingPriceSetShopMoneyAmount | Double | True |
The amount of the shop money in the total shipping price set. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
The currency code of the shop money in the total shipping price set. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total shipping price set. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total price set. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total price set. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total tax set. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total tax set. | |
| CheckoutId | Long | True |
The checkout id. | |
| CheckoutToken | String | True |
A unique value when referencing the checkout that's associated with the order. | |
| EstimatedTaxes | Bool | True |
Estimated taxes of the order. | |
| Test | Bool | True |
Test boolean for the order. | |
| TotalOutstanding | Decimal | True |
The outstanding sum of all the items in the order. | |
| TotalTipReceived | Decimal | True |
The total tip for the order. | |
| PresentmentCurrency | String | True |
The currency code of the presentment money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total line items price set. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total line items price set. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the discounts set. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the discounts set. | |
| TotalSubtotalSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the subtotal. | |
| TotalSubtotalSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the subtotal. | |
| OrigTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total additional fees set. | |
| OrigTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total additional fees set. | |
| CurTotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total discounts set. | |
| CurTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total discounts set. | |
| CurSubtotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current subtotal price set. | |
| CurSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current subtotal price set. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total tax set. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total tax set. | |
| CurTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total additional fees set. | |
| CurTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total additional fees set. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total price set. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total price set. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total duties set. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total duties set. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total duties set. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total duties set. | |
| PaymentGatewayNames | String | True |
The list of payment gateway names | |
| FulfillmentAggregate | String | True |
A JSON aggregate of fulfillments associated with the order. Note, these fulfillments are applied on the order, not on individual items. | |
| RefundAggregate | String | True |
A JSON aggregate of refunds associated with the order. Note, these refunds are applied on the order, not on individual items. | |
| ConfirmationNumber | String | True |
A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. This value isn't guaranteed to be unique. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Status | String |
Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
OrderTransactions
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM OrderTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of transactions and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving transactions. Therefore to retrieve all the transactions, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the transactions for each OrderId to build the result set.
SELECT * FROM OrderTransactions WHERE Kind = 'Capture'
Insert
You must specify the OrderId and Kind when inserting a transaction.
-
Capture a specified amount on a previously authorized order.
INSERT INTO OrderTransactions (OrderId, Amount, Kind) VALUES ('123', 10.25, 'Capture') -
Capture a previously authorized order for the full amount.
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'Capture') - Create an Authorization transaction :
INSERT INTO OrderTransactions (OrderId, Kind, Authorization) VALUES ('123', 'authorization', '7') - Create a Capture transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'capture') - Create a Sale transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'sale') - Create a Void transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Currency, Amount) VALUES ('123', 'void', '456', 'USD', '0.1') - Create a Refund transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Amount) VALUES ('123', 'refund', '456', '1440.00')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the transaction. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| UserId | Long | True |
The unique identifier for the user. | |
| LocationId | Long | True |
The ID of the physical location where the transaction was processed. | |
| Amount | Decimal | False |
The amount of money that the transaction was for. | |
| Authorization | String | False |
The authorization code associated with the transaction. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| DeviceId | String | True |
The unique identifier for the device. | |
| Gateway | String | False |
The name of the gateway the transaction was issued through. | |
| SourceName | String | True |
The origin of the transaction. | |
| Kind | String | False |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. | |
| Message | String | True |
The message associated with this transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| Status | String | False |
The status of the transaction. | |
| Test | Bool | True |
The option to use the transaction for testing purposes. | |
| AVSResultCode | String | True |
The Response code from the address verification system. | |
| CreditCardBin | String | True |
The issuer identification number (IIN). | |
| CVVResultCode | String | True |
The Response code from the credit card company. | |
| CreditCardNumber | String | True |
The customer's credit card number, with most of the leading digits redacted with Xs. | |
| CreditCardCompany | String | True |
The name of the company who issued the customer's credit card. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| PaymentsRefundsAttributesStatus | String | True |
The current status of the refund | |
| PaymentsRefundsAttributesAcquirerReferenceNumber | String | True |
A unique number associated with the transaction that can be used to track the refund. | |
| PaymentId | String | True |
The unique identifier for the payment. | |
| ProcessedAt | Datetime | True |
The date and time when the transaction was processed. | |
| CreditCardName | String | True |
The name on the customer's credit card. | |
| CreditCardWallet | String | True |
The wallet of the customer's credit card. | |
| CreditCardExpMonth | Long | True |
The expiration month of the customer's credit card. | |
| CreditCardExpYear | Long | True |
The expiration year of the customer's credit card. | |
| Receipt | String | True |
A JSON aggregate of the order receipt. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total unsettled set. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total unsettled set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| TransactionItemAmount | Decimal |
The amount of money that the transaction was for. Use this when inserting transactions into an order or refund. |
| TransactionItemGateway | String |
The name of the gateway the transaction was issued through. Use this when inserting transactions into an order or refund. |
| TransActionItemKind | String |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. Use this when inserting transactions into an order or refund. |
| TransactionItemStatus | String |
The status of the transaction. Use this when inserting transactions into an order or refund. |
| TransactionItemParentId | String |
The parent id of the transaction. Use this when inserting transactions into a refund. |
| TransactionItemSource | String |
The status of the transaction. |
| UpdatedAt | Datetime |
The last time the order is updated. |
Pages
Create, read, update or delete pages
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, CreatedAt, Handle, PublishedAt, Title, UpdatedAt, PublishedStatus columns. The following queries are the only ones processed server-side:SELECT * FROM Pages
SELECT * FROM Pages WHERE Id = '123'
SELECT * FROM Pages WHERE CreatedAt > '2018-05-02'
SELECT * FROM Pages WHERE Handle = 'test'
SELECT * FROM Pages WHERE PublishedAt <= '2018-05-02'
SELECT * FROM Pages WHERE Title = 'new title'
SELECT * FROM Pages WHERE UpdatedAt >= '2018-05-02'
SELECT * FROM Pages WHERE PublishedStatus >= 'published'
Insert
You must specify the Title to create a Page.
INSERT INTO Pages (title) VALUES ('new Page')
Update
You must specify the id to update a Page. For example:
UPDATE Pages SET author = 'Harry' WHERE Id = '77171130'
Delete
You must specify the Id of the Page to delete it.
DELETE FROM Pages WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique numeric identifier for the page. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the person who created the page. | |
| BodyHtml | String | False |
The text content of the page, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was created. | |
| Handle | String | False |
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. | |
| Metafields | String | False |
Additional information attached to the Page object. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden. | |
| ShopId | Long | True |
The ID of the shop to which the page belongs. | |
| TemplateSuffix | String | False |
The suffix of the Liquid template being used. | |
| Title | String | False |
The page's title. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was last updated. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
PriceRules
Create, update, delete, and query price rules.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM PriceRules WHERE Id = '123'
Insert
You must specify the Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, and AllocationMethod columns to create a price rule. For example:
INSERT INTO PriceRules (Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, AllocationMethod) VALUES ('SUMMERSALE10OFF', 'line_item', 'all', 'fixed_amount', '-10.0', 'all', '2017-01-19T17:59:10Z', 'across')
Update
You must specify the Id to update a price rule. For example:
UPDATE PriceRules SET Title = 'SUMMERSALE10OFF' WHERE Id = '123'
Delete
You must specify the Id of the price rule to delete it.
DELETE FROM PriceRules WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the price rule. | |
| AllocationMethod | String | False |
The allocation method of the price rule. Valid values: each: The discount is applied to each of the entitled items. across: The calculated discount amount will be applied across the entitled items. | |
| CustomerSelection | String | False |
The customer selection for the price rule. Valid values: all: The price rule is valid for all customers. prerequisite: The customer must either belong to one of the customer saved searches specified by PrerequisiteSavedSearchIds. | |
| EntitledCollectionIds | String | False |
A list of Ids of collections whose products will be eligible to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. It can't be used in combination with EntitledProductIds or EntitledVariantIds. | |
| EntitledCountryIds | String | False |
A list of Ids of shipping countries that will be entitled to the discount. It can be used only with TargetType set to shipping_line and TargetSelection set to entitled. | |
| EntitledProductIds | String | False |
A list of Ids of products that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| EntitledVariantIds | String | False |
A list of Ids of product variants that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| OncePerCustomer | Bool | False |
Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer Id. | |
| PrerequisiteCustomerIds | String | False |
A list of customer Ids which for the price rule to be applicable, the customer must match one of the specified customers. If PrerequisiteCustomerIds is populated, then PrerequisiteSavedSearchIds must be empty. | |
| PrerequisiteQuantityRange | String | False |
The minimum number of items for the price rule to be applicable. It has the following property: greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value. | |
| PrerequisiteSavedSearchIds | String | False |
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 PrerequisiteSavedSearchIds is populated, then PrerequisiteCustomerIds must be empty. | |
| PrerequisiteShippingPriceRange | String | False |
The maximum shipping price for the price rule to be applicable. It has the following property: less_than_or_equal_to: The shipping price must be less than or equal to this value. | |
| PrerequisiteSubtotalRange | String | False |
The minimum subtotal for the price rule to be applicable. It has the following property: 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. | |
| TargetSelection | String | False |
The target selection method of the price rule. Valid values: all: The price rule applies the discount to all line items in the checkout, entitled: The price rule applies the discount to selected entitlements only. | |
| TargetType | String | False |
The target type that the price rule applies to. Valid values: line_item: The price rule applies to the cart's line items, shipping_line: The price rule applies to the cart's shipping lines. | |
| UsageLimit | Int | False |
The maximum number of times the price rule can be used, per discount code. | |
| PrerequisiteProductIds | String | False |
List of product ids that will be a prerequisites for a Buy X Get Y type discount. The PrerequisiteProductIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product variant is included in PrerequisiteVariantIds, then PrerequisiteProductIds can't include the ID of the product associated with that variant. | |
| PrerequisiteVariantIds | String | False |
List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The EntitledVariantIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product is included in PrerequisiteProductIds, then PrerequisiteVariantIds can't include the ID of any variants associated with that product. | |
| PrerequisiteCollectionIds | String | False |
List of collection ids that will be a prerequisites for a Buy X Get Y discount. The EntitledCollectionIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Cannot be used in combination with PrerequisiteProductIds or PrerequisiteVariantIds. | |
| Value | Decimal | False |
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. | |
| ValueType | String | False |
The value type of the price rule. Valid values: fixed_amount: Applies a discount of value as a unit of the store's currency. For example, if value is -30 and the store's currency is USD, then $30 USD is deducted when the discount is applied, percentage: Applies a percentage discount of value. For example, if value is -30, then 30% will be deducted when the discount is applied. If TargetType is shipping_line, then only percentage is accepted. | |
| PrerequisiteToEntitlementQuantityRatio | String | False |
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 PrerequisiteToEntitlementQuantityRatio can be used only with: ValueType set to percentage, TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each, PrerequisiteProductIds or PrerequisiteVariantIds or PrerequisiteCollectionIds defined and EntitledProductIds or EntitledVariantIds or EntitledCollectionIds defined. | |
| Images | String | False |
A list of image objects. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| StartsAt | Datetime | False |
The date and time when the price rule starts. | |
| EndsAt | Datetime | False |
The date and time when the price rule ends. Must be after StartsAt. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the price rule was created. | |
| UpdatedAt | Datetime | True |
The date and time when the price rule was last modified. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductImages
Query, Update and Delete Product Images
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ImageId. The supported SQL operators are '=' for ProductId and '=' for ImageId. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM ProductImages WHERE ProductId = '123'
SELECT * FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Insert
To create a new product image with image data as attachment
INSERT INTO ProductImages (productid, filename, attachment) VALUES ('64146735127', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
To create a new product image using a source URL that will be downloaded by Shopify
INSERT INTO ProductImages (productid, filepath) VALUES ('64146735127', 'http://example.com/rails_logo.gif')")
To create a new product image and make it the main image
INSERT INTO ProductImages (productid, position, filename, filepath) VALUES ('64146735127', 1, 'test.png', 'http://example.com/rails_logo.gif')")
To create a new product image and attach it to product variants
INSERT INTO ProductImages (productid, variantids, filename, attachment) VALUES ('64146735127', '[808950810,457924702]', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
Update
To update a product image you must specify its ProductId and ImageId.
To change the position and alt tag content for an image
UPDATE ProductImages SET Position = 1, Alt = 'This is the main image' WHERE ProductId = '123' AND ImageId = '2342'
To add it to product variants for an image
UPDATE ProductImages SET VariantIds = '[808950810,457924702]' WHERE ProductId = '123' AND ImageId = '2342'
Delete
To delete a product image you must specify its Id.
DELETE FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Columns
| Name | Type | ReadOnly | References | Description |
| ImageId [KEY] | Long | True |
A unique numeric identifier for the product image. | |
| ProductId | Long | True |
Products.Id |
The id of the product associated with the image. |
| VariantIds | String | False |
The array of variant ids associated with the image. | |
| Position | Int | False |
The order of the product image in the list. | |
| FilePath | String | False |
Full path to the image. Can be locally or online. Example: http://example.com/rails_logo.gif. Either this or Base64Content are required. | |
| Width | Int | True |
The width of the image. | |
| Height | Int | True |
The height of the image. | |
| CreatedAt | Datetime | True |
The datetime when the image was created. | |
| UpdatedAt | Datetime | True |
The datetime when the image was updated. | |
| Alt | String | False |
The Alt content of the image. | |
| Src | String | False |
Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FileName | String |
The name that the image will be displayed in the application. |
| Attachment | String |
Base64 encoded bytes of the image. Either this or FilePath are required. |
ProductListings
Query and delete product listings.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and Handle columns. The supported SQL operators are '=' and 'IN' for ProductId and '=' and 'IN' for Handle column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM ProductListings WHERE ProductId = '123'
SELECT * FROM ProductListings WHERE ProductId IN ('123', '456')
SELECT * FROM ProductListings WHERE Handle = 'ipod-nano'
SELECT * FROM ProductListings WHERE Handle IN ('ipod-nano', 'ipod-nano2')
Delete
Delete a product listing to unpublish a product from your app (ProductId is required):
DELETE FROM ProductListings WHERE Productid = 512433520663
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
The unique identifer of the product this listing is for. The primary key for this resource. | |
| Title | String | False |
The name of the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Variants | String | True |
A list of variant objects, each one representing a slightly different version of the product. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Tags | String | False |
A categorization that a product can be tagged with, commonly used for filtering. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
ProductOptions
Query product options.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ProductUpdatedAt columns. The supported SQL operators are '=' for ProductId and '>' and '<' for ProductUpdatedAt.
Select
SELECT * FROM ProductOptions WHERE ProductId = '123'
SELECT * FROM ProductOptions WHERE ProductUpdatedAt > '2018-05-10'
Update
To update a product option, you must include the ProductId. For example:
UPDATE ProductOptions SET Name='test' where ProductId='123'"
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The id of the product option. | |
| ProductId | Long | True |
Products.Id |
The id of the product. |
| ProductUpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| Name | String | False |
The name of the product option. | |
| Position | Int | True |
The position of the product option. | |
| Values | String | True |
The values of the product option. |
ProductResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ProductResourceFeedbacks
SELECT * FROM ProductResourceFeedbacks WHERE ProductId = '123'
SELECT * FROM ProductResourceFeedbacks WHERE ProductId IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ProductResourceFeedbacks] ([ProductId], [State], [Messages], [ResourceUpdatedAt], [FeedbackGeneratedAt]) VALUES (6578879004695, 'requires_action', 'My message.', '2023-05-05 09:00:00', '2023-05-05 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| ProductId | Long | False |
Products.Id |
Unique id of the resource. |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
Products
List of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the following columns: Id, Title, Vendor, Handle, ProductType, PublishedStatus, CreatedAt, PublishedAt, and UpdatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Products WHERE Id = '123'
SELECT * FROM Products WHERE Id IN ('123', '456')
SELECT * FROM Products WHERE CreatedAt > '2017-10-25'
SELECT * FROM Products WHERE Title = 'just a title'
SELECT * FROM Products WHERE Vendor = 'just a vendor'
Insert
-
Create a new product with the default product variant.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air') -
Create a new unpublished product.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags, Published) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air', false)
Update
To update a product you must specify its Id.
UPDATE Products SET Published = true WHERE Id = '123'
UPDATE Products SET MetafieldsGlobalTitleTag = 'Brand new title', MetafieldsGlobalDescriptionTag = 'Brand new description' WHERE Id = '123'
Delete
To delete a product you must specify its Id.
DELETE FROM Products WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Variants | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| Status | String | False |
The status of the product. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| PublishedStatus | String | True |
Return products by their published status: published: show only published products;unpublished: show only unpublished products; any: show all products. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it. |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductVariants
List of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and ProductId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM ProductVariants WHERE Id = '123'
SELECT * FROM ProductVariants WHERE Id IN ('123', '456')
SELECT * FROM ProductVariants WHERE ProductId = '456'
Insert
You must specify the ProductId to insert a product variant.
INSERT INTO ProductVariants (ProductId, Option1, Price) VALUES ('123', 'Yellow', 3.5)
Update
You must specify the Id of the variant to edit a product variant.
-
Update the title and price of an existing variant.
UPDATE ProductVariants SET Option1 = 'Pink', Price = 99.99 WHERE Id = '123'
Delete
You must specify the ProductId and the Id of the variant to delete a product variant.
DELETE FROM ProductVariants WHERE Id = '123' AND ProductId = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product variant. | |
| ProductId | Long | False |
A unique numeric identifier for the product this variant belongs to. | |
| InventoryItemId | Long | False |
The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information. | |
| ImageId | Long | False |
A unique numeric identifier for the image this variant belongs to. | |
| Price | Decimal | False |
The price of the product variant. | |
| CompareAtPrice | String | False |
The competitors prices for the same item. | |
| Title | String | False |
The name of the product. | |
| Grams | Int | False |
The weight of the product variant in grams. | |
| Barcode | String | False |
A human-friendly unique string for the Product automatically generated from its title. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified. | |
| WeightUnit | String | True |
The unit of measurement that applies to the product's variant weight. | |
| FulfillmentService | String | False |
Service which is doing the fulfillment. | |
| InventoryManagement | String | False |
Specifies whether or not Shopify tracks the number of items in stock for this product variant. | |
| InventoryPolicy | String | True |
Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock. Valid values are deny or continue. | |
| InventoryQuantity | Int | True |
The number of items in stock for this product variant. Default value 1. | |
| Option1 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option2 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option3 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Position | Int | False |
The order of the product variant in the list of product variants. | |
| RequiresShipping | Bool | False |
Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant. | |
| Sku | String | False |
A unique identifier for the product in the shop. | |
| Taxable | Bool | False |
Specifies whether or not a tax is charged when the product variant is sold. | |
| CreatedAt | Datetime | True |
The date and time when the product variant was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
Provinces
Query and update information regarding different provinces.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CountryId and Id columns. The supported SQL operator is '=' for ProductId and Id columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Provinces WHERE CountryId = '123'
SELECT * FROM Provinces WHERE CountryId = '123' and Id = '456'
Update
You must specify the CountryId and Id to update a province. For example:
UPDATE Provinces SET Tax = '3.4' WHERE CountryId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the province. | |
| CountryId [KEY] | Long | True |
Countries.Id |
The ID for the country that the province belongs to. |
| Name | String | False |
The full name of the province. | |
| Code | String | False |
The standard abbreviation for the province. | |
| Tax | Decimal | False |
The sales tax rate to be applied to orders made by customers from this province.. | |
| TaxPercentage | Double | False |
The province's tax in percent format. | |
| TaxName | String | False |
The name of the tax for this province. | |
| TaxType | String | False |
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. | |
| ShippingZoneId | Long | True |
The ID for the shipping zone that the province belongs to. |
RecurringApplicationCharges
Create, update, delete, and query Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM RecurringApplicationCharges
SELECT * FROM RecurringApplicationCharges WHERE Id = '123'
Update
UPDATE RecurringApplicationCharges SET Test = 'true', Name = 'cd' WHERE Id = '2'
Delete
You must specify the Id of the recurring application charge to delete it.
DELETE FROM RecurringApplicationCharges WHERE Id = '2'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the recurring application charge. | |
| Name | String | False |
The name of the recurring application charge. | |
| ApiClientId | String | False |
The API Client Id | |
| Price | Decimal | False |
The price of the recurring application charge. The maximum price is 10,000. | |
| Status | String | False |
The status of the recurring charge | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting the charge. | |
| BillingOn | Date | False |
The date and time (ISO 8601 format) when the customer was billed. | |
| Test | String | False |
Whether the application charge is a test transaction. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was created. | |
| UpdatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was last updated. | |
| ActivatedOn | Datetime | False |
The date and time (ISO 8601 format) when the customer activated the recurring application charge. | |
| CancelledOn | Datetime | False |
The date and time (ISO 8601 format) when the merchant canceled their recurring application charge. | |
| TrialDays | Int | False |
The number of days that the customer is eligible for a free trial. | |
| TrialEndsOn | Datetime | False |
The date and time (ISO 8601 format) when the free trial ends. | |
| DecoratedReturnUrl | String | False |
The decorated return url. | |
| CappedAmount | String | False |
The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property. | |
| ConfirmationUrl | String | False |
The URL where the merchant accepts or declines the recurring application charge. | |
| Terms | String | False |
The terms and conditions of usage based billing charges. Must be present in order to create usage charges, |
Redirects
Create, read, update or delete redirects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Redirects
SELECT * FROM Redirects WHERE Id = '123'
SELECT * FROM Redirects WHERE Target = '/pqr.jsp'
SELECT * FROM Redirects WHERE Path = '/abc.php'
Insert
You must specify path and target to create a Redirect.
INSERT INTO Redirects (path, target) VALUES ('/abc.php', '/pqr.jsp')
Update
You must specify the id to update a Redirect. For example:
UPDATE Redirects SET Path = '/abc.php' WHERE Id = '77171130'
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM Redirects WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the redirect. | |
| Path | String | False |
The old path to be redirected. | |
| Target | String | False |
The target location where the user will be redirected. |
Refunds
Create and query refunds.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
If you specify the unique identifier of the Order, then this view will only list refund information concerning that order.
SELECT * FROM Refunds WHERE OrderId = '179098550295'
SELECT * FROM Refunds WHERE OrderId = '179098550295' AND Id = '7382073367'
Insert
You must specify the OrderId when inserting a refund.
-
Create a new refund for an order using aggregates.
INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]') -
Create a new refund for an order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, 'OrdersItems#TEMP') -
Create a new refund for an order and attach a transaction to the refund as well using aggregates.
INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]', '[{\"kind\":\"refund\",\"amount\":5.5,\"gateway\":\"gw\",\"parent_id\":\"789\"}]') -
Create a new refund for an order and attach a transaction to the refund as well using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Transactions#TEMP (TransactionItemParentId, TransactionItemAmount, TransactionItemKind, TransactionItemGateway) VALUES ('789', 5.5, 'refund', 'gw') INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', 'OrdersItems#TEMP', 'Transactions#TEMP') -
Refund a specific amount of shipping using aggregates.
INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, '[{\"parent_id\":\"456\"}]') -
Refund a specific amount of shipping using temporary table.
INSERT INTO Transactions#TEMP (TransactionItemParentId) VALUES ('456') INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, 'Transactions#TEMP')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique identifier for the refund. | |
| OrderId | Long | False |
Orders.Id |
The id of the order. |
| OrderUpdatedAt | Datetime | True |
Orders.UpdatedAt |
The date and time when the order was last modified. |
| Note | String | False |
The optional note attached to a refund. | |
| Restock | Bool | True |
Whether or not the line items were added back to the store inventory. | |
| UserId | Long | True |
The unique identifier of the user who performed the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| ProcessedAt | Datetime | True |
The date and time when the refund was imported. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the refund. | |
| OrderTransactionAggregate | String | False |
A JSON aggregate of transactions associated with the refund. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Notify | Bool |
Whether or not to send a refund notification to the customer. |
| DiscrepancyReason | String |
An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other) |
| ShippingAmount | Decimal |
Set specific amount of shipping to refund. Takes precedence over FullRefund. |
| ShippingFullRefund | Bool |
Whether or not to to refund all remaining shipping. |
ResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ResourceFeedbacks
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ResourceFeedbacks] ([State], [Messages], [FeedbackGeneratedAt]) VALUES ('requires_action', 'Wow wow.', '2023-09-13 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
ScriptTags
Create, read, update or delete script tags.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. For CreatedAt and UpdatedAt the supported SQL operators are '>' and '<'. The following queries are the only ones processed server-side:SELECT * FROM ScriptTags
SELECT * FROM ScriptTags WHERE Id = '123'
SELECT * FROM ScriptTags WHERE CreatedAt > '2018-05-02'
SELECT * FROM ScriptTags WHERE UpdatedAt < '2017-08-15'
SELECT * FROM ScriptTags WHERE Src = 'https://example.com/my_script.js'
Insert
You must specify event and src to create a ScriptTag.
INSERT INTO Scripttags (event, src) VALUES ('onload', 'https://js-aplenty.com/abc.js')
Update
You must specify the id to update a ScriptTag. For example:
UPDATE ScriptTags SET src = 'https://js-aplenty.com/abc.js' WHERE Id = '77171130'
Delete
You must specify the Id of the ScriptTag to delete it.
DELETE FROM ScriptTags WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the script tag. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was created. | |
| DisplayScope | String | False |
The page or pages on the online store where the script should be included. | |
| Event | String | False |
The DOM event that triggers the loading of the script. Valid values: onload. | |
| Src | String | False |
The URL of the remote script. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was last updated. |
SmartCollections
Query, insert, update, or delete information regarding different smart collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, PublishedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for the ProductId, Title, Handle, and PublishedStatus columns and '>' and '<' for the UpdatedAt and PublishedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM SmartCollections WHERE Id = '123'
SELECT * FROM SmartCollections WHERE Id IN ('123', '456')
SELECT * FROM SmartCollections WHERE ProductId = '123'
SELECT * FROM SmartCollections WHERE Title = 'Ducks'
SELECT * FROM SmartCollections WHERE Handle = 'frontpage'
SELECT * FROM SmartCollections WHERE PublishedStatus = 'published'
SELECT * FROM SmartCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM SmartCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title and Rules to create a smart collection. For example:
INSERT INTO SmartCollections (Title, Rules) VALUES ('IPods', '[{"column": "vendor","relation": "equals","condition": "Apple"}]')
Update
You must specify the smart collection Id to update a smart collection. For example:
UPDATE SmartCollections SET BodyHtml = '5000 songs in your pocket' WHERE Id = '123'
Delete
You must specify the Id of the smart collection to delete it.
DELETE FROM SmartCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the smart collection. | |
| Title | String | False |
The name of the smart collection. Maximum length: 255 characters. | |
| BodyHtml | String | False |
The description of the smart collection. Includes HTML markup. Many shop themes display this on the smart collection page. | |
| Image | String | False |
A JSON aggregate with information regarding the image of smart collection. | |
| Rules | String | False |
A JSON aggregate with the list of rules that define what products go into the smart collection. Valid values for each rule field: column: tag, title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title; relation: equals, greater_than, less_than, starts_with, ends_with, contains; condition: any string | |
| Handle | String | False |
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) | |
| Disjunctive | Bool | False |
Whether the product must match all the rules to be included in the smart collection. Valid values: true: products only need to match one or more of the rules to be included in the smart collection, false: products must match all of the rules to be included in the smart collection. | |
| SortOrder | String | False |
The order in which products in the smart collection appear. | |
| TemplateSuffix | String | False |
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. | |
| PublishedScope | String | False |
Whether the smart collection is published to Point of Sale. Valid values: web: The smart collection is published to the shop's online channels and not published to the Point of Sale channel, global: The smart collection is published to both the online channels and the Point of Sale channel. | |
| UpdatedAt | Datetime | True |
The date and time when the smart collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the smart collection was published. Returns null when the collection is hidden. | |
| ProductId | String | True |
Show smart collections that include a given product. | |
| PublishedStatus | String | True |
Show smart collection with a given published status: published: show only published smart collections, unpublished: show only unpublished smart collections, any: show all smart collections. (default: any). |
Themes
Create, read, update or delete themes
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Theme
SELECT * FROM Themes WHERE Id = '123'
Insert
You must specify name to create a Theme.
INSERT INTO Themes (name) VALUES ('NewTheme')
Update
You must specify the id to update a Theme. For example:
UPDATE Themes SET name = 'NewTheme' WHERE Id = '77171130'
Delete
You must specify the Id of the Theme to delete it.
DELETE FROM Themes WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the theme. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the theme was created. | |
| Name | String | False |
The name of the theme. | |
| Previewable | Bool | True |
Whether the theme can currently be previewed. | |
| Processing | Bool | True |
Whether files are still being copied into place for this theme. | |
| Role | String | False |
Specifies how the theme is being used within the shop. | |
| ThemeStoreId | Long | True |
A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store. | |
| UpdatedAt | Datetime | True |
The date and time ( ISO 8601 format) when the theme was last updated. |
UsageCharges
Create or view Usage Charges for Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM UsageCharges WHERE Id = 123
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619 AND Id = 123
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the usage charge. | |
| Description | String | False |
The name of the usage charge. | |
| Price | Decimal | False |
The price of the usage charge. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the usage charge was created. | |
| BillingOn | Date | False |
The date and time (ISO 8601 format) when the customer is billed. | |
| BalanceUsed | Decimal | False |
The used balance | |
| BalanceRemaining | Decimal | False |
The remaining balance | |
| RiskLevel | Int | False |
The risk Level | |
| RecurringApplicationId | Long | False |
The Id of the RecurringApplication Charge |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| AbandonedCheckouts | Query abandoned checkouts. |
| AbandonedCheckoutsItems | Query abandoned checkouts items. |
| AssignedFulfillmentOrders | The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level. |
| DiscountApplications | Query note attributes belonging to an order or draft order. |
| DraftOrderItemProperties | Query order item properties. |
| DraftOrderItems | Query draft order items. |
| DraftOrderItemTaxLines | Query draft order items tax lines. |
| Events | Retrieve events which have happened in your shop. |
| FulfillmentOrders | Query fulfillment orders. |
| Locations | Retrieve information regarding store locations. |
| NoteAttributes | Query note attributes belonging to an order or draft order. |
| OrderDiscountCodes | Query note attributes belonging to an order or draft order. |
| OrderItemDiscountAllocations | Query order item discount allocations. |
| OrderItemProperties | Query order item properties. |
| OrdersItems | Query order items. |
| Payouts | Retrieves a list of all payouts ordered by payout date, with the most recent being first. |
| PayoutTransactions | Retrieves a list of all balance transactions ordered by processing time, with the most recent being first. |
| RefundAdjustments | Create and query transactions. |
| RefundsItems | Get data on OrdersItems that have been refunded. |
| RefundTransactions | Query transactions for Refund Object. |
| Reports | To query all the Reports. |
| ShippingItemDiscountAllocations | Query Shipping item discount allocations. |
| ShippingItems | Query order shipping. |
| ShippingZones | Retrieve information regarding shipping zones. |
| Shop | Contains general settings and information about the shop. |
| TaxItems | Query order taxes. |
| Users | Query Users. |
AbandonedCheckouts
Query abandoned checkouts.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckouts WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the order. | |
| AbandonedCheckoutUrl | String | The full recovery URL to be sent to a customer to recover their abandoned checkout. | |
| BuyerAcceptsMarketing | Bool | Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | The reason why the order was cancelled. | |
| CartToken | String | Unique identifier for a particular cart that is attached to a particular order. | |
| Currency | String | The three letter code (ISO 4217) for the currency used for the payment. | |
| CustomerId | Long |
Customers.Id | A unique numeric identifier for the customer. |
| DiscountCodes | String | Applicable discount codes that can be applied to the order. | |
| String | The customer's email address. | ||
| Note | String | The text of an optional note that a shop owner can attach to the order. | |
| LandingSite | String | The URL for the page where the buyer landed when entering the shop. | |
| ReferringSite | String | The website that the customer clicked on to come to the shop. | |
| SourceName | String | Where the order originated. | |
| SubtotalPrice | Decimal | Price of the order before shipping and taxes. | |
| TotalDiscounts | Decimal | The total amount of the discounts to be applied to the price of the order. | |
| TotalLineItemsPrice | Decimal | The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | The sum of all the prices of all the items in the order, taxes and discounts included. | |
| TotalTax | Decimal | The sum of all the taxes applied to the order. | |
| TotalWeight | Double | The sum of all the weights of the line items in the order, in grams. | |
| TaxesIncluded | Bool | States whether or not taxes are included in the order subtotal. | |
| Token | String | Unique identifier for a particular order. | |
| BillingAddressFirstName | String | The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | The last name of the person associated with the payment method. | |
| BillingAddressAdress1 | String | The street address of the billing address. | |
| BillingAddressAdress2 | String | An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | The phone number at the billing address. | |
| BillingAddressCity | String | The city of the billing address. | |
| BillingAddressCompany | String | The company of the person associated with the billing address. | |
| BillingAddressZip | String | The zip or postal code of the billing address. | |
| BillingAddressProvince | String | The name of the state or province of the billing address. | |
| BillingAddressCountry | String | The name of the country of the billing address. | |
| BillingAddressLatitude | Double | The latitude of the billing address. | |
| BillingAddressLongitude | Double | The longitude of the billing address. | |
| BillingAddressName | String | The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | The first name of the person associated with the shipping address. | |
| ShippingAddressLastName | String | The last name of the person associated with the shipping address. | |
| ShippingAddressAdress1 | String | The street address of the shipping address. | |
| ShippingAddressAdress2 | String | An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | The phone number at the shipping address. | |
| ShippingAddressCity | String | The city of the shipping address. | |
| ShippingAddressCompany | String | The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | The longitude of the shipping address. | |
| ShippingAddressName | String | The full name of the person associated with the shipping address. | |
| ShippingAddressCountryCode | String | The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | Whether this address is the default one or not. | |
| ClosedAt | Datetime | The date and time when the order was closed. | |
| CompletedAt | Datetime | CompletedAt | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AbandonedCheckoutsItems
Query abandoned checkouts items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckoutsItems WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| AbandonedCheckoutId [KEY] | Long | The unique numeric identifier for the order. | |
| ProductId [KEY] | Long |
Products.Id | The product ID od the item. |
| ItemVariantId [KEY] | Long | The product variant ID of item. | |
| ItemTitle | String | The title of the product. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item in presentment currency. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier for the item in the shop. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the item's supplier. | |
| FulFillmentsService | String | The fulfillment service provider for the item. | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AssignedFulfillmentOrders
The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the AssignedLocationId and RequestStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationId IN (1, 2)
SELECT * FROM AssignedFulfillmentOrders WHERE RequestStatus = 'cancellation_requested'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| FulfillmentServiceHandle | String | A unique numeric identifier for the order. | |
| RequestStatus | String | The status of the fulfillment. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| Status | String | The status of the fulfillment order. | |
| Operation | String | An operation to apply to the fulfillment. Complete, Open, or Cancel. |
DiscountApplications
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM DiscountApplications WHERE OrderId = '1'
SELECT * FROM DiscountApplications WHERE OrderId IN ('1', '2')
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt <= '2020-07-20 08:28:03.0'
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt > '2020-07-20 08:28:03.0'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Type | String | The name of the note attribute. | |
| Title | String | The value of the note attribute. | |
| Description | String | The value of the note attribute. | |
| Value | String | The value of the note attribute. | |
| ValueType | String | The value of the note attribute. | |
| AllocationMethod | String | The value of the note attribute. | |
| TargetSelection | String | The value of the note attribute. | |
| TargetType | String | The value of the note attribute. |
DraftOrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId column. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItemProperties WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the order item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. |
DraftOrderItems
Query draft order items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItems WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the line item. | |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| ProductId | Long |
Products.Id | The ID of the product corresponding to the line item product variant. |
| Custom | Bool | States whether this is a custom line item or a product variant line item | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| FulFillmentsService | String | Service provider responsible for fulfillment. | |
| ItemGrams | Int | The weight of the item in grams. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| ItemTitle | String | The title of the product or variant. | |
| ItemVariantId | Long | The id of the product variant. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the supplier of the item. | |
| Name | String | The name of the product variant. | |
| GiftCard | Bool | States whether or not the product is a gift card. | |
| Properties | String | Shows custom properties for this order item. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| TaxLines | String | Shows tax lines for this order item. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
DraftOrderItemTaxLines
Query draft order items tax lines.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the draft line item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| TaxTitle | String | The name of the tax. | |
| TaxRate | Decimal | The rate of tax to be applied. | |
| TaxPrice | Decimal | The amount of tax to be charged. |
Events
Retrieve events which have happened in your shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, OrderId, Verb, and CreatedAt columns. The supported SQL operators are '=' for the Id, ProductId, OrderId, and Verb columns and ">" and "<" for CreatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Events WHERE Id = '123'
SELECT * FROM Events WHERE ProductId = '123'
SELECT * FROM Events WHERE OrderId = '123'
SELECT * FROM Events WHERE Verb = 'Confirmed'
SELECT * FROM Events WHERE CreatedAt > '2018-05-02'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the event. | |
| Description | String | A human readable description of the event. | |
| Message | String | A human readable description of the event. Can contain some HTML formatting. | |
| Body | String | A text field containing information about the event. | |
| Path | String | A relative URL to the resource the event is for, if applicable. | |
| SubjectId | Long | The ID of the resource that generated the event. | |
| SubjectType | String | he type of the resource that generated the event. Valid values: Article, Blog, Collection, Comment, Order, Page, Product, ApiPermission. | |
| Verb | String | The type of event that occurred. Different resources generate different types of event. | |
| Author | String | The author of the event. | |
| Arguments | String | Refers to a certain event and its resources. | |
| CreatedAt | Datetime | The date and time when the event was created. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| OrderId | Long | The ID of the Order to retrieve events from. | |
| ProductId | Long | The ID of the Product to retrieve events from. |
FulfillmentOrders
Query fulfillment orders.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and Id columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM FulfillmentOrders WHERE OrderId = '1'
SELECT * FROM FulfillmentOrders WHERE Id = '1'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | An ID for the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId [KEY] | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| FullfillAt | Datetime | The datetime (in UTC) when the fulfillment order is ready for fulfillment. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| RequestStatus | String | The status of the fulfillment. | |
| Status | String | The status of the fulfillment order. | |
| SupportedActions | String | The actions that can be performed on this fulfillment order. | |
| MerchantRequests | String | A list of requests sent by the merchant to the fulfillment service for this fulfillment order.. | |
| FulfillmentHolds | String | Represents the fulfillment holds applied on the fulfillment order. | |
| InternationalDuties | String | The international duties relevant to the fulfillment order. | |
| AssignedLocationAddress1 | String | The street address of the assigned location | |
| AssignedLocationAddress2 | String | An optional additional field for the street address of the assigned location. | |
| AssignedLocationCity | String | The city of the assigned location. | |
| AssignedLocationCountryCode | String | The two-letter code for the country of the assigned location | |
| AssignedLocationName | String | The name of the assigned location. | |
| AssignedLocationPhone | String | The phone number of the assigned location. |
Locations
Retrieve information regarding store locations.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Locations WHERE Id = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID for the location. | |
| Name | String | The name of the location. | |
| Legacy | Bool | 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. | |
| Address1 | String | The first line of the address. | |
| Address2 | String | The second line of the address. | |
| City | String | The city the location is in. | |
| Zip | String | The zip or postal code. | |
| Province | String | The province the location is in. | |
| Country | String | The country the location is in. | |
| Phone | String | The phone number of the location. This value can contain special characters like - and +. | |
| CountryCode | String | The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in. | |
| CountryName | String | The name of the country the location is in. | |
| CreatedAt | Datetime | The date and time when the location was created. | |
| UpdatedAt | Datetime | The date and time when the location was last updated. | |
| DeletedAt | Datetime | The date and time when the location was deleted. |
NoteAttributes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM NoteAttributes WHERE OrderId = '123'
SELECT * FROM NoteAttributes WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Name | String | The name of the note attribute. | |
| Value | String | The value of the note attribute. |
OrderDiscountCodes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM OrderDiscountCodes WHERE OrderId = '1'
SELECT * FROM OrderDiscountCodes WHERE OrderId IN ('1', '2')
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt <= '2019-05-13 09:23:06.0'
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt >= '2019-05-13 09:23:06.0'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Code [KEY] | String | The name of the note attribute. | |
| Amount | String | The value of the note attribute. | |
| Type | String | The value of the note attribute. |
OrderItemDiscountAllocations
Query order item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| amount | String | The Amount of the item discount allocations. | |
| ApplicationIndex | Int | The ApplicationIndex of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The supported SQL operators are '=' for OrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side. You can set the Type pseudo column to "DraftOrder" to list order items belonging to draft orders instead of orders, or you can set Type to "AbandonedCheckout" to list order items belonging to abandoned checkouts.
SELECT * FROM OrderItemProperties WHERE OrderId = '123'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrdersItems
Query order items.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the order item. Only available for orders. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Type | String | The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout). | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
Payouts
Retrieves a list of all payouts ordered by payout date, with the most recent being first.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status and Date columns. The supported SQL operator is '=' for Id, Status and Date columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Payouts WHERE Id = '123'
SELECT * FROM Payouts WHERE Status = 'pending'
SELECT * FROM Payouts WHERE Date = '2018-10-30'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the payout. | |
| Status | String | The transfer status of the payout. | |
| Currency | String | The ISO 4217 currency code of the payout. | |
| Amount | Decimal | The total amount of the payout, in a decimal formatted string. | |
| Date | Datetime | The date the payout was issued. |
PayoutTransactions
Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the transaction. | |
| Type | String | The type of the balance transaction. | |
| Test | Bool | If the transaction was created for a test mode Order or payment. | |
| PayoutId | Long |
Payouts.Id | The id of the payout the transaction was paid out in. |
| PayoutStatus | String | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout. | |
| Currency | String | The ISO 4217 currency code of the transaction. | |
| Amount | Decimal | The gross amount of the transaction, in a decimal formatted string. | |
| Fee | Decimal | The total amount of fees deducted from the transaction amount. | |
| Net | Decimal | The net amount of the transaction. | |
| SourceId | Long | The id of the resource leading to the transaction. | |
| SourceType | String | The type of the resource leading to the transaction. | |
| SourceOrderTransactionId | String | The id of the Order Transaction that resulted in this balance transaction. | |
| SourceOrderId | String | The id of the Order that this transaction ultimately originated from. | |
| ProcessedAt | Datetime | The time the transaction was processed. |
RefundAdjustments
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundAdjustments WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundAdjustments WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the refund adjustment. | |
| OrderId | Long |
Orders.Id | The unique identifier for the order that the order adjustment is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund that the order adjustment is associated with. |
| Amount | Decimal | The value of the discrepancy between the calculated refund and the actual refund. | |
| TaxAmount | Decimal | The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund. | |
| Kind | String | The order adjustment type. | |
| Reason | String | The reason for the order adjustment. | |
| AmountShopMoney | Decimal | The amount of the order adjustment in shop. | |
| AmountShopCurrency | String | The currency of the order adjustment in shop. | |
| AmountPresentmentMoney | Decimal | The amount of the order adjustment in presentment. | |
| AmountPresentmentCurrency | String | The currency of the order adjustment in presentment. | |
| TaxAmountShopMoney | Decimal | The tax amount of the order adjustment in shop. | |
| TaxAmountShopCurrency | String | The tax currency of the order adjustment in shop. | |
| TaxAmountPresentmentMoney | Decimal | The tax amount of the order adjustment in presentment. | |
| TaxAmountPresentmentCurrency | String | The tax currency of the order adjustment in presentment. |
RefundsItems
Get data on OrdersItems that have been refunded.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderID [KEY] | Long |
Orders.Id | The id of the refund this refunded item belongs to. |
| RefundId [KEY] | Long |
Refunds.Id | The id of the refund this refunded item belongs to. |
| LocationId | Long | The unique identifier of the location tied to the refund item | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| RefundSubtotal | Decimal | The refunded amount for this item. This is calculated by multiplying ItemPrice with RefundQuantity. | |
| RefundQuantity | Int | The quantity of the item refunded. | |
| RefundRestockType | String | The type of the restock action. | |
| RefundSubtotalPresentmentAmount | Decimal | The total amount of the presentment money. | |
| RefundSubtotalPresentmentCurrencyCode | String | The currency code of the presentment money. | |
| RefundSubtotalShopAmount | Decimal | The total amount of the shop money. | |
| RefundSubtotalShopCurrencyCode | String | The currency code of the shop money. | |
| RefundTotalTax | Decimal | Total tax for the refunded item. | |
| RefundTotalTaxPresentmentAmount | Decimal | Total tax amount for the presentment money. | |
| RefundTotalTaxPresentmentCurrencyCode | String | Currency code for the tax on presentment money. | |
| RefundTotalTaxShopAmount | Decimal | Total tax amount for the shop money. | |
| RefundTotalTaxShopCurrencyCode | String | Currency code for the tax on shop money. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
RefundTransactions
Query transactions for Refund Object.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundTransactions WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| TransactionsId [KEY] | Long | The ID for the refund transaction. | |
| OrderId | Long |
Orders.Id | The ID for the order that the transaction is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund associated with. |
| Amount | Decimal | The amount of money included in the transaction. | |
| Authorization | String | The authorization code associated with the transaction.. | |
| CreatedAt | Datetime | The date and time (ISO 8601 format) when the transaction was created. | |
| Currency | String | The three-letter code (ISO 4217 format) for the currency used for the payment. | |
| DeviceId | String | The ID for the device. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| GraphqlAPIId | String | The order adjustment type. | |
| Gateway | String | The name of the gateway the transaction was issued through. | |
| Kind | String | The transaction's type. | |
| LocationId | String | The ID of the physical location where the transaction was processed. | |
| Message | String | A string generated by the payment provider with additional information about why the transaction succeeded or failed. | |
| ParentId | Long | The ID of an associated transaction.. | |
| ProcessedAt | Datetime | The date and time (ISO 8601 format) when a transaction was processed. | |
| Status | String | The status of the transaction. | |
| SourceName | String | The origin of the transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| UserId | String | The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable. |
Reports
To query all the Reports.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Reports WHERE Id = '123'
SELECT * FROM Reports WHERE UpdatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the report. | |
| Name | String | The name of the report. | |
| ShopifyQl | String | The ShopifyQL query that generates the report. | |
| UpdatedAt | Datetime | The date and time (ISO 8601) when the report was last modified. | |
| Category | String | The category for the report. When you create a report, the API will return custom_app_reports. |
ShippingItemDiscountAllocations
Query Shipping item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
ShippingItems.ItemId | The id of the shipping item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Amount | String | The Amount of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| DiscountApplicationIndex | Int | The Discount application index for an order. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
ShippingItems
Query order shipping.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.
SELECT * FROM ShippingItems WHERE OrderId = '123'
SELECT * FROM ShippingItems WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The id of the shipping item. | |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Price | Decimal | The price of this shipping method. | |
| Code | String | A reference to the shipping method. | |
| Title | String | The title of the shipping method. | |
| Source | String | The source of the shipping method. | |
| CarrierIdentifier | String | A reference to the carrier service that provided the rate. | |
| RequestedFulfillmentServiceId | String | A reference to the fulfillment service that is being requested for the shipping method. |
ShippingZones
Retrieve information regarding shipping zones.
View-Specific Information
Select
The Sync App processes all filters client-side within the Sync App.The following query is the only one processed server-side:
SELECT * FROM ShippingZones
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the shipping zone. | |
| Name | String | The name of the shipping zone, specified by the user. | |
| ProfileId | String | The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates. | |
| LocationGroupId | String | 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. | |
| Countries | String | A list of countries that belong to the shipping zone. | |
| CarrierShippingRateProviders | String | Information about carrier shipping providers and the rates used. | |
| PriceBasedShippingRates | String | Information about price based shipping rates used. | |
| WeightBasedShippingRates | String | Information about weight based shipping rates used. |
Shop
Contains general settings and information about the shop.
View-Specific Information
Select
The Sync App processes the WHERE clause client-side within the Sync App for all queries to this table. For example, the following query is the only query processed server-side:SELECT * FROM Shop
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the shop. | |
| Name | String | The name of the shop. | |
| String | The contact email address for the shop. | ||
| Address1 | String | The shop's street address. | |
| Address2 | String | The shop's additional street address (apt, suite, etc.). | |
| City | String | The city in which the shop is located. | |
| Country | String | The shop's country (by default equal to the two-letter country code). | |
| CountryCode | String | The two-letter country code corresponding to the shop's country. | |
| CountryName | String | The shop's normalized country name. | |
| CustomerEmail | String | The customer's email. | |
| Currency | String | The three-letter code for the currency that the shop accepts. | |
| Domain | String | The shop's domain. | |
| GoogleAppsDomain | String | The URL of the domain if the shop has a google apps domain. | |
| GoogleAppsLoginEnabled | String | Indicated whether the shop has google apps login enabled. | |
| Latitude | Double | Geographic coordinate specifying the north/south location of a shop. | |
| Longitude | Double | Geographic coordinate specifying the east/west location of a shop. | |
| MoneyFormat | String | A string representing the way currency is formatted when the currency isn't specified. | |
| MoneyWithCurrencyFormat | String | A string representing the way currency is formatted when the currency is specified. | |
| WeightUnit | String | A string representing the default unit of weight measurement for the shop. | |
| MyshopifyDomain | String | The shop's 'myshopify.com' domain. | |
| PlanName | String | The name of the Shopify plan the shop is on. | |
| HasDiscounts | Bool | Indicates if any active discounts exist for the shop. | |
| HasGiftCards | Bool | Indicates if any active gift cards exist for the shop. | |
| PlanDisplayName | String | The display name of the Shopify plan the shop is on. | |
| PasswordEnabled | Bool | Indicates whether the Storefront password protection is enabled. | |
| Phone | String | The contact phone number for the shop. | |
| PrimaryLocale | String | The shop's primary locale. | |
| Province | String | The shop's normalized province or state name. | |
| ProvinceCode | String | The two-letter code for the shop's province or state. | |
| ShopOwner | String | The username of the shop owner. | |
| Source | String | Source | |
| TaxShipping | Bool | Specifies whether or not taxes were charged for shipping. | |
| TaxesIncluding | Bool | The setting for whether applicable taxes are included in product prices. | |
| CountryTaxes | Bool | The setting for whether the shop is applying taxes on a per-county basis or not (US-only). | |
| Timezone | String | The name of the timezone the shop is in. | |
| IANATimezone | String | The named timezone assigned by the IANA. | |
| Zip | String | The zip or postal code of the shop's address. | |
| HasStorefront | Bool | Indicates whether the shop has web-based storefront or not. | |
| CreatedAt | Datetime | The date and time when the shop was created. | |
| UpdatedAt | Datetime | The date and time when the shop was last updated. | |
| SetupRequired | Bool | Indicates whether the shop has any outstanding setup steps or not. |
TaxItems
Query order taxes.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM TaxItems WHERE OrderId = '123'
SELECT * FROM TaxItems WHERE OrderUpdatedAt > '2018-05-21'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. | |
| TaxItemPrice | Decimal | The amount of tax to be charged. | |
| TaxItemRate | Decimal | The rate of tax to be applied. | |
| TaxItemTitle | String | The name of the tax. |
Users
Query Users.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the user. | |
| FirstName | String | The first name of the user. | |
| String | The email of the user. | ||
| Url | String | The url of the user. | |
| IM | String | The IM of the user. | |
| ScreenName | String | The screen name of the user. | |
| Phone | String | The phone number of the of the user. | |
| LastName | String | The last name of the user. | |
| AccountOwner | Bool | If the user is the account owner. | |
| ReceiveAnnouncements | Bool | If the user receives announcements. | |
| Bio | String | The bio of the user. | |
| Permissions | String | The list of permissions of the user. | |
| Locale | String | The Locale of the user. | |
| UserType | String | The type of the user. | |
| AdminGraphQLAPIId | String | The Admin GraphQL API Id of the user. | |
| TFAEnabled | Bool | If TFA is enabled. |
GRAPHQL Data Model
CData Sync App は、Shopify API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
GraphQL データモデルを使用するには、Schema をGraphQL に設定します。
テーブル
テーブル は変更可能なテーブルです。
ビュー
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なモデルデータはビューとして表されます。
ストアドプロシージャ
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Bulk API の使用
UseBulkApi がTrue に設定されている場合、CData Sync App はShopify Bulk Operations を実行します。このオプションは、Shopify から多くのデータを選択またはエクスポートする必要がある場合に、優れたパフォーマンスを発揮します。
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| AppFeedbacks | Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store. |
| AppSubscriptionLineItems | Returns the plans attached to the app subscription. |
| AppSubscriptions | Lists all subscriptions created for a shop on the installed application. |
| Catalogs | The catalogs belonging to the shop. |
| Collections | Returns a list of collections. |
| Companies | Returns the list of companies in the shop. |
| CompanyLocations | Returns a list of locations in the company. |
| Customers | Retrieves a list of customers. |
| DeliveryProfiles | Returns a list of saved delivery profiles. |
| DiscountsAutomaticApp | Returns a list of discounts. |
| DiscountsAutomaticBasic | Returns a list of discounts. |
| DiscountsAutomaticBxgy | Returns a list of discounts. |
| DiscountsCodeApp | Returns a list of discounts. |
| DiscountsCodeBasic | Returns a list of discounts. |
| DiscountsCodeBxgy | Returns a list of discounts. |
| DraftOrders | Returns a list of saved draft orders. |
| FulfillmentEvents | Retrieves the history of events associated with one or many fulfillments. |
| FulfillmentOrders | Retrieves a paginated list of merchant-managed and third-party fulfillment orders. |
| Fulfillments | Fulfillment represents a shipment of one or more items in an order. |
| FulfillmentServices | Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner. |
| FulfillmentTrackingInfo | Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL. |
| GiftCards | Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription) |
| InventoryItems | Returns a list of inventory items. |
| Metafields | Retrieves a list of metafields that belong to one or many resource IDs. |
| Orders | Retrieves a list of orders. |
| OrderTransactions | Retrieves the transactions associated with the resource. |
| PriceLists | All price lists for a shop. |
| ProductImages | Returns the images associated with the product. |
| ProductResourceFeedbacks | Returns the product resource feedback for the currently authenticated app. |
| Products | Returns a list of products. |
| ProductVariants | Returns a list of the product variants. |
| Publications | Returns the list of publications. |
| Refunds | Represents a refund of items or transactions in an order. |
| Returns | Retrieves a list of returns for the order. |
| ScriptTags | Returns a list of script tags. |
| SellingPlanGroups | Returns a list Selling Plan Groups. |
| StorefrontAccessTokens | Retrieves the storefront access token of a private application. These are scoped per-application. |
| UrlRedirects | Returns a list of redirects for a shop. |
AppFeedbacks
Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.For example, the following queries are processed client-side:
SELECT * FROM AppFeedbacks WHERE Id = 'VALUE'
Insert
INSERT statements are mapped to the 'shopResourceFeedbackCreate' GraphQL mutation.
The following column can be used to create a new record:
Message
The following pseudo-columns can be used to create a new record:
State, FeedbackGeneratedAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | True |
Name of the app. | |
| Message | String | True |
The feedback message presented to the merchant. | |
| Url | String | True |
The URL that the link visits. | |
| Label | String | True |
A context-sensitive label for the link. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| State | String |
The state of the feedback and whether it requires merchant action. |
| FeedbackGeneratedAt | Datetime |
The date and time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. |
AppSubscriptionLineItems
Returns the plans attached to the app subscription.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppSubscriptionLineItems WHERE AppInstallationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'appSubscriptionLineItemUpdate' GraphQL mutation.
The following columns can be updated:
UsagePricingPlanCappedAmount, UsagePricingPlanCappedAmountCurrencyCode
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppSubscriptionId | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| RecurringPricingPlanDiscountDurationLimitInIntervals | Int | True |
The total number of billing intervals to which the discount will be applied. The discount will be applied to an indefinite number of billing intervals if this value is blank. | |
| RecurringPricingPlanDiscountPriceAfterDiscountAmount | Decimal | True |
The price of the subscription after the discount is applied. Decimal money amount. | |
| RecurringPricingPlanDiscountPriceAfterDiscountCurrencyCode | String | True |
The price of the subscription after the discount is applied. Currency of the money. | |
| RecurringPricingPlanDiscountRemainingDurationInIntervals | Int | True |
The remaining number of billing intervals to which the discount will be applied. | |
| RecurringPricingPlanValueAmount | Decimal | True |
The value of the discount applied every billing interval. Decimal money amount. | |
| RecurringPricingPlanValueAmountCurrencyCode | String | True |
The value of the discount applied every billing interval. Currency of the money. | |
| RecurringPricingPlanValuePercentage | Double | True |
The value of the discount applied every billing interval. The percentage value of a discount. | |
| RecurringPricingPlanInterval | String | True |
The frequency at which the subscribing shop is billed for an app subscription. | |
| RecurringPricingPlanPriceAmount | Decimal | True |
The amount to be charged to the subscribing shop every billing interval. Decimal money amount. | |
| RecurringPricingPlanPriceCurrencyCode | String | True |
The currency to be charged to the subscribing shop every billing interval. Currency of the money. | |
| UsagePricingPlanBalanceUsedAmount | Decimal | True |
The total usage records for interval. Decimal money amount. | |
| UsagePricingPlanBalanceUsedCurrencyCode | String | True |
The total usage records for interval. Currency of the money. | |
| UsagePricingPlanCappedAmount | Decimal | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Decimal money amount. | |
| UsagePricingPlanCappedAmountCurrencyCode | String | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Currency of the money. | |
| UsagePricingPlanInterval | String | True |
The frequency with which the app usage records are billed. | |
| UsagePricingPlanTerms | String | True |
The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges. |
AppSubscriptions
Lists all subscriptions created for a shop on the installed application.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- AppInstallationId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM AppSubscriptions
SELECT * FROM AppSubscriptions WHERE AppInstallationId = 'Val1'
Insert
Insert statements are mapped to the 'appSubscriptionCreate' GraphQL mutation.
The following columns can be used to create a new record:
Name, Test, ReturnUrl, TrialDays, LineItem
Delete
Delete statements are mapped to the 'appSubscriptionCancel' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| Name | String | True |
The name of the app subscription. | |
| Status | String | True |
The status of the app subscription. | |
| Test | Bool | True |
Specifies whether the app subscription is a test transaction. | |
| ReturnUrl | String | True |
The URL that the merchant is redirected to after approving the app subscription. | |
| TrialDays | Int | True |
The number of free trial days, starting at the subscription's creation date, by which billing is delayed. | |
| CurrentPeriodEnd | Datetime | True |
The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active. | |
| CreatedAt | Datetime | True |
The date and time when the app subscription was created. | |
| LineItemIds | String | True |
The IDs of the plans attached to the app subscription. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| LineItem | String |
LineItem |
Catalogs
The catalogs belonging to the shop.
Select
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server side:
SELECT * FROM Catalogs
Insert
Insert statements are mapped to the 'catalogCreate' GraphQL mutation.
The following columns can be used to create a new record:
Status, Title, PriceListId, PublicationId
The following pseudo-columns can be used to create a new record:
CompanyLocationIds
Update
Update statements are mapped to the 'catalogUpdate' GraphQL mutation.
The following columns can be updated:
Id, Status, Title, PriceListId, PublicationId
The following pseudo-columns can be updated:
CompanyLocationIds
Delete
Delete statements are mapped to the 'catalogDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the catalog. | |
| Title | String | False |
The name of the catalog. | |
| PriceListId | String | False |
A globally-unique ID. | |
| PublicationId | String | False |
A globally-unique ID. | |
| OperationId | String | True |
A globally-unique ID. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| CompanyLocationIds | String |
The IDs of the company locations to associate to the catalog. |
Collections
Returns a list of collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Collections WHERE Id='VALUE'
SELECT * FROM Collections WHERE Title='VALUE'
SELECT * FROM Collections WHERE UpdatedAt<'2000-01-01 01:00:00.0'
UPDATE
UPDATE statements are mapped to the 'collectionUpdate' GraphQL mutation.
The following column can be updated:
SortOrder
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Title | String | True |
The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. | |
| Handle | String | True |
A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title 'Summer Catalog 2022' might have the handle 'summer-catalog-2022'. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. | |
| DescriptionHtml | String | True |
The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. | |
| ProductsCount | Int | True |
The number of products in the collection. | |
| SortOrder | String | False |
The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. | |
| TemplateSuffix | String | True |
The suffix of the Liquid template being used to show the collection in an online store. 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' template. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| PublishedOnCurrentPublication | Bool | True |
Check to see whether the resource is published to the calling app's publication. | |
| UpdatedAt | Datetime | True |
The date and time when the collection was last modified. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| RuleSetAppliedDisjunctively | Bool | True |
Whether products must match any or all of the rules to be included in the collection. If true, then products must match at least one of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection. | |
| SeoTitle | String | True |
SEO Title. | |
| SeoDescription | String | True |
SEO Description. |
Companies
Returns the list of companies in the shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExternalId supports the '=,!=' comparison operators.
- Name supports the '=,!=' comparison operators.
- CustomerSince supports the '=,!=' comparison operators.
- CreatedAt supports the '=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Companies WHERE Id='VALUE'
SELECT * FROM Companies WHERE ExternalId='VALUE'
SELECT * FROM Companies WHERE Name='VALUE'
SELECT * FROM Companies WHERE CustomerSince='2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'companyCreate' GraphQL mutation.
The following columns can be used to create a new record:
ExternalId, Name, Note, CustomerSince
UPDATE
UPDATE statements are mapped to the 'companyUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Note
DELETE
DELETE statements are mapped to the 'companyDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ExternalId | String | False |
A unique externally-supplied ID for the company. | |
| Name | String | False |
The name of the company. | |
| Note | String | False |
A note about the company. | |
| ContactCount | Int | True |
The number of contacts that belong to the company. | |
| CustomerSince | Datetime | True |
The date and time at which the company became the customer. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| LifetimeDuration | String | True |
The lifetime duration of the company, since it became a customer of the shop. Examples: '2 days', '3 months', '1 year'. | |
| LocationCount | Int | True |
The number of locations that belong to the company. | |
| OrderCount | Int | True |
The total number of orders placed for this company, across all its locations. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company. | |
| CreatedAt | Datetime | True |
The date and time at which the company was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company was last modified. | |
| DefaultRoleId | String | True |
A globally-unique ID. | |
| DefaultRoleName | String | True |
The name of a role. For example, 'admin' or 'buyer'. | |
| DefaultRoleNote | String | True |
A note for the role. | |
| MainContactId | String | True |
A globally-unique ID. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
CompanyLocations
Returns a list of locations in the company.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CompanyId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyLocations WHERE CompanyId='VALUE'
Insert
INSERT statements are mapped to the 'companyLocationCreate' GraphQL mutation.
The following columns can be used to create a new record:
CompanyId, ExternalId, TaxRegistrationId, Name, Locale, Note, Phone, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressPhone, BillingAddressRecipient, BillingAddressZip, BillingAddressCountryCode, BillingAddressZoneCode, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressPhone, ShippingAddressRecipient, ShippingAddressZip, ShippingAddressCountryCode, ShippingAddressZoneCode
UPDATE
UPDATE statements are mapped to the 'companyLocationUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Locale, Note, Phone
DELETE
DELETE statements are mapped to the 'companyLocationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| CompanyId | String | True |
Companies.Id |
A globally-unique ID. |
| ExternalId | String | False |
A unique externally-supplied ID for the company location. | |
| TaxRegistrationId | String | True |
The tax registration ID for the company location. | |
| Name | String | False |
The name of the company location. | |
| Currency | String | True |
The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. | |
| Locale | String | False |
The preferred locale of the company location. | |
| Note | String | False |
A note about the company location. | |
| Phone | String | False |
The phone number of the company location. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| OrderCount | Int | True |
The total number of orders placed for the location. | |
| TaxExemptions | String | True |
The list of tax exemptions applied to the location. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company location. | |
| CreatedAt | Datetime | True |
The date and time at which the company location was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company location was last modified. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCompanyName | String | True |
The name of the company. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| BillingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| BuyerExperienceConfigurationCheckoutToDraft | Bool | True |
Whether to checkout to draft order for merchant review. | |
| BuyerExperienceConfigurationPayNowOnly | Bool | True |
Whether a buyer must pay at checkout or they can also choose to pay later using net terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplateId | String | True |
A globally-unique ID. | |
| BuyerExperienceConfigurationPaymentTermsTemplateName | String | True |
The name of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName | String | True |
The translated payment terms template name. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDescription | String | True |
The description of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDueInDays | Int | True |
The number of days between the issued date and due date if this is the net type of payment terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType | String | True |
The type of the payment terms template. | |
| MarketId | String | True |
A globally-unique ID. | |
| ShippingAddressId | String | True |
A globally-unique ID. | |
| ShippingAddressCompanyName | String | True |
The name of the company. | |
| ShippingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | True |
The name of the city, district, village, or town. | |
| ShippingAddressCountry | String | True |
The name of the country. | |
| ShippingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| ShippingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| ShippingAddressZip | String | True |
The zip or postal code of the address. | |
| ShippingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| ShippingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
Customers
Retrieves a list of customers.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Email supports the '=,!=' comparison operators.
- Phone supports the '=,!=' comparison operators.
- State supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AcceptsMarketing supports the '=,!=' comparison operators.
- AmountSpentAmount supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Customers
SELECT * FROM Customers WHERE Id = 'Val1'
SELECT * FROM Customers WHERE Email = 'Val1'
SELECT * FROM Customers WHERE Phone = 'Val1'
SELECT * FROM Customers WHERE State = 'Val1'
SELECT * FROM Customers WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM Customers WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM Customers WHERE AcceptsMarketing = 123
SELECT * FROM Customers WHERE AmountSpentAmount = 123
Insert
Insert statements are mapped to the 'customerCreate' GraphQL mutation.
The following columns can be used to create a new record:
FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt
Update
Update statements are mapped to the 'customerUpdate' GraphQL mutation.
The following columns can be updated:
Id, FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt
Delete
Delete statements are mapped to the 'customerDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| MultipassIdentifier | String | True |
A unique identifier for the customer that's used with Multipass login. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| ValidEmailAddress | Bool | True |
Whether the email address is formatted correctly. Returns 'true' when the email is formatted correctly and belongs to an existing domain. This doesn't guarantee that the email address actually exists. | |
| DisplayName | String | True |
The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| String | False |
The customer's email address. | ||
| Locale | String | False |
The customer's locale. | |
| Note | String | False |
A note about the customer. | |
| Phone | String | False |
The customer's phone number. | |
| State | String | True |
The state of the customer's account with the shop. | |
| Tags | String | False |
A comma separated list of tags that have been added to the customer. | |
| CanDelete | Bool | True |
Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store. | |
| LifetimeDuration | String | True |
The amount of time since the customer was first added to the store. Example: 'about 12 years'. | |
| TaxExempt | Bool | False |
Whether the customer is exempt from being charged taxes on their orders. | |
| TaxExemptions | String | False |
The list of tax exemptions applied to the customer. | |
| UnsubscribeUrl | String | True |
The URL to unsubscribe the customer from the mailing list. | |
| VerifiedEmail | Bool | True |
Whether the customer has verified their email address. Defaults to 'true' if the customer is created through the Shopify admin or API. | |
| HasTimelineComment | Bool | True |
Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. | |
| NumberOfOrders | String | True |
The number of orders that the customer has made at the store in their lifetime. | |
| ProductSubscriberStatus | String | True |
Possible subscriber states of a customer defined by their subscription contracts. | |
| CreatedAt | Datetime | True |
The date and time when the customer was added to the store. | |
| UpdatedAt | Datetime | True |
The date and time when the customer was last updated. | |
| AcceptsMarketing | Bool | True |
Whether the customer has agreed to receive marketing materials. | |
| AmountSpentAmount | Decimal | True |
Decimal money amount. | |
| AmountSpentCurrencyCode | String | True |
Currency of the money. | |
| AverageOrderAmountV2Amount | Decimal | True |
Decimal money amount. | |
| AverageOrderAmountV2CurrencyCode | String | True |
Currency of the money. | |
| DefaultAddressId | String | True |
A globally-unique ID. | |
| DefaultAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DefaultAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DefaultAddressFirstName | String | False |
The first name of the customer. | |
| DefaultAddressLastName | String | False |
The last name of the customer. | |
| DefaultAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| DefaultAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DefaultAddressCity | String | False |
The name of the city, district, village, or town. | |
| DefaultAddressCompany | String | False |
The name of the customer's company or organization. | |
| DefaultAddressCountry | String | False |
The name of the country. | |
| DefaultAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DefaultAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DefaultAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DefaultAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| DefaultAddressZip | String | False |
The zip or postal code of the address. | |
| DefaultAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DefaultAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| DefaultAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| EmailMarketingConsentMarketingState | String | True |
The current email marketing state for the customer. | |
| EmailMarketingConsentMarketingOptInLevel | String | True |
The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email. | |
| EmailMarketingConsentConsentUpdatedAt | Datetime | True |
The date and time at which the customer consented to receive marketing material by email. The customer's consent state reflects the consent record with the most recent 'consent_updated_at' date. If no date is provided, then the date and time at which the consent information was sent is used. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| LastOrderId | String | True |
A globally-unique ID. | |
| MarketId | String | True |
A globally-unique ID. | |
| MergeableReason | String | True |
The reason why the customer can't be merged with another customer. | |
| MergeableErrorFields | String | True |
The list of fields preventing the customer from being merged. | |
| MergeableIsMergeable | Bool | True |
Whether the customer can be merged with another customer. | |
| MergeableMergeInProgressJobId | String | True |
The UUID of the merge job. | |
| MergeableMergeInProgressResultingCustomerId | String | True |
The ID of the customer resulting from the merge. | |
| MergeableMergeInProgressStatus | String | True |
The status of the customer merge request. | |
| SmsMarketingConsentMarketingState | String | False |
The current SMS marketing state for the customer. | |
| SmsMarketingConsentConsentCollectedFrom | String | True |
The source from which the SMS marketing information for the customer was collected. | |
| SmsMarketingConsentMarketingOptInLevel | String | False |
The marketing subscription opt-in level that was set when the customer consented to receive marketing information. | |
| SmsMarketingConsentConsentUpdatedAt | Datetime | False |
The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used. | |
| StatisticsPredictedSpendTier | String | True |
The predicted spend tier of a customer with a shop. |
DeliveryProfiles
Returns a list of saved delivery profiles.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- MerchantOwnedOnly supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DeliveryProfiles WHERE Id='VALUE'
SELECT * FROM DeliveryProfiles WHERE MerchantOwnedOnly='true'
Insert
INSERT statements are mapped to the 'deliveryProfileCreate' GraphQL mutation.
The following column can be used to create a new record:
Name
UPDATE
UPDATE statements are mapped to the 'deliveryProfileUpdate' GraphQL mutation.
The following column can be updated:
Name
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Name | String | False |
The name of the delivery profile. | |
| Default | Bool | True |
Whether this is the default profile. | |
| LegacyMode | Bool | True |
Whether this shop has enabled legacy compatibility mode for delivery profiles. | |
| OriginLocationCount | Int | True |
The number of active origin locations for the profile. | |
| ZoneCountryCount | Int | True |
The number of countries with active rates to deliver to. | |
| ActiveMethodDefinitionsCount | Int | True |
The number of active shipping rates for the profile. | |
| LocationsWithoutRatesCount | Int | True |
The number of locations without rates defined. | |
| ProductVariantsCountV2Capped | Bool | True |
Whether the count has reached the cap of 500. | |
| ProductVariantsCountV2Count | Int | True |
The product variant count. | |
| MerchantOwnedOnly | Bool | True |
If 'true', returns only delivery profiles that were created by the merchant. |
DiscountsAutomaticApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticApp WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountAutomaticAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
UPDATE
UPDATE statements are mapped to the 'discountAutomaticAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount was updated. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. |
DiscountsAutomaticBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticBasic WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, MinimumQuantity, MinimumSubtotal
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | True |
The minimum quantity of items that's required for the discount to be applied. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| MinimumQuantity | String |
The minimum quantity of items that's required for the discount to be applied. |
| MinimumSubtotal | String |
The minimum subtotal that's required for the discount to be applied. |
DiscountsAutomaticBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
SELECT * FROM DiscountsAutomaticBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountQuantityToBuy | String |
The quantity of prerequisite items. |
| DiscountAmountToBuy | String |
The value of the discount. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
DiscountsCodeApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeApp WHERE Title='VALUE'
SELECT * FROM DiscountsCodeApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountCodeAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be used to create a new record:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be updated:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | True |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBasic WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be used to create a new record:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be updated:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | False |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | False |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | False |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | False |
The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | True |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | True |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | True |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountAmountToBuy | String |
The value of the discount. |
| DiscountQuantityToBuy | Double |
The quantity of prerequisite items. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DraftOrders
Returns a list of saved draft orders.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM DraftOrders
SELECT * FROM DraftOrders WHERE Id = 'Val1'
SELECT * FROM DraftOrders WHERE Status = 'Val1'
SELECT * FROM DraftOrders WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE CustomerId = 'Val1'
Insert
Insert statements are mapped to the 'draftOrderCreate' GraphQL mutation.
The following columns can be used to create a new record:
Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Update
Update statements are mapped to the 'draftOrderUpdate' GraphQL mutation.
The following columns can be updated:
Id, Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Delete
Delete statements are mapped to the 'draftOrderDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Name | String | True |
The identifier for the draft order, which is unique within the store. For example, _#D1223_. | |
| MarketName | String | True |
The name of the selected market. | |
| String | False |
Email address of the customer, which is used to send notifications to. | ||
| Note2 | String | True |
The text from an optional note attached to the draft order. | |
| Phone | String | True |
The phone number assigned to the draft order. | |
| Ready | Bool | True |
Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish. | |
| Status | String | True |
Status of the draft order. | |
| Tags | String | True |
A comma separated list of tags associated with the draft order. Updating 'tags' overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the mutation. | |
| CompletedAt | Datetime | True |
The date and time when the draft order converted to a new order, and the draft order's status changed to **Completed**. | |
| CurrencyCode | String | True |
The three letter code for the currency of the store at the time of the most recent update to the draft order. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| InvoiceUrl | String | True |
The link to the checkout, which is sent to the customer in the invoice email. | |
| SubtotalPrice | Decimal | True |
The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. | |
| TaxExempt | Bool | True |
Whether the draft order is tax exempt. | |
| TaxesIncluded | Bool | True |
Whether the line item prices include taxes. | |
| TotalPrice | Decimal | True |
The total amount of the draft order, including taxes, shipping charges, and discounts. | |
| TotalTax | Decimal | True |
The total amount of taxes for the draft order. | |
| TotalWeight | String | True |
The total weight in grams of the draft order. | |
| HasTimelineComment | Bool | True |
Whether the merchant has added timeline comments to the draft order. | |
| InvoiceSentAt | Datetime | True |
The date and time when the invoice was last emailed to the customer. | |
| PresentmentCurrencyCode | String | True |
The payment currency of the customer for this draft order. | |
| ReserveInventoryUntil | Datetime | True |
The time after which inventory will automatically be restocked. | |
| TotalShippingPrice | Decimal | True |
The total shipping charge for the draft order. | |
| VisibleToCustomer | Bool | True |
Whether the draft order will be visible to the customer on the self-serve portal. | |
| InvoiceEmailTemplateSubject | String | True |
The subject defined for the draft invoice email template. | |
| MarketRegionCountryCode | String | True |
The selected market region country code for the draft order. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CreatedAt | Datetime | True |
The date and time when the draft order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the draft order was last changed. The format is YYYY-MM-DD HH: mm: ss. For example, 2016-02-05 17: 04: 01. | |
| OrderId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | False |
Customers.Id |
Customer who will be sent an invoice for the draft order, if there is one. |
| BillingAddressId | String | False |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | False |
The first name of the customer. | |
| BillingAddressLastName | String | False |
The last name of the customer. | |
| BillingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | False |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | False |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | False |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | False |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| AppliedDiscountTitle | String | False |
Name of the order-level discount. | |
| AppliedDiscountDescription | String | False |
Description of the order-level discount. | |
| AppliedDiscountValue | Double | False |
Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount). | |
| AppliedDiscountValueType | String | False |
Type of the order-level discount. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsOrderId | String | True |
A globally-unique ID. | |
| AppliedDiscountAmountV2Amount | Decimal | False |
Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPricePresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPricePresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPriceShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPriceShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DraftOrderLineItems | String |
The list of the line items in the draft order. |
FulfillmentEvents
Retrieves the history of events associated with one or many fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentEvents WHERE FulfillmentId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentEventCreate' GraphQL mutation.
The following columns can be used to create a new record:
FulfillmentId, Status, Address1, City, Country, Latitude, Longitude, Message, Province, Zip, EstimatedDeliveryAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| FulfillmentId | String | True |
Fulfillments.Id |
A globally-unique ID. |
| OrderId | String | True |
Orders.Id |
A globally-unique identifier. |
| Status | String | True |
The status of this fulfillment event. | |
| HappenedAt | Datetime | True |
The time at which this fulfillment event happened. | |
| Address1 | String | True |
The street address where this fulfillment event occurred. | |
| City | String | True |
The city where this fulfillment event occurred. | |
| Country | String | True |
The country where this fulfillment event occurred. | |
| Latitude | Double | True |
The latitude where this fulfillment event occurred. | |
| Longitude | Double | True |
The longitude where this fulfillment event occurred. | |
| Message | String | True |
A message associated with this fulfillment event. | |
| Province | String | True |
The province where this fulfillment event occurred. | |
| Zip | String | True |
The zip code of the location where this fulfillment event occurred. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated delivery date and time of the fulfillment. |
FulfillmentOrders
Retrieves a paginated list of merchant-managed and third-party fulfillment orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- AssignedLocationLocationId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentOrders WHERE Id='VALUE'
SELECT * FROM FulfillmentOrders WHERE Status='VALUE'
SELECT * FROM FulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'dynamic_depends_on_status' GraphQL mutation.
The following column can be updated:
Status
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the fulfillment order. | |
| FulfillAt | Datetime | True |
The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | True |
The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| RequestStatus | String | True |
The request status of the fulfillment order. | |
| CreatedAt | Datetime | True |
Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment order was last updated. | |
| AssignedLocationName | String | True |
The name of the location. | |
| AssignedLocationAddress1 | String | True |
The first line of the address for the location. | |
| AssignedLocationAddress2 | String | True |
The second line of the address for the location. | |
| AssignedLocationCity | String | True |
The city of the location. | |
| AssignedLocationPhone | String | True |
The phone number of the location. | |
| AssignedLocationProvince | String | True |
The province of the location. | |
| AssignedLocationZip | String | True |
The ZIP code of the location. | |
| AssignedLocationCountryCode | String | True |
The two-letter country code of the location. | |
| AssignedLocationLocationId | String | True |
A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | True |
The name of the location. | |
| AssignedLocationLocationActivatable | Bool | True |
Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | True |
Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | True |
Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | True |
Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | True |
The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | True |
Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | True |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | True |
Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | True |
Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | True |
Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | True |
A globally-unique ID. | |
| DeliveryMethodMethodType | String | True |
The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | True |
The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | True |
The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | True |
A globally-unique ID. | |
| DestinationFirstName | String | True |
The first name of the customer at the destination. | |
| DestinationLastName | String | True |
The last name of the customer at the destination. | |
| DestinationAddress1 | String | True |
The first line of the address of the destination. | |
| DestinationAddress2 | String | True |
The second line of the address of the destination. | |
| DestinationCity | String | True |
The city of the destination. | |
| DestinationCompany | String | True |
The company of the destination. | |
| DestinationEmail | String | True |
The email of the customer at the destination. | |
| DestinationPhone | String | True |
The phone number of the customer at the destination. | |
| DestinationProvince | String | True |
The province of the destination. | |
| DestinationZip | String | True |
The ZIP code of the destination. | |
| DestinationCountryCode | String | True |
The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | True |
The method of duties payment. Example values: 'DDP', 'DAP'. | |
| OrderId | String | True |
A globally-unique ID. |
Fulfillments
Fulfillment represents a shipment of one or more items in an order.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderIdcolumn, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Fulfillments WHERE OrderId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentCreateV2' GraphQL mutation.
The following columns can be used to create a new record:
OriginAddressAddress1, OriginAddressAddress2, OriginAddressCity, OriginAddressCountryCode, OriginAddressProvinceCode, OriginAddressZip, TrackingInfoNumber, TrackingInfoUrl, FulfillmentOrderIds
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Globally unique identifier. | |
| Name | String | True |
Human readable reference identifier for this fulfillment. | |
| Status | String | True |
The status of the fulfillment. | |
| DeliveredAt | Datetime | True |
The date that this fulfillment was delivered. | |
| DisplayStatus | String | True |
Human readable display status for this fulfillment. | |
| RequiresShipping | Bool | True |
Whether any of the line items in the fulfillment require shipping. | |
| TotalQuantity | Int | True |
Sum of all line item quantities for the fulfillment. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated date that this fulfillment will arrive. | |
| InTransitAt | Datetime | True |
The date and time when the fulfillment went into transit. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LocationId | String | True |
A globally-unique ID. | |
| ServiceId | String | True |
The ID of the fulfillment service. | |
| OriginAddressAddress1 | String | True |
The street address of the fulfillment location. | |
| OriginAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| OriginAddressCity | String | True |
The city in which the fulfillment location is located. | |
| OriginAddressCountryCode | String | True |
The country code of the fulfillment location. | |
| OriginAddressProvinceCode | String | True |
The province code of the fulfillment location. | |
| OriginAddressZip | String | True |
The zip code of the fulfillment location. | |
| TrackingInfoNumber | String | True |
TrackingInfoNumber | |
| TrackingInfoUrl | String | True |
TrackingInfoUrl |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FulfillmentOrderIds | String |
An aggregated object containing the FulfillmentOrder ids. Ex: [{'fulfillmentOrderId': 'gid://shopify/FulfillmentOrder/xxx'}] |
FulfillmentServices
Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'fulfillmentServiceCreate' GraphQL mutation.
The following columns can be used to create a new record:
ServiceName, InventoryManagement, FulfillmentOrdersOptIn, CallbackUrl
UPDATE
UPDATE statements are mapped to the 'fulfillmentServiceUpdate' GraphQL mutation.
The following columns can be updated:
ServiceName, FulfillmentOrdersOptIn, CallbackUrl
DELETE
DELETE statements are mapped to the 'fulfillmentServiceDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the fulfillment service. | |
| ServiceName | String | False |
The name of the fulfillment service as seen by merchants. | |
| Handle | String | True |
Human-readable unique identifier for this fulfillment service. | |
| Type | String | True |
Type associated with the fulfillment service. | |
| CallbackUrl | String | False |
The callback URL the fulfillment service has registered for requests. | |
| InventoryManagement | Bool | True |
Whether the fulfillment service tracks product inventory and provides updates to Shopify. | |
| ProductBased | Bool | True |
Whether the fulfillment service supports local deliveries. | |
| PermitsSkuSharing | Bool | True |
Whether the fulfillment service can stock inventory alongside other locations. | |
| FulfillmentOrdersOptIn | Bool | False |
Whether the fulfillment service has opted into fulfillment order based requests. | |
| LocationId | String | True |
Globally unique identifier. |
FulfillmentTrackingInfo
Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentTrackingInfo WHERE FulfillmentId='VALUE'
UPDATE
UPDATE statements are mapped to the 'fulfillmentTrackingInfoUpdateV2' GraphQL mutation.
The following columns can be updated:
FulfillmentId, Company, Number, Url
Columns
| Name | Type | ReadOnly | References | Description |
| FulfillmentId [KEY] | String | True |
Fulfillments.Id |
The ID of the Fulfillment to return. |
| Company | String | False |
The name of the tracking company. | |
| Number | String | False |
The tracking number of the fulfillment. | |
| Url | String | False |
The URLs to track the fulfillment. |
GiftCards
Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription)
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExpiresOn supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InitialValueAmount supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM GiftCards WHERE Id='VALUE'
SELECT * FROM GiftCards WHERE ExpiresOn<'2000-01-01'
SELECT * FROM GiftCards WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM GiftCards WHERE InitialValueAmount<'100.000000'
Insert
INSERT statements are mapped to the 'giftCardCreate' GraphQL mutation.
The following columns can be used to create a new record:
Note, ExpiresOn, InitialValueAmount, CustomerId
UPDATE
UPDATE statements are mapped to the 'giftCardUpdate' GraphQL mutation.
The following columns can be updated:
Note, ExpiresOn, CustomerId
DELETE
DELETE statements are mapped to the 'giftCardDisable' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Enabled | Bool | True |
Whether the gift card is enabled. | |
| Note | String | False |
The note associated with the gift card, which is not visible to the customer. | |
| DisabledAt | Datetime | True |
The date and time at which the gift card was disabled. | |
| ExpiresOn | Date | False |
The date at which the gift card will expire. | |
| LastCharacters | String | True |
The final four characters of the gift card code. | |
| MaskedCode | String | True |
The gift card code. Everything but the final four characters is masked. | |
| CreatedAt | Datetime | True |
The date and time at which the gift card was created. | |
| BalanceAmount | Decimal | True |
Decimal money amount. | |
| BalanceCurrencyCode | String | True |
Currency of the money. | |
| InitialValueAmount | Decimal | True |
Decimal money amount. | |
| InitialValueCurrencyCode | String | True |
Currency of the money. | |
| CustomerId | String | False |
A globally-unique ID. | |
| OrderId | String | True |
A globally-unique ID. |
InventoryItems
Returns a list of inventory items.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Sku supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM InventoryItems
SELECT * FROM InventoryItems WHERE Id = 'Val1'
SELECT * FROM InventoryItems WHERE Sku = 'Val1'
SELECT * FROM InventoryItems WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM InventoryItems WHERE UpdatedAt = '2023-01-01 11:10:00'
Update
Update statements are mapped to the 'inventoryItemUpdate' GraphQL mutation.
The following columns can be updated:
Id, Tracked, HarmonizedSystemCode, CountryCodeOfOrigin, ProvinceCodeOfOrigin, UnitCostAmount, InventoryItemCountryHarmonizedSystemCodes
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| VariantId | String | True |
A globally-unique ID. | |
| Sku | String | True |
Inventory item SKU. | |
| Tracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| LocationsCount | Int | True |
The number of locations where this inventory item is stocked. | |
| RequiresShipping | Bool | True |
Whether the inventory item requires shipping. | |
| DuplicateSkuCount | Int | True |
The number of inventory items that share the same SKU with this item. | |
| HarmonizedSystemCode | String | False |
The harmonized system code of the item. | |
| InventoryHistoryUrl | String | True |
The URL that points to the inventory history for the item. | |
| CountryCodeOfOrigin | String | False |
The ISO 3166-1 alpha-2 country code of where the item originated from. | |
| ProvinceCodeOfOrigin | String | False |
The ISO 3166-2 alpha-2 province code of where the item originated from. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was updated. | |
| TrackedEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| TrackedEditableReason | String | True |
The reason the attribute is locked for editing. | |
| UnitCostAmount | Decimal | False |
Decimal money amount. | |
| UnitCostCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| InventoryItemCountryHarmonizedSystemCodes | String |
List of country-specific harmonized system codes. |
Metafields
Retrieves a list of metafields that belong to one or many resource IDs.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=' comparison operator.
- OwnerId supports the '=,IN' comparison operators.
- OwnerResource supports the '=' comparison operator.
OwnerResource is a required column, and eligible values include "product","variant","shop","draft_order","order","customer","collection".
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND Id = 'gid://shopify/Metafield/19334473318423'
SELECT * FROM Metafields WHERE OwnerId = 'gid://shopify/ProductVariant/39378393497623' AND OwnerResource = 'variant'
SELECT * FROM Metafields WHERE OwnerId IN ('gid://shopify/ProductVariant/39378393497623', 'gid://shopify/Product/1418248224791') AND OwnerResource = 'variant'
Insert
INSERT statements are mapped to the 'metafieldsSet' GraphQL mutation.
The following columns can be used to create a new record:
Namespace, Key, Value, Type, OwnerId
DELETE
DELETE statements are mapped to the 'metafieldDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique ID of the metafield. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Namespace | String | True |
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. | |
| Key | String | True |
The name of the metafield. | |
| Value | String | True |
The information to be stored as metadata. | |
| Type | String | True |
The metafield's information type. | |
| Description | String | True |
A description of the information that the metafield contains. | |
| OwnerId | String | True |
The ID of the resource that the metafield is attached to. | |
| OwnerResource | String | True |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time when the metafield was last updated. |
Orders
Retrieves a list of orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- Email supports the '=,!=' comparison operators.
- Test supports the '=,!=' comparison operators.
- DiscountCode supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- RiskLevel supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
- ConfirmationNumber supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = 'gid://shopify/Order/232220695'
SELECT * FROM Orders WHERE Id IN ('gid://shopify/Order/232220695', 'gid://shopify/Order/23220695')
SELECT * FROM Orders WHERE Name='VALUE'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId != 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Test = true
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel = 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel != 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email = '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email != '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode = 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode != 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt = '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt != '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt <= '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt >= '2022-01-18 02:32:26.0' AND UpdatedAt <= '2022-05-10 07:52:22.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt >= '2017-09-19 06:10:39.0' AND ProcessedAt <= '2021-10-07 23:45:38.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt >= '2017-09-19 06:10:39.0' AND CreatedAt <= '2021-10-07 23:45:38.0'
SELECT * FROM Orders where ConfirmationNumber = 'TCIIRW5FL'
UPDATE
UPDATE statements are mapped to the 'orderUpdate' GraphQL mutation.
The following columns can be updated:
Email, Note, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Unpaid | Bool | True |
Whether no payments have been made for the order. | |
| FullyPaid | Bool | True |
Whether the order has been paid in full. | |
| SourceIdentifier | String | True |
A unique POS or third party order identifier. For example, '1234-12-1000' or '111-98567-54'. The 'receipt_number' field is derived from this value for POS orders. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| CanMarkAsPaid | Bool | True |
Whether the order can be manually marked as paid. | |
| Name | String | True |
The unique identifier for the order that appears on the order page in the Shopify admin and the order status page. For example, '#1001', 'EN1001', or '1001-A'. This value isn't unique across multiple stores. | |
| PaymentGatewayNames | String | True |
A list of the names of all payment gateways used for the order. For example, 'Shopify Payments' and 'Cash on Delivery (COD)'. | |
| Capturable | Bool | True |
Whether payment for the order can be captured. | |
| Closed | Bool | True |
Whether the order is closed. | |
| Confirmed | Bool | True |
Whether inventory has been reserved for the order. | |
| Edited | Bool | True |
Whether the order has had any edits applied. | |
| String | False |
The email address associated with the customer. | ||
| Fulfillable | Bool | True |
Whether there are line items that can be fulfilled. This field returns 'false' when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the object. | |
| Note | String | False |
The contents of the note associated with the order. | |
| Phone | String | True |
The phone number associated with the customer. | |
| Refundable | Bool | True |
Whether the order can be refunded. | |
| Restockable | Bool | True |
Whether any line item on the order can be restocked. | |
| Tags | String | True |
A comma separated list of tags associated with the order. Updating 'tags' overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the mutation. | |
| Test | Bool | True |
Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order cannot be converted into a real order and vice versa. | |
| CancelReason | String | True |
The reason provided when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| ClientIp | String | True |
The IP address of the API client that created the order. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. Returns 'null' if the order is not closed. | |
| ConfirmationNumber | String | True |
A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, XPAV284CT, R50KELTJP or 35PKUN0UJ. This value isn't guaranteed to be unique. | |
| CurrencyCode | String | True |
The shop currency when the order was placed. | |
| CustomerLocale | String | True |
A two-letter or three-letter language code, optionally followed by a region modifier. | |
| DiscountCode | String | True |
The discount code used for the order. | |
| DiscountCodes | String | True |
The discount codes used for the order. | |
| EstimatedTaxes | Bool | True |
Whether taxes on the order are estimated. This field returns 'false' when taxes on the order are finalized and aren't subject to any changes. | |
| MerchantEditable | Bool | True |
Whether the order can be edited by the merchant. For example, canceled orders can't be edited. | |
| ProcessedAt | Datetime | True |
The date and time when the order was processed. This date and time might not match the date and time when the order was created. | |
| RequiresShipping | Bool | True |
Whether the order has shipping lines or at least one line item on the order that requires shipping. | |
| ReturnStatus | String | True |
The order's aggregated return status for display purposes. | |
| RiskLevel | String | True |
The fraud risk level of the order. | |
| TaxesIncluded | Bool | True |
Whether taxes are included in the subtotal price of the order. | |
| TotalWeight | String | True |
The total weight of the order before returns, in grams. | |
| CanNotifyCustomer | Bool | True |
Whether a customer email exists for the order. | |
| CurrentTotalWeight | String | True |
The total weight of the order after returns, in grams. | |
| CustomerAcceptsMarketing | Bool | True |
Whether the customer agreed to receive marketing materials. | |
| DisplayFinancialStatus | String | True |
The financial status of the order that can be shown to the merchant. This field does not capture all the details of an order's financial state. It should only be used for display summary purposes. | |
| DisplayFulfillmentStatus | String | True |
The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the object. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the order. | |
| MerchantEditableErrors | String | True |
A list of reasons why the order can't be edited. For example, 'Canceled orders can't be edited'. | |
| PresentmentCurrencyCode | String | True |
The payment 'CurrencyCode' of the customer for the order. | |
| RegisteredSourceUrl | String | True |
The URL of the source that the order originated from, if found in the domain registry. | |
| SubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's subtotal price. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CurrentSubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's current subtotal price. | |
| CreatedAt | Datetime | True |
Date and time when the order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the order was modified last. | |
| AppId | String | True |
The application ID. | |
| MerchantOfRecordAppId | String | True |
The application ID. | |
| PhysicalLocationId | String | True |
A globally-unique ID. | |
| ChannelInformationId | String | True |
A globally-unique ID. | |
| ChannelInformationChannelId | String | True |
The unique ID for the channel. | |
| ChannelInformationAppId | String | True |
A globally-unique ID. | |
| PublicationId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | True |
A globally-unique ID. | |
| CustomerFirstName | String | True |
The customer's first name. | |
| CustomerLastName | String | True |
The customer's last name. | |
| CustomerJourneySummaryReady | Bool | True |
Whether the attributed sessions for the order have been created yet. | |
| CustomerJourneySummaryMomentsCount | Int | True |
The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. | |
| CustomerJourneySummaryCustomerOrderIndex | Int | True |
The position of the current order within the customer's order history. Test orders aren't included. | |
| CustomerJourneySummaryDaysToConversion | Int | True |
The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. | |
| CustomerJourneySummaryFirstVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryFirstVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryFirstVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryFirstVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryFirstVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryFirstVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryFirstVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryFirstVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryFirstVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryFirstVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| CustomerJourneySummaryLastVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryLastVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryLastVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryLastVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryLastVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryLastVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryLastVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryLastVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryLastVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryLastVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| DisplayAddressId | String | True |
A globally-unique ID. | |
| DisplayAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DisplayAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DisplayAddressFirstName | String | True |
The first name of the customer. | |
| DisplayAddressLastName | String | True |
The last name of the customer. | |
| DisplayAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| DisplayAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DisplayAddressCity | String | True |
The name of the city, district, village, or town. | |
| DisplayAddressCompany | String | True |
The name of the customer's company or organization. | |
| DisplayAddressCountry | String | True |
The name of the country. | |
| DisplayAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DisplayAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DisplayAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DisplayAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| DisplayAddressZip | String | True |
The zip or postal code of the address. | |
| DisplayAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DisplayAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| DisplayAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | True |
The first name of the customer. | |
| BillingAddressLastName | String | True |
The last name of the customer. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | True |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsDraftOrderId | String | True |
A globally-unique ID. | |
| CartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| ChannelInformationChannelDefinitionId | String | True |
The unique ID for the channel definition. | |
| CurrentCartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentCartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| PaymentCollectionDetailsAdditionalPaymentCollectionUrl | String | True |
The URL to use for collecting an additional payment on the order. | |
| RefundDiscrepancySetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| RefundDiscrepancySetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
OrderTransactions
Retrieves the transactions associated with the resource.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTransactions WHERE ResourceId='VALUE'
Insert
INSERT statements are mapped to the 'orderCapture' GraphQL mutation.
The following columns can be used to create a new record:
ResourceId, ParentTransactionId, Amount, Currency
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ResourceId [KEY] | String | True |
Orders.Id |
A globally-unique ID. |
| PaymentId | String | True |
The payment ID associated with the transaction. | |
| ParentTransactionId | String | True |
The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | True |
The masked account number associated with the payment method. | |
| Gateway | String | True |
The payment gateway used to process the transaction. | |
| Kind | String | True |
The kind of transaction. | |
| Status | String | True |
The status of this transaction. | |
| Test | Bool | True |
Whether the transaction is a test transaction. | |
| AuthorizationCode | String | True |
Authorization code associated with the transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | True |
The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | True |
Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | True |
Date and time when the transaction was processed. | |
| ReceiptJson | String | True |
The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | True |
The settlement currency. | |
| AuthorizationExpiresAt | Datetime | True |
The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | True |
The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | True |
Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | True |
The holder of the credit card. | |
| CardPaymentDetailsBin | String | True |
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. | |
| CardPaymentDetailsCompany | String | True |
The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | True |
The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | True |
Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | True |
The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | True |
The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | True |
The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | True |
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. | |
| PaymentIconId | String | True |
A unique ID for the image. | |
| PaymentIconWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | True |
Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | True |
Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | True |
The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | True |
The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | True |
The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Amount | Decimal |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
| Currency | String |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
PriceLists
All price lists for a shop.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM PriceLists
SELECT * FROM PriceLists WHERE Id = 'Val1'
Insert
Insert statements are mapped to the 'priceListCreate' GraphQL mutation.
The following columns can be used to create a new record:
Currency, Name, ParentAdjustmentType, ParentAdjustmentValue, ParentSettingsCompareAtMode
Update
Update statements are mapped to the 'priceListUpdate' GraphQL mutation.
The following columns can be updated:
Id, Currency, Name, ParentAdjustmentType, ParentAdjustmentValue, ParentSettingsCompareAtMode
Delete
Delete statements are mapped to the 'priceListDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Currency | String | False |
The currency for fixed prices associated with this price list. | |
| FixedPricesCount | Int | True |
The number of fixed prices on the price list. | |
| Name | String | False |
The unique name of the price list, used as a human-readable identifier. | |
| ParentAdjustmentType | String | False |
The type of price adjustment, such as percentage increase or decrease. | |
| ParentAdjustmentValue | Double | False |
The value of price adjustment, where positive numbers reduce the prices and negative numbers increase them. | |
| ParentSettingsCompareAtMode | String | False |
The type of price list adjustment setting for compare at price. |
ProductImages
Returns the images associated with the product.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- ProductId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM ProductImages
SELECT * FROM ProductImages WHERE ProductId = 'Val1'
Insert
Insert statements are mapped to the 'productAppendImages' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, AltText, Url
Update
Update statements are mapped to the 'productImageUpdate' GraphQL mutation.
The following columns can be updated:
Id, ProductId, AltText, Url
Delete
Delete statements are mapped to the 'productDeleteImages' GraphQL mutation.
You can delete entries by specifying the Id and ProductId
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the image. | |
| ProductId [KEY] | String | True |
Products.Id |
A globally-unique identifier. |
| AltText | String | False |
A word or phrase to share the nature or contents of an image. | |
| Height | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Width | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Url | String | False |
The location of the image as a URL. |
ProductResourceFeedbacks
Returns the product resource feedback for the currently authenticated app.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductResourceFeedbacks WHERE Id='VALUE'
Insert
INSERT statements are mapped to the 'bulkProductResourceFeedbackCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, FeedbackGeneratedAt, Messages, ProductUpdatedAt, State
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | String | True |
Products.Id |
The product associated with the resource feedback. |
| FeedbackGeneratedAt | Datetime | True |
The time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. | |
| Messages | String | True |
The feedback messages presented to the merchant. | |
| ProductUpdatedAt | Datetime | True |
The timestamp of the product associated with the feedback. | |
| State | String | True |
Conveys the state of the feedback and whether it requires merchant action or not. |
Products
Returns a list of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- ProductType supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- Vendor supports the '=,!=' comparison operators.
- TotalInventory supports the '=,!=,<,>,>=,<=' comparison operators.
- HasOnlyDefaultVariant supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Products WHERE Id='VALUE'
SELECT * FROM Products WHERE Title='VALUE'
SELECT * FROM Products WHERE ProductType='VALUE'
SELECT * FROM Products WHERE Status='VALUE'
SELECT * FROM Products WHERE Vendor='VALUE'
SELECT * FROM Products WHERE TotalInventory<'100'
SELECT * FROM Products WHERE HasOnlyDefaultVariant='true'
SELECT * FROM Products WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Products WHERE CreatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'productCreate' GraphQL mutation.
The following columns can be used to create a new record:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, IsGiftCard, SeoTitle, SeoDescription
The following pseudo-columns can be used to create a new record:
VariantPrice, VariantTaxable, VariantRequiresShipping
UPDATE
UPDATE statements are mapped to the 'productUpdate' GraphQL mutation.
The following columns can be updated:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, SeoTitle, SeoDescription
The following pseudo-columns can be updated:
VariantPrice, VariantTaxable, VariantRequiresShipping
DELETE
DELETE statements are mapped to the 'productDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Description | String | True |
The description of the product, complete with HTML formatting. | |
| DescriptionHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Title | String | False |
The title of the product. | |
| Handle | String | False |
A unique human-friendly string of the product's title. | |
| ProductType | String | False |
The product type specified by the merchant. | |
| Tags | String | False |
A comma separated list of tags associated with the product. Updating 'tags' overwrites any existing tags that were previously added to the product. | |
| Status | String | False |
The product status. This controls visibility across all channels. | |
| Vendor | String | False |
The name of the product's vendor. | |
| OnlineStorePreviewUrl | String | True |
The online store preview URL. | |
| OnlineStoreUrl | String | True |
The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel. | |
| RequiresSellingPlan | Bool | False |
Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription ('requiresSellingPlan: true') can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store. | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product. | |
| TracksInventory | Bool | True |
Whether inventory tracking has been enabled for the product. | |
| TotalInventory | Int | True |
The quantity of inventory in stock. | |
| HasOnlyDefaultVariant | Bool | True |
Whether the product has only a single variant with the default option and value. | |
| HasOutOfStockVariants | Bool | True |
Whether the product has out of stock variants. | |
| TotalVariants | Int | True |
The number of variants that are associated with the product. | |
| TemplateSuffix | String | True |
The theme template used when viewing the product in a store. | |
| GiftCardTemplateSuffix | String | False |
The theme template used when viewing the gift card in a store. | |
| IsGiftCard | Bool | True |
Whether the product is a gift card. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified.A product's 'updatedAt' value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| PriceRangeMaxVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMaxVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| PriceRangeMinVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMinVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| SeoTitle | String | False |
SEO Title. | |
| SeoDescription | String | False |
SEO Description. | |
| MediaCount | Int | True |
Total count of media belonging to a product. | |
| FeaturedImageId | String | True |
A unique identifier for the image. | |
| FeaturedImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| FeaturedImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageUrl | String | True |
The location of the image as a URL. | |
| ResourcePublicationOnCurrentPublicationIsPublished | Bool | True |
Whether the resource publication is published. If true, then the resource publication is published to the publication. If false, then the resource publication is staged to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublishDate | Datetime | True |
The date that the resource publication was or is going to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationId | String | True |
A globally-unique identifier. | |
| ResourcePublicationOnCurrentPublicationPublicationName | String | True |
Name of the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| ProductCategoryProductTaxonomyNodeId | String | True |
The ID of the product taxonomy node. | |
| ProductCategoryProductTaxonomyNodeName | String | True |
The name of the product taxonomy node. For example, Dog Beds. | |
| ProductCategoryProductTaxonomyNodeFullName | String | True |
The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. | |
| ProductCategoryProductTaxonomyNodeIsLeaf | Bool | True |
Whether the node is a leaf node. | |
| ProductCategoryProductTaxonomyNodeIsRoot | Bool | True |
Whether the node is a root node. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| VariantPrice | Double |
The price of the variant. |
| VariantTaxable | Bool |
Whether the variant is taxable. |
| VariantRequiresShipping | Bool |
Whether the variant requires shipping. |
ProductVariants
Returns a list of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ProductId supports the '=,!=' comparison operators.
- Title supports the '=,!=' comparison operators.
- Barcode supports the '=,!=' comparison operators.
- Sku supports the '=,!=' comparison operators.
- Taxable supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InventoryQuantity supports the '=,!=,<,>,>=,<=' comparison operators.
- DeliveryProfileId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductVariants WHERE Id = 'gid://shopify/ProductVariant/6788079091735'
SELECT * FROM ProductVariants WHERE Id IN ('gid://shopify/ProductVariant/6830135181335', 'gid://ProductVariant/Product/6830135181336')
SELECT * FROM ProductVariants WHERE ProductId='VALUE'
SELECT * FROM ProductVariants WHERE Title='VALUE'
SELECT * FROM ProductVariants WHERE Barcode='VALUE'
SELECT * FROM ProductVariants WHERE Sku='VALUE'
SELECT * FROM ProductVariants WHERE Taxable='true'
SELECT * FROM ProductVariants WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE InventoryQuantity<'100'
SELECT * FROM ProductVariants WHERE DeliveryProfileId='VALUE'
Insert
INSERT statements are mapped to the 'productVariantCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
UPDATE
UPDATE statements are mapped to the 'productVariantUpdate' GraphQL mutation.
The following columns can be updated:
Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
DELETE
DELETE statements are mapped to the 'productVariantDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| ProductId | String | True |
Products.Id |
A globally-unique identifier. |
| Position | Int | False |
The order of the product variant in the list of product variants. The first position in the list is 1. | |
| AvailableForSale | Bool | True |
Whether the product variant is available for sale. | |
| SellableOnlineQuantity | Int | True |
The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture (limitations based on customer location). | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product variant. | |
| Price | Decimal | False |
The price of the product variant in the default shop currency. | |
| CompareAtPrice | Decimal | False |
The compare-at price of the variant in the default shop currency. | |
| DisplayName | String | True |
Display name of the variant, based on product's title + variant's title. | |
| Barcode | String | False |
The value of the barcode associated with the product. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified with weight_unit. | |
| WeightUnit | String | False |
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', 'lb'. | |
| Sku | String | False |
An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. | |
| Title | String | False |
The title of the product variant. | |
| Taxable | Bool | False |
Whether a tax is charged when the product variant is sold. | |
| TaxCode | String | False |
The tax code for the product variant. | |
| UpdatedAt | Datetime | True |
The date and time when the product variant was last modified. | |
| CreatedAt | Datetime | True |
The date and time when the variant was created. | |
| InventoryPolicy | String | False |
Whether customers are allowed to place an order for the product variant when it's out of stock. | |
| InventoryQuantity | Int | True |
The total sellable quantity of the variant. | |
| InventoryItemId | String | True |
A globally-unique identifier. | |
| InventoryItemTracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| ImageId | String | False |
A unique identifier for the image. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| DeliveryProfileId | String | True |
A globally-unique identifier. | |
| FulfillmentServiceEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| FulfillmentServiceEditableReason | String | True |
The reason the attribute is locked for editing. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Options | String |
The custom properties that a shop owner uses to define product variants. |
Publications
Returns the list of publications.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- CatalogType supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Publications WHERE Id='VALUE'
SELECT * FROM Publications WHERE CatalogType='VALUE'
Insert
INSERT statements are mapped to the 'publicationCreate' GraphQL mutation.
The following columns can be used to create a new record:
AutoPublish, CatalogId, DefaultState
UPDATE
UPDATE statements are mapped to the 'publicationUpdate' GraphQL mutation.
The following columns can be updated:
AutoPublish, PublishablesToAdd, PublishablesToRemove
DELETE
DELETE statements are mapped to the 'publicationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AutoPublish | Bool | False |
Whether new products are automatically published to this publication. | |
| SupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| CatalogId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationStatus | String | True |
The status of this operation. | |
| AddAllProductsOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| AddAllProductsOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| AddAllProductsOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogCsvOperationId | String | True |
A globally-unique ID. | |
| CatalogCsvOperationStatus | String | True |
The status of this operation. | |
| CatalogCsvOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| CatalogCsvOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| CatalogCsvOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| PublicationResourceOperationId | String | True |
A globally-unique ID. | |
| PublicationResourceOperationStatus | String | True |
The status of this operation. | |
| PublicationResourceOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| PublicationResourceOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| PublicationResourceOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogType | String | True |
Filter publications by catalog type. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DefaultState | String |
Whether to create an empty publication or prepopulate it with all products. |
| PublishablesToAdd | String |
A simple, comma-separated list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50. |
| PublishablesToRemove | String |
A simple, comma-separated list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50. |
Refunds
Represents a refund of items or transactions in an order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrderId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Refunds
SELECT * FROM Refunds WHERE OrderId = 'Val1'
Insert
Insert statements are mapped to the 'refundCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrderId, Note, RefundLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Orders.Id |
A globally-unique ID. |
| Note | String | True |
The optional note associated with the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| UpdatedAt | Datetime | True |
The date and time when the refund was updated. | |
| ReturnId | String | True |
A globally-unique ID. | |
| StaffMemberId | String | True |
A globally-unique ID.(This column is available only with a ShopifyPlus subscription) | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| RefundLineItems | String |
The list of the line items in the draft order. |
Returns
Retrieves a list of returns for the order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrdersId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Returns
SELECT * FROM Returns WHERE OrdersId = 'Val1'
Insert
Insert statements are mapped to the 'returnCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrdersId, ReturnLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| OrdersId | String | True |
Orders.Id |
A globally-unique ID. |
| Name | String | True |
The name of the return. | |
| Status | String | True |
The status of the return. | |
| TotalQuantity | Int | True |
The sum of all line item quantities for the return. | |
| DeclineReason | String | True |
The reason the customer's return request was declined. | |
| DeclineNote | String | True |
The notification message sent to the customer about their declined return request. Maximum length: 500 characters. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| ReturnLineItems | String |
The list of the line items in the return. |
ScriptTags
Returns a list of script tags.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Src supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ScriptTags WHERE Id='VALUE'
SELECT * FROM ScriptTags WHERE Src='VALUE'
Insert
INSERT statements are mapped to the 'scriptTagCreate' GraphQL mutation.
The following columns can be used to create a new record:
Cache, Src, DisplayScope
UPDATE
UPDATE statements are mapped to the 'scriptTagUpdate' GraphQL mutation.
The following columns can be updated:
Cache, Src, DisplayScope
DELETE
DELETE statements are mapped to the 'scriptTagDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. If 'true', then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If 'false', then the script will be served as is. | |
| Src | String | False |
The URL to the remote script. | |
| DisplayScope | String | False |
The page or pages on the online store that the script should be included. | |
| CreatedAt | Datetime | True |
The date and time when the script tag was created. | |
| UpdatedAt | Datetime | True |
The date and time when the script tag was last updated. |
SellingPlanGroups
Returns a list Selling Plan Groups.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- CreatedAt supports the '<,>,>=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM SellingPlanGroups
SELECT * FROM SellingPlanGroups WHERE Id = 'Val1'
SELECT * FROM SellingPlanGroups WHERE Name = 'Val1'
SELECT * FROM SellingPlanGroups WHERE CreatedAt < '2023-01-01 11:10:00'
Insert
Insert statements are mapped to the 'sellingPlanGroupCreate' GraphQL mutation.
The following columns can be used to create a new record:
AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate
The following pseudo-columns can be used to create a new record:
ProductIds, ProductVariantIds
Update
Update statements are mapped to the 'sellingPlanGroupUpdate' GraphQL mutation.
The following columns can be updated:
Id, AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate, SellingPlansToUpdate
The following pseudo-columns can be updated:
SellingPlansToDelete
Delete
Delete statements are mapped to the 'sellingPlanGroupDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppId | String | False |
The ID for app, exposed in Liquid and product JSON. | |
| Name | String | False |
The buyer-facing label of the selling plan group. | |
| Description | String | False |
The merchant-facing description of the selling plan group. | |
| Options | String | False |
The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | False |
The relative position of the selling plan group for display. | |
| Summary | String | True |
A summary of the policies associated to the selling plan group. | |
| MerchantCode | String | False |
The merchant-facing label of the selling plan group. | |
| ProductCount | Int | True |
A count of products associated to the selling plan group. | |
| CreatedAt | Datetime | True |
The date and time when the selling plan group was created. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| SellingPlansToCreate | String |
List of selling plans to create. |
| SellingPlansToUpdate | String |
List of selling plans to update. |
| SellingPlansToDelete | String |
List of selling plans to delete as a simple, comma-separated list. |
| ProductIds | String |
The IDs of the Products to add to the Selling Plan Group as a simple, comma-separated list. |
| ProductVariantIds | String |
The IDs of the Variants to add to the Selling Plan Group as a simple, comma-separated list. |
StorefrontAccessTokens
Retrieves the storefront access token of a private application. These are scoped per-application.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'storefrontAccessTokenCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title
DELETE
DELETE statements are mapped to the 'storefrontAccessTokenDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ShopId | String | True |
Shop.Id |
A globally-unique ID. |
| Title | String | True |
An arbitrary title for each token determined by the developer, used for reference purposes. | |
| AccessToken | String | True |
The issued public access token. | |
| CreatedAt | Datetime | True |
The date and time when the public access token was created. | |
| UpdatedAt | Datetime | True |
The date and time when the storefront access token was updated. |
UrlRedirects
Returns a list of redirects for a shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Path supports the '=,!=' comparison operators.
- Target supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM UrlRedirects WHERE Id='VALUE'
SELECT * FROM UrlRedirects WHERE Path='VALUE'
SELECT * FROM UrlRedirects WHERE Target='VALUE'
Insert
INSERT statements are mapped to the 'urlRedirectCreate' GraphQL mutation.
The following columns can be used to create a new record:
Path, Target
UPDATE
UPDATE statements are mapped to the 'urlRedirectUpdate' GraphQL mutation.
The following columns can be updated:
Path, Target
DELETE
DELETE statements are mapped to the 'urlRedirectDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the URL redirect. | |
| Path | String | False |
The old path to be redirected from. When the user visits this path, they will be redirected to the target location. | |
| Target | String | False |
The target location where the user will be redirected to. |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| Abandonment | Returns abandonment. |
| AbandonmentProductsAddedToCart | Returns the products added to the cart during the customer abandoned visit. |
| AbandonmentProductsViewed | Returns the products viewed during the customer abandoned visit. |
| AppCredits | Lists credits that can be used towards future app purchases. |
| ArticleComments | Returns a list of comments posted on an article. |
| Articles | Returns a list of the shop's visible articles. |
| AssignedFulfillmentOrders | Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default. |
| Blogs | Retrieves a list of the shop's blogs. |
| CarrierServices | Returns a list of activated carrier services and associated shop locations that support them. |
| CollectionProducts | Retrieves a list of the products inside of a collection. |
| CompanyEvents | Retrieves a paginated list of events associated with the host subject. |
| CustomerEvents | Retrieves a paginated list of events associated with the host subject. |
| DeliveryProfileLocationGroupCountries | Lists countries already selected in any zone for the specified location group. |
| DeliveryProfileLocationGroupCountryProvinces | Returns the list of regions associated with this country. |
| DeliveryProfileLocationGroups | Lists the location groups using this profile. |
| DeliveryProfileLocationGroupZones | Lists the applicable zones associated to the specified location group. |
| DeliveryProfileUnassignedLocations | Lists the locations that have not been assigned to a location group for this profile. |
| DiscountEvents | Retrieves a paginated list of events associated with the host subject. |
| DiscountsCodeFreeShipping | Returns a list of discounts. |
| DraftOrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderEvents | Retrieves a paginated list of events associated with the host subject. |
| DraftOrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderLineItems | Returns a list of the line items in the draft order. |
| DraftOrderLineItemTaxLines | Represents a single tax applied to the associated resource. |
| DraftOrderTaxLines | Represents a single tax applied to the associated resource. |
| InventoryItemCountryHarmonizedSystemCodes | Returns a list of country specific harmonized system codes. |
| InventoryItemInventoryLevels | Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at. |
| Jobs | Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. |
| Locations | Returns a list of active inventory locations. |
| MarketingEvents | Returns a list of marketing events associated with the marketing app. |
| MetaobjectDefinitions | Provides the definition of a generic object structure composed of metafields. |
| MetaObjects | All metaobjects for the shop. |
| OrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderDiscountApplications | Returns a list of discounts that are applied to the order, not including order edits and refunds. |
| OrderEvents | Retrieves a paginated list of events associated with the host subject. |
| OrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderLineItemDiscountAllocations | Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds. |
| OrderLineItems | Retrieves a list of line items in the associated resource. |
| OrderNonFulfillableLineItems | Retrieves a list of line items in the associated resource. |
| OrderRisks | Lists the order risks associated with this order. |
| OrderTaxLines | Represents a single tax applied to the associated resource. |
| Pages | Returns a list of the shop's pages. |
| ProductOptions | Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. |
| PublicationCollections | Returns a list of collections published to the publication. |
| PublicationProducts | Returns the list of publication for products. |
| RefundDuties | Lists the refunded duties as part of this refund. |
| RefundLineItems | Retrieves the 'RefundLineItem' resources attached to the refund. |
| RefundTransactionFees | Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions. |
| RefundTransactions | Retrieves the transactions associated with the resource. |
| ReturnLineItems | Retrieves the return line items attached to the return. |
| SellingPlanGroupSellingPlans | Retrieves selling plans associated to the selling plan group. |
| Shop | Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop. |
| ShopifyPaymentsAccount | Returns Shopify Payments account information, including balances and payouts. |
| ShopifyPaymentsAccountBalance | Returns current balances in all currencies for the account. |
| ShopifyPaymentsAccountBankAccounts | Lists all bank accounts configured for the Shopify Payments account. |
| ShopifyPaymentsAccountDisputes | Lists all disputes related to the Shopify Payments account. |
| ShopifyPaymentsAccountPayouts | Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries. |
| ShopifyPaymentsAccountPermittedVerificationDocuments | Retrieves the permitted documents for identity verification. |
| ShopifyPaymentsAccountVerifications | Returns the verifications necessary for this account. |
| StaffMembers | Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription) |
| TenderTransactions | Returns a list of TenderTransactions associated with the shop. |
Abandonment
Returns abandonment.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- Id supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Abandonment WHERE Id='VALUE'
SELECT * FROM Abandonment WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppId | String | A globally-unique ID. | |
| CustomerId | String | A globally-unique ID. | |
| AbandonmentType | String | The abandonment type. | |
| EmailState | String | The email state (e.g., sent or not sent). | |
| InventoryAvailable | Bool | Whether the products in abandonment are available. | |
| EmailSentAt | Datetime | When the email was sent, if that is the case. | |
| MostRecentStep | String | The most recent step type. | |
| VisitStartedAt | Datetime | The date and time when the visit started. | |
| IsFromOnlineStore | Bool | Whether the abandonment event comes from the Online Store sales channel. | |
| IsFromShopApp | Bool | Whether the abandonment event comes from the Shop app sales channel. | |
| IsFromShopPay | Bool | Whether the abandonment event comes from Shop Pay. | |
| IsMostSignificantAbandonment | Bool | Whether the customer did not complete another most significant step since this abandonment. | |
| LastBrowseAbandonmentDate | Datetime | The date for the latest browse abandonment. | |
| LastCartAbandonmentDate | Datetime | The date for the latest cart abandonment. | |
| LastCheckoutAbandonmentDate | Datetime | The date for the latest checkout abandonment. | |
| DaysSinceLastAbandonmentEmail | Int | The number of days since the last abandonment email was sent to the customer. | |
| HoursSinceLastAbandonedCheckout | Double | The number of hours since the customer has last abandoned a checkout. | |
| CustomerHasNoOrderSinceAbandonment | Bool | Whether the customer has completed an order since this checkout has been abandoned. | |
| CreatedAt | Datetime | The date and time when the abandonment was created. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadDefaultCursor | String | A default cursor that returns the single next record, sorted ascending by ID. | |
| AbandonedCheckoutPayloadAbandonedCheckoutUrl | String | The URL for the buyer to recover their checkout. | |
| AbandonedCheckoutPayloadLineItemsQuantity | Int | The number of products in the checkout. |
AbandonmentProductsAddedToCart
Returns the products added to the cart during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AbandonmentProductsViewed
Returns the products viewed during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsViewed WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsViewed WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String |
Abandonment.Id | A globally-unique ID. |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId [KEY] | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AppCredits
Lists credits that can be used towards future app purchases.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppCredits WHERE AppInstallationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppInstallationId | String | A globally-unique ID. | |
| Description | String | The description of the app credit. | |
| Test | Bool | Whether the app credit is a test transaction. | |
| CreatedAt | Datetime | The date and time when the app credit was created. | |
| Amount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. |
ArticleComments
Returns a list of comments posted on an article.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ArticleId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ArticleComments WHERE ArticleId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ArticleId | String |
Articles.Id | A globally-unique ID. |
| ContentHtml | String | The content of the comment, complete with HTML formatting. | |
| AuthorName | String | The author's name. | |
| AuthorEmail | String | The author's email. |
Articles
Returns a list of the shop's visible articles.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AuthorV2Name supports the '=,!=' comparison operators.
- AuthorV2FirstName supports the '=,!=' comparison operators.
- AuthorV2LastName supports the '=,!=' comparison operators.
- BlogTitle supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Articles WHERE Id='VALUE'
SELECT * FROM Articles WHERE AuthorV2Name='VALUE'
SELECT * FROM Articles WHERE AuthorV2FirstName='VALUE'
SELECT * FROM Articles WHERE AuthorV2LastName='VALUE'
SELECT * FROM Articles WHERE BlogTitle='VALUE'
SELECT * FROM Articles WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Articles WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The article's name. | |
| Handle | String | A human-friendly unique string for the Article automatically generated from its title. | |
| Tags | String | A categorization that a article can be tagged with. | |
| ContentHtml | String | The content of the article, complete with HTML formatting. | |
| ExcerptHtml | String | The excerpt of the article, complete with HTML formatting. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| PublishedAt | Datetime | The date and time when the article was published. | |
| AuthorV2Name | String | The author's full name. | |
| AuthorV2FirstName | String | The author's first name. | |
| AuthorV2LastName | String | The author's last name. | |
| AuthorV2Bio | String | The author's bio. | |
| AuthorV2Email | String | The author's email. | |
| BlogId | String | A globally-unique ID. | |
| BlogTitle | String | The blogs's title. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the article was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the article was last updated. This column can only be used as an input for filtering. |
AssignedFulfillmentOrders
Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AssignedLocationLocationId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| OrderId | String | A globally-unique ID. | |
| Status | String | The status of the fulfillment order. | |
| FulfillAt | Datetime | The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| RequestStatus | String | The request status of the fulfillment order. | |
| CreatedAt | Datetime | Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | The date and time when the fulfillment order was last updated. | |
| AssignedLocationName | String | The name of the location. | |
| AssignedLocationAddress1 | String | The first line of the address for the location. | |
| AssignedLocationAddress2 | String | The second line of the address for the location. | |
| AssignedLocationCity | String | The city of the location. | |
| AssignedLocationPhone | String | The phone number of the location. | |
| AssignedLocationProvince | String | The province of the location. | |
| AssignedLocationZip | String | The ZIP code of the location. | |
| AssignedLocationCountryCode | String | The two-letter country code of the location. | |
| AssignedLocationLocationId | String | A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | The name of the location. | |
| AssignedLocationLocationActivatable | Bool | Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | A globally-unique ID. | |
| DeliveryMethodMethodType | String | The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | A globally-unique ID. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationEmail | String | The email of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| DestinationProvince | String | The province of the destination. | |
| DestinationZip | String | The ZIP code of the destination. | |
| DestinationCountryCode | String | The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | The method of duties payment. Example values: 'DDP', 'DAP'. |
Blogs
Retrieves a list of the shop's blogs.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Blogs WHERE Id='VALUE'
SELECT * FROM Blogs WHERE Title='VALUE'
SELECT * FROM Blogs WHERE Handle='VALUE'
SELECT * FROM Blogs WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Blogs WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The blogs's title. | |
| Handle | String | A human-friendly unique string for the Blog automatically generated from its title. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the blog was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the blog was last updated. This column can only be used as an input for filtering. |
CarrierServices
Returns a list of activated carrier services and associated shop locations that support them.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.
For example, the following queries are processed client-side:
SELECT * FROM CarrierServices WHERE Id = 'VALUE'
Columns
| Name | Type | References | Description |
| Id | String | A globally-unique ID. | |
| Name | String | The name of the shipping service provider. | |
| FormattedName | String | The properly formatted name of the shipping service provider, ready to display. | |
| IconAltText | String | A word or phrase to share the nature or contents of an image. | |
| IconHeight | Int | The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. | |
| IconId | String | A unique ID for the image. | |
| IconWidth | Int | The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. |
CollectionProducts
Retrieves a list of the products inside of a collection.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CollectionId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CollectionProducts WHERE CollectionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique identifier. | |
| CollectionId | String |
Collections.Id | A globally-unique identifier for the collection. |
| Title | String | The title of the product. | |
| Position | Int | The position in which the products are sorted. |
CompanyEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Companies.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
CustomerEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CustomerEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Customers.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DeliveryProfileLocationGroupCountries
Lists countries already selected in any zone for the specified location group.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| CountryId [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Zone | String | The name of the shipping zone. | |
| CountryName | String | The full name of the country. | |
| CountryTranslatedName | String | The translated name of the country. The translation returned is based on the system's locale. | |
| CountryCodeCountryCode | String | The country code in the ISO 3166-1 alpha-2 format. | |
| CountryCodeRestOfWorld | Bool | Whether the country is a part of the 'Rest of World' shipping zone. |
DeliveryProfileLocationGroupCountryProvinces
Returns the list of regions associated with this country.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| CountryId | String | A globally-unique ID. | |
| Code | String | The code of the region. | |
| Name | String | The full name of the region. | |
| TranslatedName | String | The translated name of the region. The translation returned is based on the system's locale. |
DeliveryProfileLocationGroups
Lists the location groups using this profile.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| LocationsCount | Int | A count of all locations that are part of this location group. |
DeliveryProfileLocationGroupZones
Lists the applicable zones associated to the specified location group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileLocationGroupZones WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | Filter the location groups of the profile by location group ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Name | String | The name of the zone. | |
| MethodDefinitionCountsParticipantDefinitionsCount | Int | The number of participant method definitions for the specified zone. | |
| MethodDefinitionCountsRateDefinitionsCount | Int | The number of merchant-defined method definitions for the specified zone. |
DeliveryProfileUnassignedLocations
Lists the locations that have not been assigned to a location group for this profile.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileUnassignedLocations WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| DeliveryProfileId [KEY] | String | A globally-unique ID. | |
| LocationId [KEY] | String |
Locations.Id | A globally-unique ID. |
DiscountEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DiscountEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String | A globally-unique ID. | |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DiscountsCodeFreeShipping
Returns a list of discounts.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeFreeShipping WHERE Title='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE StartsAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the discount. | |
| Status | String | The status of the discount. | |
| Summary | String | A detailed summary of the discount. | |
| CodeCount | Int | The number of redeem codes for the discount. | |
| DiscountClass | String | The class of the discount for combining purposes. | |
| EndsAt | Datetime | The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | A short summary of the discount. | |
| StartsAt | Datetime | The date and time when the discount starts. | |
| UsageLimit | Int | The maximum number of times that the discount can be used. | |
| AppliesOnSubscription | Bool | Whether the discount applies on subscription shipping lines. | |
| AsyncUsageCount | Int | The number of times that the discount has been used. | |
| HasTimelineComment | Bool | Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | Whether the discount can be applied only once per customer. | |
| AppliesOnOneTimePurchase | Bool | Whether the discount applies on regular one-time-purchase shipping lines. | |
| CreatedAt | Datetime | The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountCountriesCountries | String | The codes for the countries where the discount can be applied. | |
| DiscountCountriesIncludeRestOfWorld | Bool | Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. | |
| DiscountCountryAllAllCountries | Bool | Whether the discount can be applied to all countries as shipping destination. This value is always 'true'. | |
| MaximumShippingPriceAmount | Decimal | Decimal money amount. | |
| MaximumShippingPriceCurrencyCode | String | Currency of the money. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | Decimal money amount. | |
| TotalSalesCurrencyCode | String | Currency of the money. |
DraftOrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
DraftOrders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DraftOrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderLineItems
Returns a list of the line items in the draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DraftOrderId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItems WHERE DraftOrderId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DraftOrderId | String |
DraftOrders.Id | A globally-unique ID. |
| Name | String | The name of the product. | |
| Title | String | The title of the product or variant. This field only applies to custom line items. | |
| VariantTitle | String | The name of the variant. | |
| Custom | Bool | Whether the line item is a custom line item ('true') or a product variant line item ('false'). | |
| Quantity | Int | The number of product variants that are requested in the draft order. | |
| Sku | String | The SKU number of the product variant. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who created the product variant. | |
| DiscountedTotal | Decimal | The line item price after discounts are applied. | |
| OriginalTotal | Decimal | The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| TotalDiscount | Decimal | The total value of the discount that is applied to the line item. | |
| DiscountedUnitPrice | Decimal | The 'discountedTotal' divided by 'quantity', resulting in the value of the discount per unit. | |
| IsGiftCard | Bool | Whether the line item is a gift card. | |
| OriginalUnitPrice | Decimal | The variant price without any discounts applied. | |
| AppliedDiscountTitle | String | Name of the order-level discount. | |
| AppliedDiscountDescription | String | Description of the order-level discount. | |
| AppliedDiscountValue | Double | The order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount. | |
| AppliedDiscountValueType | String | Type of the order-level discount. | |
| AppliedDiscountAmountV2Amount | Decimal | Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ProductId | String | A globally-unique ID. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| VariantId | String | A globally-unique ID. | |
| WeightValue | Double | The weight value using the unit system specified with 'unit'. | |
| WeightUnit | String | The unit of measurement for 'value'. |
DraftOrderLineItemTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
DraftOrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
InventoryItemCountryHarmonizedSystemCodes
Returns a list of country specific harmonized system codes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemCountryHarmonizedSystemCodes WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| InventoryItemId | String | A globally-unique ID. | |
| CountryCode | String | The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. | |
| HarmonizedSystemCode [KEY] | String | The country-specific harmonized system code. These are usually longer than 6 digits. |
InventoryItemInventoryLevels
Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemInventoryLevels WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| InventoryItemId | String | A globally-unique ID. | |
| LocationId | String | A globally-unique ID. | |
| CanDeactivate | Bool | Whether the inventory items associated with the inventory level can be deactivated. | |
| DeactivationAlert | String | Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. | |
| CreatedAt | Datetime | The date and time when the inventory level was created. | |
| UpdatedAt | Datetime | The date and time when the inventory level was updated. |
Jobs
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Jobs WHERE Id='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID that's returned when running an asynchronous mutation. | |
| Done | Bool | This indicates if the job is still queued or has been run. |
Locations
Returns a list of active inventory locations.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- IsActive supports the '=,!=' comparison operators.
- AddressAddress1 supports the '=,!=' comparison operators.
- AddressAddress2 supports the '=,!=' comparison operators.
- AddressCity supports the '=,!=' comparison operators.
- AddressCountry supports the '!=' comparison operators.
- AddressProvince supports the '=,!=' comparison operators.
- AddressZip supports the '=,!=' comparison operators.
- IncludeInactive supports the '=' comparison operator.
- IncludeLegacy supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Locations WHERE Id='VALUE'
SELECT * FROM Locations WHERE Name='VALUE'
SELECT * FROM Locations WHERE IsActive='true'
SELECT * FROM Locations WHERE AddressAddress1='VALUE'
SELECT * FROM Locations WHERE AddressAddress2='VALUE'
SELECT * FROM Locations WHERE AddressCity='VALUE'
SELECT * FROM Locations WHERE AddressCountry != 'VALUE'
SELECT * FROM Locations WHERE AddressProvince='VALUE'
SELECT * FROM Locations WHERE AddressZip='VALUE'
SELECT * FROM Locations WHERE IncludeInactive='true'
SELECT * FROM Locations WHERE IncludeLegacy='true'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| Name | String | The name of the location. | |
| Activatable | Bool | Whether this location can be reactivated. | |
| Deactivatable | Bool | Whether this location can be deactivated. | |
| Deletable | Bool | Whether this location can be deleted. | |
| AddressVerified | Bool | Whether the location address has been verified. | |
| DeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| IsActive | Bool | Whether the location is active. | |
| ShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| FulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| HasActiveInventory | Bool | Whether this location has active inventory. | |
| HasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| AddressAddress1 | String | The first line of the address for the location. | |
| AddressAddress2 | String | The second line of the address for the location. | |
| AddressCity | String | The city of the location. | |
| AddressCountry | String | The country of the location. | |
| AddressFormatted | String | A formatted version of the address for the location. | |
| AddressLatitude | Double | The latitude coordinates of the location. | |
| AddressLongitude | Double | The longitude coordinates of the location. | |
| AddressPhone | String | The phone number of the location. | |
| AddressProvince | String | The province of the location. | |
| AddressZip | String | The ZIP code of the location. | |
| AddressCountryCode | String | The country code of the location. | |
| AddressProvinceCode | String | The code for the province, state, or district of the address of the location. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| LocalPickupSettingsV2Instructions | String | Additional instructions or information related to the local pickup. | |
| LocalPickupSettingsV2PickupTime | String | The estimated pickup time to show customers at checkout. | |
| IncludeInactive | Bool | If true, also include the locations that are deactivated. | |
| IncludeLegacy | Bool | If true, also include the legacy locations of fulfillment services. |
MarketingEvents
Returns a list of marketing events associated with the marketing app.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AppId supports the '=,!=' comparison operators.
- Type supports the '=,!=' comparison operators.
- StartedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM MarketingEvents WHERE Id='VALUE'
SELECT * FROM MarketingEvents WHERE AppId='VALUE'
SELECT * FROM MarketingEvents WHERE Type='VALUE'
SELECT * FROM MarketingEvents WHERE StartedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| RemoteId | String | An optional ID that helps Shopify validate engagement data. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AppId | String | A globally-unique ID. | |
| Channel | String | The marketing channel used by the marketing event. | |
| Description | String | A human-readable description of the marketing event. | |
| Type | String | The marketing event type. | |
| EndedAt | Datetime | The date and time when the marketing event ended. | |
| ManageUrl | String | The URL where the marketing event can be managed. | |
| PreviewUrl | String | The URL where the marketing event can be previewed. | |
| StartedAt | Datetime | The date and time when the marketing event started. | |
| UtmCampaign | String | The name of the marketing campaign. | |
| UtmMedium | String | The medium that the marketing campaign is using. Example values: 'cpc', 'banner'. | |
| UtmSource | String | The referrer of the marketing event. Example values: 'google', 'newsletter'. | |
| SourceAndMedium | String | Where the 'MarketingEvent' occurred and what kind of content was used. Because 'utmSource' and 'utmMedium' are often used interchangeably, this is based on a combination of 'marketingChannel', 'referringDomain', and 'type' to provide a consistent representation for any given piece of marketing regardless of the app that created it. | |
| ScheduledToEndAt | Datetime | The date and time when the marketing event is scheduled to end. |
MetaobjectDefinitions
Provides the definition of a generic object structure composed of metafields.
Select
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server side:
SELECT * FROM MetaobjectDefinitions
Columns
| Name | Type | References | Description |
| ID | ID | A globally-unique ID. | |
| Name | String | The human-readable name. | |
| MetaobjectsCount | Int | The count of metaobjects created for the definition. | |
| Type | String | The type of the object definition. Defines the namespace of associated metafields. | |
| Description | String | The administrative description. | |
| DisplayNameKey | String | The key of a field to reference as the display name for each object. |
MetaObjects
All metaobjects for the shop.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Type supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM MetaObjects
SELECT * FROM MetaObjects WHERE Type = 'Val1'
Columns
| Name | Type | References | Description |
| ID [KEY] | ID | A globally-unique ID. | |
| Handle | String | The unique handle of the object, useful as a custom ID. | |
| DisplayName | String | The preferred display name field value of the metaobject. | |
| CreatedByDeveloperName | String | The name of the app developer. | |
| Title | String | Name of the app. | |
| Type | String | The type of the metaobject. | |
| Key [KEY] | String | The object key of this field. | |
| Value | String | The assigned field value, always stored as a string regardless of the field type. | |
| UpdatedAt | Datetime | When the object was last updated. |
OrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderDiscountApplications
Returns a list of discounts that are applied to the order, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderDiscountApplications WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String |
Orders.Id | A globally-unique ID. |
| AllocationMethod | String | The method by which the discount's value is applied to its entitled items. | |
| Index [KEY] | Int | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| TargetSelection | String | How the discount amount is distributed on the discounted lines. | |
| TargetType | String | Whether the discount is applied on line items or shipping lines. | |
| ValueAmount | Decimal | The value of the discount application. Decimal money amount. | |
| ValueCurrencyCode | String | The value of the discount application. Currency of the money. | |
| ValuePercentage | Double | The value of the discount application. The percentage value of the object. This is a number between -100 (free) and 0 (no discount). | |
| AutomaticDiscountApplicationTitle | String | The title of the discount application. | |
| DiscountCodeApplicationCode | String | The string identifying the discount code that was used at the time of application. | |
| ManualDiscountApplicationTitle | String | The title of the discount application. | |
| ManualDiscountApplicationDescription | String | The description of the discount application. | |
| ScriptDiscountApplicationTitle | String | The title of the discount application. |
OrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Orders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
OrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderLineItemDiscountAllocations
Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderLineItemId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemDiscountAllocations WHERE OrderLineItemId='VALUE'
Columns
| Name | Type | References | Description |
| OrderLineItemId | String | The ID of the Order to return. | |
| DiscountApplicationIndex [KEY] | Decimal | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| AllocatedAmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AllocatedAmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderNonFulfillableLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderNonFulfillableLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderRisks
Lists the order risks associated with this order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderRisks WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String | The order which this order risk is associated. | |
| Display | Bool | Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. | |
| Level | String | The likelihood that an order is fraudulent, based on this order risk. The level can be set by Shopify risk analysis or by an app. | |
| Message [KEY] | String | The risk message that's shown to the merchant in the Shopify admin. |
OrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
Pages
Returns a list of the shop's pages.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Pages WHERE Title='VALUE'
SELECT * FROM Pages WHERE Handle='VALUE'
SELECT * FROM Pages WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Pages WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the page. | |
| Body | String | The description of the page, complete with HTML formatting. | |
| Handle | String | A human-friendly unique string for the page automatically generated from its title. | |
| BodySummary | String | Summary of the page body. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| CreatedAt | Datetime | The timestamp of the page creation. | |
| UpdatedAt | Datetime | The timestamp of the latest page update. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. |
ProductOptions
Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ProductId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ProductOptions WHERE ProductId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique identifier. | |
| ProductId | String |
Products.Id | A globally-unique identifier. |
| Name | String | The product option's name. | |
| Position | Int | The product option's position. | |
| Values | String | The corresponding value to the product option name. |
PublicationCollections
Returns a list of collections published to the publication.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationCollections WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| PublicationId | String |
Publications.Id | A globally-unique ID. |
PublicationProducts
Returns the list of publication for products.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationProducts WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| ProductId [KEY] | String | A globally-unique ID. | |
| PublishDate | Datetime | The date that the resource publication was or is going to be published to the publication. | |
| IsPublished | Bool | Whether the resource publication is published. | |
| PublicationId [KEY] | String | A globally-unique ID. | |
| PublicationName | String | Name of the publication. |
RefundDuties
Lists the refunded duties as part of this refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundDuties WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| OriginalDutyId [KEY] | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| OriginalDutyHarmonizedSystemCode | String | The harmonized system code of the item used in calculating the duty. | |
| OriginalDutyCountryCodeOfOrigin | String | The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundLineItems
Retrieves the 'RefundLineItem' resources attached to the refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundLineItems WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| LineItemId | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| LineItemName | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| LineItemTitle | String | The title of the product at time of order creation. | |
| LineItemVariantTitle | String | The title of the variant at time of order creation. | |
| LineItemQuantity | Int | The number of variant units ordered. | |
| LineItemRestockable | Bool | Whether the line item can be restocked. | |
| LineItemSku | String | The variant SKU number. | |
| LineItemTaxable | Bool | Whether the variant is taxable. | |
| LineItemVendor | String | The name of the vendor who made the variant. | |
| LineItemCurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemMerchantEditable | Bool | Whether the line item can be edited or not. | |
| LineItemRefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemNonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| LineItemRequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| LineItemUnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| LineItemImageId | String | A unique ID for the image. | |
| LineItemImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| LineItemImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageUrl | String | The location of the image as a URL. | |
| LineItemProductId | String | A globally-unique ID. | |
| LineItemVariantId | String | A globally-unique ID. | |
| LineItemSellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| LineItemStaffMemberId | String | A globally-unique ID.(This column is available only with a ShopifyPlus subscription) | |
| Quantity | Int | The quantity of a refunded line item. | |
| Restocked | Bool | Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. | |
| RestockType | String | The type of restock for the refunded line item. | |
| LocationId | String | A globally-unique ID. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundTransactionFees
Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactionFees WHERE TransactionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| TransactionId | String | A globally-unique ID. | |
| RateName | String | Name of the credit card rate. | |
| FlatFeeName | String | Name of the credit card flat fee. | |
| Rate | Decimal | Percentage charge. | |
| Type | String | Name of the type of fee. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| FlatFeeAmount | Decimal | Decimal money amount. | |
| FlatFeeCurrencyCode | String | Currency of the money. | |
| TaxAmountAmount | Decimal | Decimal money amount. | |
| TaxAmountCurrencyCode | String | Currency of the money. |
RefundTransactions
Retrieves the transactions associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactions WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| PaymentId | String | The payment ID associated with the transaction. | |
| ParentTransactionId | String | The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | The masked account number associated with the payment method. | |
| Gateway | String | The payment gateway used to process the transaction. | |
| Kind | String | The kind of transaction. | |
| Status | String | The status of this transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| AuthorizationCode | String | Authorization code associated with the transaction. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| ReceiptJson | String | The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | The settlement currency. | |
| AuthorizationExpiresAt | Datetime | The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | The holder of the credit card. | |
| CardPaymentDetailsBin | String | 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. | |
| CardPaymentDetailsCompany | String | The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | 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. | |
| PaymentIconId | String | A unique ID for the image. | |
| PaymentIconWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Amount | Decimal | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. | |
| Currency | String | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
ReturnLineItems
Retrieves the return line items attached to the return.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ReturnLineItems WHERE ReturnId='VALUE'
Insert
INSERT statements are mapped to the 'priceListCreate' GraphQL mutation.
The following columns can be used to create a new record:
Quantity, ReturnReason, ReturnReasonNote, FulfillmentLineItemId
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ReturnId [KEY] | String |
Returns.Id | A globally-unique ID. |
| Quantity | Int | The quantity being returned. | |
| CustomerNote | String | A note from the customer that describes the item to be returned. Maximum length: 300 characters. | |
| RefundableQuantity | Int | The quantity that can be refunded. | |
| RefundedQuantity | Int | The quantity that was refunded. | |
| ReturnReason | String | The reason for returning the item. | |
| ReturnReasonNote | String | Additional information about the reason for the return. Maximum length: 255 characters. | |
| TotalWeightUnit | String | The unit of measurement for `value`. | |
| TotalWeightValue | Double | The weight value using the unit system specified with `unit`. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| WithCodeDiscountedTotalPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentLineItemId | String | A globally-unique ID. |
SellingPlanGroupSellingPlans
Retrieves selling plans associated to the selling plan group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the SellingPlanGroupId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM SellingPlanGroupSellingPlans WHERE SellingPlanGroupId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| SellingPlanGroupId | String | A globally-unique ID. | |
| Name | String | A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies. | |
| Category | String | The category used to classify the selling plan for reporting purposes. | |
| Description | String | Buyer facing string which describes the selling plan commitment. | |
| Options | String | The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | Relative position of the selling plan for display. A lower position will be displayed before a higher position. | |
| CreatedAt | Datetime | The date and time when the selling plan was created. | |
| InventoryPolicyReserve | String | When to reserve inventory for the order. | |
| FixedBillingPolicyCheckoutChargeType | String | The charge type for the checkout charge. | |
| FixedBillingPolicyCheckoutChargeValueAmount | Decimal | The charge value for the checkout charge. Decimal money amount. | |
| FixedBillingPolicyCheckoutChargeValueCurrencyCode | String | The charge value for the checkout charge. Currency of the money. | |
| FixedBillingPolicyCheckoutChargeValuePercentage | Double | The charge value for the checkout charge. The percentage value of the price used for checkout charge. | |
| FixedBillingPolicyRemainingBalanceChargeExactTime | Datetime | The exact time when to capture the full payment. | |
| FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout | String | The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. | |
| FixedBillingPolicyRemainingBalanceChargeTrigger | String | When to capture payment for amount due. | |
| RecurringBillingPolicyAnchors | String | Specific anchor dates upon which the billing interval calculations should be made. Aggregate value. | |
| RecurringBillingPolicyCreatedAt | Datetime | The date and time when the selling plan billing policy was created. | |
| RecurringBillingPolicyInterval | String | The billing frequency, it can be either: day, week, month or year. | |
| RecurringBillingPolicyIntervalCount | Int | The number of intervals between billings. | |
| RecurringBillingPolicyMaxCycles | Int | Maximum number of billing iterations. | |
| RecurringBillingPolicyMinCycles | Int | Minimum number of billing iterations. | |
| FixedDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| FixedDeliveryPolicyCutoff | Int | A buffer period for orders to be included in next fulfillment anchor. | |
| FixedDeliveryPolicyFulfillmentExactTime | Datetime | The date and time when the fulfillment should trigger. | |
| FixedDeliveryPolicyFulfillmentTrigger | String | What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. | |
| FixedDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| FixedDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| RecurringDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| RecurringDeliveryPolicyCreatedAt | Datetime | The date and time when the selling plan delivery policy was created. | |
| RecurringDeliveryPolicyCutoff | Int | Number of days which represent a buffer period for orders to be included in a cycle. | |
| RecurringDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| RecurringDeliveryPolicyInterval | String | The delivery frequency, it can be either: day, week, month or year. | |
| RecurringDeliveryPolicyIntervalCount | Int | The number of intervals between deliveries. | |
| RecurringDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| FixedPricingPolicies | String | Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value. | |
| RecurringPricingPolicies | String | Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value. |
Shop
Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Name | String | The shop's name. | |
| RichTextEditorUrl | String | The URL of the rich text editor that can be used for mobile devices. | |
| Description | String | The shop's meta description used in search engine results. | |
| String | The shop owner's email address. Shopify will use this email address to communicate with the shop owner. | ||
| Url | String | The URL of the shop's online store. | |
| ContactEmail | String | The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. | |
| CurrencyCode | String | The three letter code for the currency that the shop sells in. | |
| CustomerAccounts | String | Whether customer accounts are required, optional, or disabled for the shop. | |
| IanaTimezone | String | The shop's time zone as defined by the IANA. | |
| MyshopifyDomain | String | The shop's . myshopify. com domain name. | |
| PublicationCount | Int | The number of publications for the shop. | |
| SetupRequired | Bool | Whether the shop has outstanding setup steps. | |
| TaxShipping | Bool | Whether the shop charges taxes for shipping. | |
| TaxesIncluded | Bool | Whether applicable taxes are included in the shop's product prices. | |
| TimezoneAbbreviation | String | The shop's time zone abbreviation. | |
| TimezoneOffset | String | The shop's time zone offset. | |
| UnitSystem | String | The shop's unit system for weights and measures. | |
| WeightUnit | String | The shop's primary unit of weight for products and shipping. | |
| CheckoutApiSupported | Bool | Specifies whether the shop supports checkouts via Checkout API. | |
| EnabledPresentmentCurrencies | String | The presentment currencies enabled for the shop. | |
| ShipsToCountries | String | The list of countries that the shop ships to. | |
| TimezoneOffsetMinutes | Int | The shop's time zone offset expressed as a number of minutes. | |
| TransactionalSmsDisabled | Bool | Whether transactional SMS sent by Shopify have been disabled for a shop. | |
| OrderNumberFormatPrefix | String | The prefix that appears before order numbers. | |
| OrderNumberFormatSuffix | String | The suffix that appears after order numbers. | |
| BillingAddressId | String | A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | Whether the address coordinates are valid. | |
| BillingAddressAddress1 | String | The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | The name of the city, district, village, or town. | |
| BillingAddressCompany | String | The name of the company or organization. | |
| BillingAddressCountry | String | The name of the country. | |
| BillingAddressLatitude | Double | The latitude coordinate of the address. | |
| BillingAddressLongitude | Double | The longitude coordinate of the address. | |
| BillingAddressPhone | String | A phone number associated with the address. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | The two-letter code for the country of the address. For example, US. | |
| CountriesInShippingZonesCountryCodes | String | The list of all the countries from all the combined shipping zones. | |
| CountriesInShippingZonesIncludeRestOfWorld | Bool | Whether 'Rest of World' has been defined in any of the shipping zones. | |
| CurrencyFormatsMoneyFormat | String | Money without currency in HTML. | |
| CurrencyFormatsMoneyInEmailsFormat | String | Money without currency in emails. | |
| CurrencyFormatsMoneyWithCurrencyFormat | String | Money with currency in HTML. | |
| CurrencyFormatsMoneyWithCurrencyInEmailsFormat | String | Money with currency in emails. | |
| FeaturesInternationalPriceOverrides | Bool | Whether a shop can enable international price overrides. | |
| FeaturesBranding | String | The branding of the shop, which influences its look and feel in the Shopify admin. | |
| FeaturesCaptcha | Bool | Whether a shop's online store can have CAPTCHA protection. | |
| FeaturesReports | Bool | Whether a shop has access to all reporting features. | |
| FeaturesStorefront | Bool | Whether a shop has an online store. | |
| FeaturesAvalaraAvatax | Bool | Whether a shop has access to Avalara AvaTax. | |
| FeaturesDynamicRemarketing | Bool | Whether a shop has access to the Google Analytics dynamic remarketing feature. | |
| FeaturesGiftCards | Bool | Whether a shop can create gift cards. | |
| FeaturesInternationalDomains | Bool | Whether a shop can enable international domains. | |
| FeaturesLiveView | Bool | Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial or don't have a storefront. | |
| FeaturesSellsSubscriptions | Bool | Whether a shop has ever had subscription products. | |
| FeaturesShowMetrics | Bool | Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. | |
| FeaturesCaptchaExternalDomains | Bool | Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. | |
| FeaturesEligibleForSubscriptions | Bool | Whether a shop is configured properly to sell subscriptions. | |
| FeaturesHarmonizedSystemCode | Bool | Whether a shop displays Harmonized System codes on products. This is used for customs when shipping internationally. | |
| FeaturesInternationalPriceRules | Bool | Whether a shop can enable international price rules. | |
| FeaturesEligibleForSubscriptionMigration | Bool | Whether a shop can be migrated to use Shopify subscriptions. | |
| FeaturesLegacySubscriptionGatewayEnabled | Bool | Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. | |
| FeaturesPaypalExpressSubscriptionGatewayStatus | String | Whether a shop is configured to sell subscriptions with PayPal Express. | |
| LimitedPendingOrderCountCount | Int | The number of pendings orders on the shop. Limited to a maximum of 10000. | |
| LimitedPendingOrderCountAtMax | Bool | This is set when the number of pending orders has reached the maximum. | |
| PaymentSettingsSupportedDigitalWallets | String | List of the digital wallets which the shop supports. | |
| PlanDisplayName | String | The name of the shop's billing plan. | |
| PlanPartnerDevelopment | Bool | Whether the shop is a partner development shop for testing purposes. | |
| PlanShopifyPlus | Bool | Whether the shop has a Shopify Plus subscription. | |
| PrimaryDomainId | String | A globally-unique ID. | |
| PrimaryDomainHost | String | The host name of the domain. For example, 'example. com'. | |
| PrimaryDomainUrl | String | The URL of the domain (for example, 'https: //example. com'). | |
| PrimaryDomainSslEnabled | Bool | Whether SSL is enabled. | |
| PrimaryDomainLocalizationCountry | String | The ISO code for the country assigned to the domain. For example, 'CA' or '*' for a domain set to 'Rest of world'. | |
| PrimaryDomainLocalizationAlternateLocales | String | The ISO codes for the domain's alternate locales. For example, '['en']'. | |
| PrimaryDomainLocalizationDefaultLocale | String | The ISO code for the domain's default locale. For example, 'en'. | |
| PrimaryDomainMarketWebPresenceId | String | A globally-unique ID. | |
| PrimaryDomainMarketWebPresenceAlternateLocales | String | The ISO codes for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and 'example. ca' is the market's domain, then 'example. ca/en' will load in English. | |
| PrimaryDomainMarketWebPresenceDefaultLocale | String | The ISO code for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and 'example. ca' is the market's domian, then 'example. ca' will load in French. | |
| PrimaryDomainMarketWebPresenceSubfolderSuffix | String | The market-specific suffix of the subfolders defined by the web presence. Example: in '/en-us' the subfolder suffix is 'us'. This field will be null if 'domain' isn't null. | |
| ResourceLimitsLocationLimit | Int | Maximum number of locations allowed. | |
| ResourceLimitsMaxProductOptions | Int | Maximum number of product options allowed. | |
| ResourceLimitsMaxProductVariants | Int | The maximum number of variants allowed per product. | |
| ResourceLimitsRedirectLimitReached | Bool | Whether the shop has reached the limit of the number of URL redirects it can make for resources. | |
| ResourceLimitsSkuResourceLimitsAvailable | Bool | Whether the resource is available. | |
| ResourceLimitsSkuResourceLimitsQuantityAvailable | Int | Quantity available. If null the quantity available is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityLimit | Int | Quantity limit of the resource. If null the quantity is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityUsed | Int | Quantity used of the resource. If null the quantity used cannot be retrieved. |
ShopifyPaymentsAccount
Returns Shopify Payments account information, including balances and payouts.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Activated | Bool | Whether the Shopify Payments setup is completed. | |
| Country | String | The Shopify Payments account country. | |
| Onboardable | Bool | Whether the Shopify Payments account can be onboarded. | |
| DefaultCurrency | String | The default payout currency for the Shopify Payments account. | |
| PayoutStatementDescriptor | String | The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout. | |
| FraudSettingsDeclineChargeOnAvsFailure | Bool | Decline a charge if there is an AVS failure. | |
| FraudSettingsDeclineChargeOnCvcFailure | Bool | Decline a charge if there is an CVC failure. | |
| NotificationSettingsPayouts | Bool | Receive email notifications when new payouts are sent or payouts fail. | |
| PayoutScheduleInterval | String | The interval at which payouts are sent to the connected bank account. | |
| PayoutScheduleMonthlyAnchor | Int | The day of the month funds will be paid out. The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. | |
| PayoutScheduleWeeklyAnchor | String | The day of the week funds will be paid out. The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used. |
ShopifyPaymentsAccountBalance
Returns current balances in all currencies for the account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Amount | Decimal | Decimal money amount. | |
| CurrencyCode [KEY] | String | Currency of the money. |
ShopifyPaymentsAccountBankAccounts
Lists all bank accounts configured for the Shopify Payments account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| BankName | String | The name of the bank. | |
| Country | String | The country of the bank. | |
| Currency | String | The currency of the bank account. | |
| Status | String | The status of the bank account. | |
| AccountNumber | String | The account number of the bank account. | |
| RoutingNumber | String | The routing number of the bank account. | |
| AccountNumberLastDigits | String | The last digits of the account number (the rest is redacted). | |
| CreatedAt | Datetime | The date that the bank account was created. |
ShopifyPaymentsAccountDisputes
Lists all disputes related to the Shopify Payments account.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- InitiatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Id='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Status='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE InitiatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| EvidenceDueBy | Date | The deadline for evidence submission. | |
| EvidenceSentOn | Date | The date when evidence was sent. Returns null if evidence has not yet been sent. | |
| Status | String | The current state of the dispute. | |
| Type | String | Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. | |
| FinalizedOn | Date | The date when this dispute was resolved. Returns null if the dispute is not yet resolved. | |
| InitiatedAt | Datetime | The date when this dispute was initiated. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| OrderId | String | A globally-unique ID. | |
| ReasonDetailsReason | String | The reason for the dispute provided by the cardholder's banks. | |
| ReasonDetailsNetworkReasonCode | String | The raw code provided by the payment network. |
ShopifyPaymentsAccountPayouts
Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionType column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ShopifyPaymentsAccountPayouts WHERE TransactionType='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The transfer status of the payout. | |
| IssuedAt | Datetime | The exact time when the payout was issued. The payout only contains balance transactions that were available at this time. | |
| TransactionType | String | The direction of the payout. | |
| BankAccountId | String | A globally-unique ID. | |
| NetAmount | Decimal | Decimal money amount. | |
| NetCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsFeeAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsFeeCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsGrossAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsGrossCurrencyCode | String | Currency of the money. | |
| SummaryChargesFeeAmount | Decimal | Decimal money amount. | |
| SummaryChargesFeeCurrencyCode | String | Currency of the money. | |
| SummaryChargesGrossAmount | Decimal | Decimal money amount. | |
| SummaryChargesGrossCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeGrossAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeGrossCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsGrossAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsGrossCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsGrossAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsGrossCurrencyCode | String | Currency of the money. |
ShopifyPaymentsAccountPermittedVerificationDocuments
Retrieves the permitted documents for identity verification.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Type [KEY] | String | The type of the document which can be used for verification. | |
| BackRequired | Bool | True if the back side of the document is required. | |
| FrontRequired | Bool | True if the front side of the document is required. |
ShopifyPaymentsAccountVerifications
Returns the verifications necessary for this account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The status of the verification. | |
| SubjectFamilyName | String | The family name of the individual to verify. | |
| SubjectGivenName | String | The given name of the individual to verify. |
StaffMembers
Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription)
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| Name | String | The staff member's full name. | |
| FirstName | String | The staff member's first name. | |
| LastName | String | The staff member's last name. | |
| Active | Bool | Whether the staff member is active. | |
| String | The staff member's email address. | ||
| Exists | Bool | Whether the staff member's account exists. | |
| Initials | String | The staff member's initials, if available. | |
| Locale | String | The staff member'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' | |
| Phone | String | The staff member's phone number. | |
| IsShopOwner | Bool | Whether the staff member is the shop owner. | |
| PrivateDataAccountSettingsUrl | String | The URL to the staff member's account settings page. | |
| PrivateDataCreatedAt | Datetime | The date and time when the staff member was created. |
TenderTransactions
Returns a list of TenderTransactions associated with the shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Test supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TenderTransactions WHERE Id='VALUE'
SELECT * FROM TenderTransactions WHERE Test='true'
SELECT * FROM TenderTransactions WHERE ProcessedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| PaymentMethod | String | Information about the payment method used for the transaction. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| RemoteReference | String | The remote gateway reference associated with the tender transaction. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| TenderTransactionCreditCardDetailsCreditCardCompany | String | The name of the company that issued the customer's credit card. Example: 'Visa'. | |
| TenderTransactionCreditCardDetailsCreditCardNumber | String | The customer's credit card number, with all digits except the last 4 redacted. Example: '???? ???? ???? 1234' | |
| UserId | String | A globally-unique ID.(This column is available only with a ShopifyPlus subscription) |
API Version 2023-10
The CData Sync App models entities in the Shopify API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files that are easy to customize.
Key Features
- Include Custom Fields connection property allows you to retrieve custom fields for Products and ProductVariants table. Set this property to True, to enable this feature.
- The Row Scan Depth connection property sets the number of rows that are filtered for custom fields. The default value for this property is 50. There is a trade-off: setting a low value may result in not getting all the custom fields, but setting a high value decreases the driver's performance. To use this feature set the Include Custom Fields connection property to True.
- The Flexible Schema retrieves custom fields for the Products and ProductVariants table. This feature is enabled when the Include Custom Fields connection property is set to True. Flexible schema searches at most 250 rows for custom fields. To retrieve more fields, set the Row Scan Depth to a higher value.
Using Rest API
See REST Data Model for the available entities in the REST API.
Using GraphQL API
See GRAPHQL Data Model for the available entities in the GraphQL API.
REST Data Model
The CData Sync App models the Shopify API as relational views, and stored procedures.
To use REST Data Model, simply set Schema to REST.
Tables
テーブル are tables that can be modified, such as Orders, Products.
Views
ビュー are tables that cannot be modified, such as Events, Patouts and Reports. Typically, read-only model data is shown as views.
Stored Procedures
ストアドプロシージャ are function-like interfaces to the data source. Use these interfaces to search, update, and modify information in the data source.
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| ApplicationCharges | Create or view Application Charges for Billing. |
| ApplicationCredit | Create or view Application Credit for Billing. |
| Articles | Create, read, update or delete articles |
| Assets | Create, read, update or delete assets. CUD support is no longer accessible for public apps. |
| Blogs | Create, read, update or delete blogs |
| CarrierServices | Returns a list of resource feedback objects.. |
| CollectionListings | Query and delete information regarding different collects. |
| Collects | Query, insert, or delete information regarding different collects. |
| Comments | Create, read, update and delete the comments. |
| Countries | Create, select, update, and delete information regarding countries. |
| CustomCollections | Query, insert, update, or delete information regarding different custom collections. |
| CustomerAddresses | Create, update, delete, and query customer addresses. |
| Customers | Create, update, delete, and query customers. |
| DiscountCodes | Create, select, update, and delete information regarding discount codes. |
| DraftOrders | Create, update, delete, and query draft orders. |
| FulfillmentEvents | Create, delete, and query information regarding fulfillment events. |
| Fulfillments | Create, update, and query fulfillments. |
| FulfillmentServices | Query, create, update, and delete information regarding different fulfillment services. |
| GiftCards | Create, update, delete, and query gift cards. |
| InventoryItems | Query and update information regarding different inventory items. |
| InventoryLevels | Query, create, and update information regarding different inventory levels. |
| MarketingEvents | Create, update, delete, and query marketing events. |
| Metafields | Retrieves a list of metafields that belong to a resource. |
| OrderRisks | Create, update, delete, and query order risks. |
| Orders | Create, update, delete, and query orders. |
| OrderTransactions | Create and query transactions. |
| Pages | Create, read, update or delete pages |
| PriceRules | Create, update, delete, and query price rules. |
| ProductImages | Query, Update and Delete Product Images |
| ProductListings | Query and delete product listings. |
| ProductOptions | Query product options. |
| ProductResourceFeedbacks | Returns a list of resource feedback objects.. |
| Products | List of products. |
| ProductVariants | List of the product variants. |
| Provinces | Query and update information regarding different provinces. |
| RecurringApplicationCharges | Create, update, delete, and query Recurring Application Charges. |
| Redirects | Create, read, update or delete redirects. |
| Refunds | Create and query refunds. |
| ResourceFeedbacks | Returns a list of resource feedback objects.. |
| ScriptTags | Create, read, update or delete script tags. |
| SmartCollections | Query, insert, update, or delete information regarding different smart collections. |
| Themes | Create, read, update or delete themes |
| UsageCharges | Create or view Usage Charges for Recurring Application Charges. |
ApplicationCharges
Create or view Application Charges for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCharges WHERE Id = '123'
Insert
INSERT INTO ApplicationCharges ( Test ) VALUES ( 'true' )
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The Unique Identifier of the Application Charge | |
| Name | String | False |
The Order Number | |
| ApiClientId | Long | True |
The API Client ID | |
| Price | Decimal | False |
The price of the application charge | |
| Status | String | True |
The status of the application charge. Valid Values are: pending, active, declined, expired | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting a charge. | |
| Test | String | False |
Whether the application charge is a test transaction. Valid values:true,null | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the application charge was last updated. | |
| ChargeType | String | True |
The type of the application charge | |
| DecoratedReturnUrl | String | True |
The decorated return url |
ApplicationCredit
Create or view Application Credit for Billing.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ApplicationCredit WHERE Id = '123'
Insert
INSERT INTO ApplicationCredit (Amount, Description, Test) VALUES ('100', 'success or failure', 'true')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the application credit. | |
| Amount | Decimal | False |
The amount refunded by the application credit. | |
| Description | String | False |
The description of the application credit. | |
| Test | String | False |
Whether the application credit is a test transaction. Valid values: true,null |
Articles
Create, read, update or delete articles
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '123'
Insert
You must specify the Title to create an Article.
INSERT INTO Articles (BlogId, Author, Title) VALUES ('599421749', 'Adam', 'New Article')
Update
You must specify the blog id and id to update an article. For example:
UPDATE Articles SET Author = 'Harry' WHERE BlogId = '599421749' AND Id = '5557081211'
Delete
You must specify the Id and the Blog Id of the article to delete it.
DELETE FROM Articles WHERE BlogId = '599421749' AND Id = '5556952105'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the article. | |
| BlogId [KEY] | Long | False |
Blogs.Id |
The ID of the blog containing the article. |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the author of the article. | |
| BodyHtml | String | False |
The text of the body of the article, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was created. | |
| Handle | String | False |
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. | |
| ImageAlt | String | False |
Alternative text that describes the image. | |
| ImageCreatedAt | Datetime | True |
The date and time when image is created. | |
| ImageHeight | Int | False |
Height of the image. | |
| ImageSrc | String | False |
A source URL that specifies the location of the image. | |
| ImageWidth | Int | False |
Width of the image. | |
| ImageAttachment | String | False |
An image attached to article returned as Base64-encoded binary data. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the article was published. | |
| SummaryHtml | String | False |
A summary of the article, complete with HTML markup. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the article. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the article was last updated. | |
| UserId | Long | True |
A unique numeric identifier for the author of the article. | |
| PublishedStatus | String | False |
Filter articles by their publish status. Valid values are: published, unpublished and any ; default: any. |
Assets
Create, read, update or delete assets. CUD support is no longer accessible for public apps.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Assets WHERE Key = 'assets/abc.gif'
Insert
You must specify the Theme Id and Key to insert an Asset. For example:
INSERT INTO Assets(Key, Value, ThemeId) VALUES('assets/abc.gif', '
Update
You must specify the Theme Id and Key to update an Asset. For example:
UPDATE Assets SET value = 'pqrs' WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Delete
You must specify the Id and the Theme Id of the Asset to delete it.
DELETE FROM Assets WHERE Key = 'assets/abc.gif' AND ThemeId = '282977'
Columns
| Name | Type | ReadOnly | References | Description |
| Key [KEY] | String | False |
The path to the asset within a theme. | |
| ThemeId [KEY] | Long | True |
Themes.Id |
The ID for the theme that an asset belongs to. |
| Attachment | String | False |
A base64-encoded image. | |
| Checksum | String | True |
The MD5 representation of the content, consisting of a string of 32 hexadecimal digits. May be null if an asset has not been updated recently. | |
| ContentType | String | True |
The MIME representation of the content, consisting of the type and subtype of the asset. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the asset was created. | |
| PublicUrl | String | True |
The public-facing URL of the asset. | |
| Size | Int | True |
The asset size in bytes. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when an asset was last updated. | |
| Value | String | False |
The text content of the asset, such as the HTML and Liquid markup of a template file. |
Blogs
Create, read, update or delete blogs
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Handle column and Id. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- Handle supports the '=,IN' comparison.
SELECT * FROM Blogs WHERE Id = '123'
SELECT * FROM Blogs WHERE Id IN ('123', '345')
SELECT * FROM Blogs WHERE Handle = 'new-blog-5927';
SELECT * FROM Blogs WHERE Handle IN ('new-blog-5927', 'new-blog-5926');
Insert
You must specify the Title to create a Blog.
INSERT INTO Blogs (title) VALUES ('new blog')
INSERT INTO Blogs (Title, Metafields) VALUES ('new blog','[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]')
Update
You must specify the id to update a Blog. For example:
UPDATE Blogs SET title = 'new blog' WHERE Id = '77171130'
UPDATE Blogs SET Metafields='[{"key":"sponsor","value":"shopify","type":"single_line_text_field","namespace":"global"}]' WHERE Id='77171130'
Delete
You must specify the Id of the Blog to delete it.
DELETE FROM Blogs WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the blog. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Commentable | String | False |
Indicates whether readers can post comments to the blog and if comments are moderated or not. | |
| CreatedAt | Datetime | True |
The date and time when the blog was created. | |
| Feedburner | String | False |
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. | |
| FeedburnerLocation | String | False |
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 | String | False |
A human-friendly unique string for a blog automatically generated from its title. | |
| Metafields | String | False |
Attaches additional metadata to a store's resources. | |
| Tags | String | False |
Tags are additional short descriptors formatted as a string of comma-separated values. | |
| TemplateSuffix | String | False |
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 | String | False |
The title of the blog. | |
| UpdatedAt | Datetime | True |
The date and time when changes were last made to the blog's properties. |
CarrierServices
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CarrierServices
SELECT * FROM CarrierServices WHERE Id = '123'
SELECT * FROM CarrierServices WHERE Id IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [CarrierServices] (Name, Type, CallbackUrl) VALUES ('ApiServiceType', 'api', 'https://test.com');
Update
You must specify the id to update a Redirect. For example:
UPDATE [CarrierServices] SET [Active] = 'false' WHERE [Id] = 59103608855;
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM [CarrierServices] WHERE [Id] = 59103608855;
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the carrier service. | |
| Active | Bool | False |
Whether this carrier service is active. If true, then the service will be available to serve rates in checkout. | |
| Name | String | False |
The name of the shipping service as seen by merchants and their customers. | |
| CallbackUrl | String | False |
The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL. | |
| Type | String | False |
Distinguishes between API or legacy carrier services. | |
| Format | String | False |
The format of the data returned by the URL endpoint. json is the only valid value. | |
| ServiceDiscovery | String | False |
Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. | |
| AdminGraphqlApiId | String | False |
The GraphQL GID for this carrier service. |
CollectionListings
Query and delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM CollectionListings WHERE Id = '123'
Delete
You must specify the Id of the collection listing to delete it.
DELETE FROM CollectionListings WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The Id of the collection this listing belongs to. | |
| Title | String | True |
The titke of the collection listing. | |
| BodyHtml | String | True |
The HTML body/description for this listing. | |
| DefaultProductImage | String | True |
The default product image in this listing. | |
| ImageCreatedAt | String | True |
The date and time the image for this listing was created at. | |
| ImageSource | String | True |
The source/link of the image for this listing. | |
| Handle | String | True |
The handle of this listing. | |
| UpdatedAt | Datetime | True |
The date and time when the collection listing was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the collection listing was created. |
Collects
Query, insert, or delete information regarding different collects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Collects WHERE Id = '123'
Insert
You must specify the ProductId and CollectionId to create a collect.
INSERT INTO Collects (ProductId, CollectionId) VALUES ('512433520663', '22892937239')
Delete
You must specify the Id of the collect to delete it.
DELETE FROM Collects WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the collect. | |
| CollectionId | Long | False |
The Id of the collection this collection is linked with. | |
| ProductId | Long | False |
Products.Id |
The Id of the product this collection is linked with. |
| Position | Int | True |
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. | |
| SortValue | String | True |
This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. | |
| CreatedAt | Datetime | True |
The date and time when the collect was created. | |
| UpdatedAt | Datetime | True |
The date and time when the collect was last modified. |
Comments
Create, read, update and delete the comments.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Comments WHERE Id = '123'
Insert
You must specify Article Id, Author, Body, Email to create a Comment.
INSERT INTO Comments (articleid, author, body, email) VALUES ('5557001', 'Harry', 'test', '[email protected]')
Update
You must specify the Id to update a Comment. For example:
UPDATE Comments SET Author = 'Adam' WHERE Id = '77171130'
Delete
You must specify the Id of the Comments to delete it.
DELETE FROM Comments WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the comment. | |
| BlogId | Long | False |
Blogs.Id |
A unique numeric identifier for the blog containing the article that the comment belongs to. |
| ArticleId | Long | False |
Articles.Id |
A unique numeric identifier for the article that the comment belongs to. |
| Author | String | False |
The name of the author of the comment. | |
| Body | String | False |
The basic Textile markup of a comment. | |
| BodyHtml | String | False |
The text of the comment, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was created. | |
| String | False |
The email address of the author of the comment. | ||
| Ip | String | False |
The IP address from which the comment was posted. | |
| PublishedAt | String | False |
The date and time (ISO 8601 format) when the comment was published. | |
| Status | String | True |
The status of the comment. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the comment was last modified. | |
| UserAgent | String | False |
The user agent string provided by the software used to create the comment. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
Countries
Create, select, update, and delete information regarding countries.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Countries
SELECT * FROM Countries WHERE Id = '123'
Insert
You must specify the Code to create a country.
INSERT INTO Countries (Code) VALUES ("FR")
Update
You must specify the country Id to update a country. For example:
UPDATE Countries SET Tax = 0.1 WHERE Id = '123'
Delete
You must specify the Id of the country to delete it.
DELETE FROM Countries WHERE id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the country. | |
| Name | String | True |
The name of the country. | |
| Code | String | False |
The code of the country. | |
| Tax | Decimal | False |
The amount of tax which should be applied for this country. | |
| Provinces | String | False |
The sub-regions of a country, such as its provinces or states. Each sub-region has the following properties: code: The two letter province or state code, country_id: The ID for the country to which this sub-region belongs, id: The ID for the particular sub-region, name: The name of the sub-region, tax: The tax value in decimal format, tax_name: The name of the tax as it is referred to in the applicable sub-region. For example, in Canada, the sales tax in the province Ontario is referred to as HST, tax_type: The tax type. Valid values: null, normal, or harmonized. If the value is harmonized, then the tax is compounded of the provincial and federal sales taxes, tax_percentage: The tax value in percent format |
CustomCollections
Query, insert, update, or delete information regarding different custom collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, and PublishedAt columns. The supported SQL operators are 'IN' for Id and Handle, '=' for the ProductId, Title and PublishedStatus columns, '>' and '<' for UpdatedAt and PublishedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM CustomCollections WHERE Id = '123'
SELECT * FROM CustomCollections WHERE Id IN ('123', '456')
SELECT * FROM CustomCollections WHERE ProductId = '123'
SELECT * FROM CustomCollections WHERE Title = 'Ducks'
SELECT * FROM CustomCollections WHERE Handle = 'frontpage'
SELECT * FROM CustomCollections WHERE Handle IN ('frontpage', 'lastpage')
SELECT * FROM CustomCollections WHERE PublishedStatus = 'published'
SELECT * FROM CustomCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM CustomCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title to create a custom collection.
INSERT INTO CustomCollections (Title) VALUES ('Macbooks')
INSERT INTO CustomCollections (Title, Published) VALUES ('Macbooks', false)
Update
You must specify the custom collection Id to update a custom collection. For example:
UPDATE CustomCollections SET Title = 'Updated title' WHERE Id = '123'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM CustomCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the custom collection. | |
| Title | String | False |
The title of the custom collection. | |
| BodyHtml | String | False |
The body/description of the custom collection. | |
| Image | String | False |
A JSON aggregate with information regarding the image of custom collection. | |
| Metafields | String | False |
Attaches additional metadata to a shop's resources: key: An identifier for the metafield. (maximum: 30 characters), namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters), value: Information to be stored as metadata, value_type: The information type being stored. Valid values: string or integer, description (optional): Additional information about the metafield . | |
| Handle | String | False |
A human-friendly unique string for the custom collection automatically generated from its title. | |
| SortOrder | String | False |
The order in which products in the custom collection appear. | |
| TemplateSuffix | String | False |
The suffix of the liquid template being used. | |
| PublishedScope | String | False |
The sales channels in which the custom collection is visible. | |
| UpdatedAt | Datetime | True |
The date and time when the custom collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the custom collection was published to the Online Store channel. | |
| ProductId | String | False |
Show custom collections that include a given product. | |
| PublishedStatus | String | False |
Show custom collection with a given published status: published: show only published custom collections, unpublished: show only unpublished custom collections, any: show custom collections of any published status. (default: any). |
CustomerAddresses
Create, update, delete, and query customer addresses.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- CustomerId supports the '=,IN' comparison.
- CustomerUpdatedAt supports the '<,>,<=,>=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM CustomerAddresses WHERE CustomerId = '123'
SELECT * FROM CustomerAddresses WHERE CustomerId IN ('123', '456')
SELECT * FROM CustomerAddresses WHERE CustomerUpdatedAt >= '2018-05-04'
Insert
You must specify the customer Id to create an address.
INSERT INTO CustomerAddresses (CustomerId, Address1, City, Company) VALUES ('123', '1 Rue des Carrieres', 'Suite 1234', 'Montreal')
Update
You must specify the customer Id and the Id of the customer address to update an address.
UPDATE CustomerAddresses SET Zip = '90210' WHERE CustomerId = '123' AND Id = '456'
Delete
You must specify the customer Id and the Id of the customer address to delete an address. You cannot delete a customer's default address.
DELETE FROM CustomerAddresses WHERE CustomerId = '183467180055' AND Id = '292265787415'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the address. | |
| CustomerId [KEY] | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerUpdatedAt | Datetime | True |
The date and time when the customer information was last updated. | |
| Name | String | False |
The customer's name. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| Company | String | False |
The customer's company. | |
| Address1 | String | False |
The customer's mailing address. | |
| Address2 | String | False |
An additional field for the customer's mailing address. | |
| City | String | False |
The customer's city. | |
| Province | String | False |
The customer's province or state name. | |
| Country | String | False |
The customer's country. | |
| Zip | String | False |
The customer's zip or postal code. | |
| Phone | String | False |
The customer's phone number for this mailing address. | |
| ProvinceCode | String | False |
The two-letter pcode for the customer's province or state. | |
| CountryCode | String | False |
The two-letter country code corresponding to the customer's country. | |
| CountryName | String | False |
The customer's normalized country name. | |
| Default | Bool | True |
Indicates whether this address is the default address for the customer. |
Customers
Create, update, delete, and query customers.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.- Id supports the '=,IN' comparison.
- FirstName supports the '=' comparison.
- LastName supports the '=' comparison.
- Email supports the '=' comparison.
- Phone supports the '=' comparison.
- TotalSpent supports the '=' comparison.
- OrdersCount supports the '=' comparison.
- AcceptsMarketing supports the '=' comparison.
- State supports the '=' comparison.
- VerifiedEmail supports the '=' comparison.
- CreatedAt supports the '>=,<=' comparison.
- UpdatedAt supports the '>=,<=,=' comparison.
SELECT * FROM Customers WHERE Id = '123'
SELECT * FROM Customers WHERE Id IN ('123', '456')
SELECT * FROM Customers WHERE CreatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE CreatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE FirstName = 'abc'
SELECT * FROM Customers WHERE LastName = 'xyz'
SELECT * FROM Customers WHERE Email = '[email protected]'
SELECT * FROM Customers WHERE OrdersCount = 5
SELECT * FROM Customers WHERE Phone = '999999999'
SELECT * FROM Customers WHERE VerifiedEmail = true
SELECT * FROM Customers WHERE UpdatedAt = '2017-10-25'
Insert
The Email field is required to insert.
INSERT INTO Customers (Email, Phone) VALUES ('[email protected]', '+15142546011')
INSERT INTO Customers (Email, Phone, SendEmailInvite) VALUES ('[email protected]', '+15142546011', true)
Update
You must specify the Id of the customer to update a customer.
UPDATE Customers SET Note = 'Customer is a great guy' WHERE Id = '123'
UPDATE Customers SET Tags = 'New Customer, Repeat Customer' WHERE Id = '123'
Delete
You must specify the Id of the customer to delete a customer.
DELETE FROM Customers WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the customer. | |
| LastOrderId | Long | True |
Orders.Id |
The id of the customer's last order. |
| LastOrderName | String | True |
The name of the customer's last order. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| String | False |
The unique email address of the customer. | ||
| Phone | String | False |
The unique phone number for this customer. | |
| TaxExempt | Bool | False |
Indicates whether the customer should be charged taxes when placing orders. | |
| TotalSpent | Decimal | True |
The total amount of money that the customer has spent at the shop. | |
| OrdersCount | Int | True |
The number of orders associated with this customer. | |
| MultipassIdentifier | String | True |
The customer's identifier used with Multipass login. | |
| Note | String | False |
A note about the customer. | |
| EmailMarketingState | String | False |
The current email marketing state for the customer. | |
| EmailMarketingLevel | String | False |
The marketing subscription opt-in level. | |
| EmailMarketingUpdatedAt | Datetime | False |
The date and time when the customer consented to receive marketing material by email. | |
| State | String | True |
The state of the customer's account in a shop. | |
| Tags | String | False |
The tags for this customer. Separate with comma for multiple tags. | |
| VerifiedEmail | Bool | True |
States whether or not the email address has been verified. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| UpdatedAt | Datetime | True |
The date and time when the customer information was updated. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Password | String |
Password of the customer. |
| PasswordConfirmation | String |
Password confirmation of the customer. |
| SendEmailWelcome | Bool |
Whether to send a welcome email to the customer or not. |
| SendEmailInvite | Bool |
Whether to send an invite email to the customer or not. |
DiscountCodes
Create, select, update, and delete information regarding discount codes.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the PriceRuleId and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123'
SELECT * FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Insert
You must specify the PriceRuleId and Code to create a discount code.
INSERT INTO DiscountCodes (PriceRuleId, Code) VALUES ('290807676951', 'SUMMERSALE100OFF')
Update
You must specify the PriceRuleId and Id to update a discount code. For example:
UPDATE DiscountCodes SET Code = 'WINTERSALE500OFF' WHERE PriceRuleId = '123' AND Id = '456'
Delete
You must specify the Id of the custom collection to delete it.
DELETE FROM DiscountCodes WHERE PriceRuleId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the discount code. | |
| PriceRuleId [KEY] | Long | False |
PriceRules.Id |
The Id for the price rule that this discount code belongs to. |
| Code | String | False |
The case-insensitive discount code that customers use at checkout. | |
| UsageCount | Int | True |
The number of times that the discount code has been redeemed. | |
| CreatedAt | Datetime | True |
The date and time when the discount code was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount code was last modified. |
DraftOrders
Create, update, delete, and query draft orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status, and UpdatedAt columns. The supported SQL operators are "=" and "IN" for Id, "=" for Status, and ">" and "<" for UpdatedAt. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DraftOrders WHERE Id = '123'
SELECT * FROM DraftOrders WHERE Id IN ('123', '456')
SELECT * FROM DraftOrders WHERE Status = 'completed'
SELECT * FROM DraftOrders WHERE UpdatedAt > '2018-02-05'
Insert
-
Create a simple draft order with only a product variant Id using aggregates.
INSERT INTO DraftOrders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple draft order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO DraftOrders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a custom draft order using aggregates.
INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('[{\"title\":\"Custom Tee\",\"price\":20.15,\"quantity\":5}]', '709015339031', true) -
Create a custom draft order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemQuantity) VALUES ('Custom Tee', 20.15, 5) INSERT INTO DraftOrders (LineAggregate, CustomerId, UseCustomerDefaultAddress) VALUES ('OrdersItems#TEMP', '709015339031', true)
Update
-
Add a Note to a draft order:
UPDATE DraftOrders SET Note = 'Customer contacted us about a custom engraving on this iPod' WHERE Id = '123'
-
Set a discount on a draft order:
UPDATE DraftOrders SET AppliedDiscountDescription = 'Custom discount', AppliedDiscountValueType = 'percentage', AppliedDiscountValue = 10.0, AppliedDiscountAmount = 19.90, AppliedDiscountTitle = 'Custom' WHERE Id = '123'
Delete
You must specify the Id of the draft order to delete it.
DELETE FROM DraftOrders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| Tags | String | False |
Additional short descriptors. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| Status | String | True |
The status of the order. Valid values are: open (all open orders), invoice_sent (only closed orders), and completed (cancelled orders). Defaults to 'open'. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the draft order. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| CompletedAt | Datetime | True |
The date and time when the order was completed at. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| UseCustomerDefaultAddress | Bool |
Optional boolean that you can send as part of a draft order object to load customer shipping information. Valid values: true or false. |
FulfillmentEvents
Create, delete, and query information regarding fulfillment events.
Table-Specific Information
Select
The OrderId and FulfillmentId are required to query this table. The Sync App uses the Shopify API to process search criteria that refer to the OrderId, FulfillmentId, and Id columns. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456'
SELECT * FROM FulfillmentEvents WHERE OrderId = '123' AND FulfillmentId = '456' AND Id = '789'
Insert
You must specify the OrderId, FulfillmentId, and Status to create a fulfillment event.
INSERT INTO FulfillmentEvents (Orderid, FulfillmentId, Status, Message, EstimatedDeliveryAt) VALUES ('202520330263', '206541914135', 'in_transit', 'test', '2018-08-02 10:15:25 PM')
Delete
You must specify the OrderId, FulfillmentId, and Id of the fulfillment event to delete it.
DELETE FROM FulfillmentEvents WHERE Orderid = '202520330263' AND FulfillmentId = '206541914135' AND Id = '2374424264727'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A numeric unique identifier for the fulfillment event. | |
| OrderId [KEY] | Long | False |
Orders.Id |
The id of the order the fulfillment event belongs to. |
| FulfillmentId [KEY] | Long | False |
Fulfillments.Id |
A numeric unique identifier for the fulfillment to which the fulfillment event belongs. |
| ShopId | Long | True |
Shop.Id |
A numeric unique identifier for the shop to which the fulfillment event belongs. |
| Status | String | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| EstimatedDeliveryAt | Datetime | False |
The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure. | |
| Message | String | False |
An arbitrary message describing the status. Can be provided by a shipping carrier. | |
| City | String | False |
The city in which the fulfillment event occurred. | |
| Province | String | False |
The province in which the fulfillment event occurred. | |
| Zip | String | False |
The zip code in the location in which the fulfillment event occurred. | |
| Country | String | False |
The country in which the fulfillment event occurred. | |
| Address1 | String | False |
The fulfillment event's street address. | |
| Latitude | Double | False |
Geographic coordinate specifying the north/south location of a fulfillment event. | |
| Longitude | Double | False |
Geographic coordinate specifying the east/west location of a fulfillment event. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment event was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment event was updated. | |
| HappenedAt | Datetime | True |
The date and time when the fulfillment event occurred. |
Fulfillments
Create, update, and query fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, OrderId, CreatedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
-
If you specify the unique identifier of the order, then this view will only list fulfillment information concerning that order. You can also retrieve a specific fulfillment by specifying OrderId and Id. To retrieve fulfillments associated with a fulfillment order you need to specify the FulfillmentOrderId.
SELECT * FROM Fulfillments WHERE OrderId = '123' SELECT * FROM Fulfillments WHERE OrderId = '123' AND Id = '567' SELECT * FROM Fulfillments WHERE FulfillmentOrderId = '123'
-
This view supports filtering by the CreatedAt and UpdatedAt columns on the server-side.
SELECT * FROM Fulfillments WHERE CreatedAt > '2017-10-25'
Insert
You must specify the FulfillmentOrderId column to insert a fulfillment.
-
Fulfill one line item using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"}]') -
Fulfill one line item using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
Insert INTO OrdersItems#TEMP (ItemId) VALUES ('123')Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LinesAggregate) VALUES ('123', 'OrdersItems#TEMP')In cases that two ore more shop locations are specified in your Shopify account the LocationId needs to be added. For instance:
Insert INTO Fulfillments (FulfillmentOrderId, LocationId, LinesAggregate) VALUES ('123', '456', 'OrdersItems#TEMP') -
Fulfill many line items using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\"},{\"id\":\"456\"},{\"id\":\"789\"}]') -
Fulfill many line items using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('123') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('456') INSERT INTO OrdersItems#TEMP (ItemId) VALUES ('789') INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', 'OrdersItems#TEMP') -
Fulfill all line items, notify the customer, and set a tracking number.
INSERT INTO Fulfillments (FulfillmentOrderId, TrackingNumbers, NotifyCustomer) VALUES ('123', 'FEDEX1', true) -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using aggregates.
INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":5}]') -
Partially fulfill a single line item by explicitly specifying the line item and quantity to be fulfilled using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 5) INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('456', 'OrdersItems#TEMP') -
Complete a fulfillment (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Complete') -
Transition a fulfillment from pending to open (you must specify the Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Open') -
Cancel a fulfillment (you must specify Id of the fulfillment as well).
INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('123', '456', 'Cancel')
Update
You must specify the OrderId and Id of the fulfillment to fulfill an order.
UPDATE Fulfillments SET TrackingNumbers = 'FedEx123,UPS123' WHERE OrderId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| LocationId [KEY] | Long | False |
A unique numeric identifier for the Location. | |
| NotifyCustomer | Bool | False |
A flag indicating whether the customer should be notified | |
| Status | String | False |
The status of the fulfillment. | |
| Receipt | String | True |
Provides information about the receipt of this fulfillment. | |
| TrackingCompany | String | False |
The name of the tracking company. | |
| TrackingNumbers | String | False |
A list of comma-separated tracking numbers, provided by the shipping company. | |
| TrackingUrls | String | False |
The sum of all the prices of all the items in the fulfillment. | |
| VariantInventoryManagement | String | True |
States the name of the inventory management service. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the fulfillment. | |
| OrderUpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| OrderCreatedAt | Datetime | True |
The date and time when the order was last created. | |
| FulfillmentOrderId | Long | False |
The ID of the fulfillment order that is associated with the fulfillments. |
FulfillmentServices
Query, create, update, and delete information regarding different fulfillment services.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM FulfillmentServices WHERE Id = '123'
Insert
You must specify the Name, CallbackUrl, and Format to create a fulfillment service.
INSERT INTO FulfillmentServices (Name, CallbackUrl, Format) VALUES ('testing fulfillment services', 'http://google.com', 'json')
Update
You must specify the Id to update a fulfillment service. For example:
UPDATE FulfillmentServices SET Name = 'test32', IncludePendingStock = true WHERE Id = '123'
Delete
You must specify the Id of the fulfillment service to delete it.
DELETE FROM FulfillmentServices WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment service. | |
| LocationId | Long | True |
Locations.Id |
The unique identifier of the location tied to the fulfillment service. |
| ProviderId | String | True |
A unique identifier for the fulfillment service provider. | |
| Name | String | False |
The name of the fulfillment service as seen by merchants and their customers. | |
| Handle | String | True |
A human-friendly unique string for the fulfillment service generated from its title. | |
| ServiceName | String | True |
The name of the fulfillment service. | |
| String | False |
The email of the fulfillment service. | ||
| IncludePendingStock | Bool | False |
States if the fulfillment service includes a pending stock. | |
| RequiresShippingMethod | Bool | False |
States if the fulfillment service requires products to be physically shipped. Valid values are 'true' and 'false'. | |
| TrackingSupport | Bool | False |
States if the fulfillment service provides tracking numbers for packages. Valid values are | |
| InventoryManagement | Bool | False |
States if the fulfillment service tracks product inventory and provides updates to Shopify. Valid values are | |
| FulfillmentOrdersOptIn | Bool | False |
States if the fulfillment orders is opt in. | |
| CallbackUrl | String | False |
States the URL endpoint that Shopify needs to retrieve inventory and tracking updates. This field is necessary if either inventory_management or tracking_support is set to | |
| Format | String | False |
Specifies the format of the API output. Valid values are json and xml. |
GiftCards
Create, update, delete, and query gift cards.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the gift card. | |
| APIClientId | Long | True |
The ID of the client that issued the gift card. | |
| Balance | Decimal | True |
The balance of the gift card. | |
| Code | String | False |
The gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters) | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was created. | |
| Currency | String | True |
The currency of the gift card. | |
| CustomerId | Long | True |
Customers.Id |
The ID of the customer associated with this gift card. |
| DisabledAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was disabled. | |
| ExpiresOn | Date | False |
The date (YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date. | |
| InitialValue | Decimal | False |
The initial value of the gift card when it was created. | |
| LastCharacters | String | True |
The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved. | |
| LineItemId | Long | True |
OrdersItems.ItemId |
The ID of the line item that initiated the creation of this gift card, if it was created by an order. |
| Note | String | False |
An optional note that a merchant can attach to the gift card that isn't visible to customers. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that initiated the creation of this gift card, if it was created by an order. |
| TemplateSuffix | String | False |
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. | |
| UserId | Long | True |
Users.Id |
The ID of the user that issued the gift card, if it was issued by a user. |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the gift card was last modified. |
InventoryItems
Query and update information regarding different inventory items.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM InventoryItems WHERE Id = '123'
SELECT * FROM InventoryItems WHERE Id IN ('123', '456')
Update
You must specify the Id to update an inventory item. For example:
UPDATE InventoryItems SET Sku = 'lamo', Tracked = false WHERE Id = '123'
UPDATE InventoryItemsSET Cost = 45.95, CountryCodeOfOrigin = 'AU', CountryHarmonizedSystemCodes ='[{"harmonized_system_code":"701912","country_code":"CA"},{"harmonized_system_code":"701912","country_code":"US"}]', HarmonizedSystemCode = '701912', ProvinceCodeOfOrigin = 'NC', SKU = 'Test1', Tracked = FALSE WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the fulfillment. | |
| Cost | Decimal | False |
The unit cost of the inventory item. | |
| CountryCodeOfOrigin | String | False |
The two-digit code for the country where the inventory item was made. | |
| CountryHarmonizedSystemCodes | String | False |
An array of country-specific Harmonized System (HS) codes for the item. | |
| HarmonizedSystemCode | String | False |
The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code is not available. | |
| ProvinceCodeOfOrigin | String | False |
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. | |
| SKU | String | False |
The unique SKU (stock keeping unit) of the inventory item. | |
| Tracked | Bool | False |
Whether the inventory item is tracked. If true, then inventory quantity changes are tracked by Shopify. | |
| RequiresShipping | Bool | True |
Whether a customer needs to provide a shipping address when placing an order containing the inventory item. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was last updated. |
InventoryLevels
Query, create, and update information regarding different inventory levels.
Table-Specific Information
Select
To query this table InventoryItemId, LocationId or both should be specified. The supported SQL operators are '=' and 'IN'. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123'
SELECT * FROM InventoryLevels WHERE InventoryItemId = '123' AND LocationId = '456'
SELECT * FROM InventoryLevels WHERE InventoryItemId IN ('123', '456') AND LocationId IN ('123', '456')
Insert
-
Adjust the available quantity of an inventory item at a single location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation) VALUES (534169354263, 1448280087, 5, 'Adjust')
-
Connects an inventory item to a location by creating an inventory level at that location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Operation) VALUES (534169354263, 4484497431, 'Connect')
-
Sets the inventory level for an inventory item at a location:
INSERT INTO InventoryLevels (InventoryItemId, LocationId, Available, Operation, DisconnectIfNecessary) VALUES (534169354263, 4484497431, 42, 'Set', true)
Delete
You must specify the InventoryItemId and LocationId to delete an inventory level of an inventory item at a location.
DELETE FROM InventoryLevels WHERE InventoryItemId = '153681943' AND LocationId = '45678'
Columns
| Name | Type | ReadOnly | References | Description |
| InventoryItemId [KEY] | Long | False |
The ID of the inventory item that the inventory level belongs to. | |
| LocationId [KEY] | Long | False |
Locations.Id |
The ID of the location that the inventory level belongs to. To find the ID of the location, use the Locations view. |
| Available | Int | False |
The quantity of inventory items available for sale. Returns null if the inventory item is not tracked. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the inventory level was last modified. | |
| Operation | String | False |
An operation to apply to the InventoryLevel. Valid values for order: adjust, connect, set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| RelocateIfNecessary | Bool |
Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. Used in insertions. |
| DisconnectIfNecessary | Bool |
Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. Used in insertions. |
MarketingEvents
Create, update, delete, and query marketing events.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM MarketingEvents
SELECT * FROM MarketingEvents WHERE Id = '123'
Insert
You must specify the MarketingChannel, EventType, Paid, ReferringDomain, and StartedAt columns to create a marketing event. For example:
INSERT INTO MarketingEvents (MarketingChannel, EventType, Paid, ReferringDomain, StartedAt) VALUES ('social', 'ad', true, 'facebook.com', '2018-12-15')
Update
You must specify the Id to update a marketing event. You can modify only timestamps, RemoteId, and budget/currency. For example:
UPDATE MarketingEvents SET RemoteId = '1000:2000', StartedAt = '2018-02-02T00:00 +00:00', EndedAt = '2018-02-03T00:00 +00:00', ScheduledToEndAt = '2018-02-04T00:00 +00:00', Budget = 11.1, BudgetType = 'daily', Currency = 'USD' WHERE Id = '123'
Delete
You must specify the Id of the marketing event to delete it.
DELETE FROM MarketingEvents WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the marketing event. | |
| RemoteId | String | False |
An optional remote identifier for a marketing event. | |
| BreadcrumbId | String | True |
An optional identifier for the breadcrumb of a marketing event. | |
| UTMCampaign | String | True |
A unique name for the UTM campaign. | |
| UTMSource | String | True |
The source of the UTM campaign. | |
| UTMMedium | String | True |
The medium of the UTM campaign. | |
| UTMContent | String | True |
The content of the UTM campaign. | |
| UTMTerm | String | True |
The term of the UTM campaign. | |
| EventTarget | String | True |
The target of the event. | |
| Description | String | True |
A description for the marketing event. | |
| MarketingChannel | String | False |
A broader marketing event type that is focused only on the channel. Must be one of the allowed values (`search`, `display`, `social`, `email`, `referral`). | |
| EventType | String | False |
The specific type of marketing event. Must be one of the allowed values (`ad`, `post`, `message`, `retargeting`, `transactional`, `affiliate`, `loyalty`, `newsletter`, `abandoned_cart`, `receipt`). | |
| Budget | Decimal | False |
The budget of the ad campaign. | |
| Paid | Bool | False |
A boolean field to specify whether this event is paid or organic. | |
| BudgetType | String | False |
The type of the budget; must be either `daily` or `lifetime`. | |
| Currency | String | False |
The currency for the budget. | |
| ManageUrl | String | True |
A link to manage the marketing event, generally in the Shopify app's interface. | |
| PreviewUrl | String | True |
A link to view the live version of the post/ad, or to view a rendered preview of the post/ad/email in the Shopify app. | |
| ReferringDomain | String | False |
The destination domain of the marketing event. Required unless MarketingChannel is one of email/referral/display. | |
| MarketedResources | String | True |
A list of the items that were marketed in the marketing event. It's a list of dictionaries with type keys and id keys. Valid values for type are: (`product`, `collection`, `price_rule`, `page`, `article`, `homepage`). All types, other than homepage, also require an id. | |
| StartedAt | Datetime | False |
The timestamp when the marketing action was started, or when the email was sent, or when the Facebook post was made live, etc. | |
| EndedAt | Datetime | False |
For events with a duration, when the event actually ended. This may differ from ScheduledToEndAt, if the ad was stopped early, etc. | |
| ScheduledToEndAt | Datetime | False |
For events with a duration, when the event was supposed to end. |
Metafields
Retrieves a list of metafields that belong to a resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria for all columns except Value and Description. The supported SQL operators are '=,IN' for the Id, OwnerResource and OwnerId columns, '=' for the Namespace, Key, Type columns and '=,<=,<,>,>=' for the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE Id = 721389482
SELECT * FROM Metafields WHERE ID IN (SELECT Id FROM Customers)
SELECT * FROM Metafields WHERE ID IN (19422939054103, 19422939185175, 19422939250711, 19431415152663, 19431415185431)
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource IN ('product', 'customer')
SELECT * FROM Metafields WHERE OwnerId IN (64146833430, 64146833431) AND OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'customer' AND OwnerId IN (SELECT Id FROM Customers);
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND UpdatedAt >= '2021-10-13T05:55:08-04:00';
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND OwnerId = '64146735127' AND Type = 'multi_line_text_field';
Insert
You must specify the NameSpace, Key, and Value to create Metafields.
INSERT INTO Metafields (NameSpace, Key, Value, Type, Description, OwnerResource) VALUES ('inventory', 'warehouse', 25, 'number_integer', 'This is description about data', 'factory')
Update
You must specify the Id to update Metafields. For example:
UPDATE Metafields SET Value = 26 WHERE Id = 19712314851607
Delete
You must specify the Id of the Metafields to delete it.
DELETE FROM Metafields WHERE Id = 19712314851607
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique ID of the metafield. | |
| Namespace | String | False |
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. | |
| Key | String | False |
The name of the metafield. | |
| Value | String | False |
The information to be stored as metadata. | |
| Type | String | False |
The metafield's information type. | |
| Description | String | False |
A description of the information that the metafield contains. | |
| OwnerId | Long | False |
The unique ID of the resource that the metafield is attached to. | |
| OwnerResource | String | False |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the metafield was last updated. | |
| AdminGraphqlApiId | String | True |
The admin graphql api id |
OrderRisks
Create, update, delete, and query order risks.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order risk. | |
| CauseCancel | Bool | False |
Whether this order risk is severe enough to force the cancellation of the order. | |
| CheckoutId | Long | True |
The ID of the checkout that the order risk belongs to. | |
| Display | Bool | False |
Whether the order risk is displayed on the order details page in the Shopify admin. | |
| Message | String | False |
The message that's displayed to the merchant to indicate the results of the fraud check. | |
| OrderId | Long | True |
Orders.Id |
The ID of the order that the order risk belongs to. |
| Recommendation | String | False |
The recommended action given to the merchant. | |
| Score | Decimal | False |
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 | String | False |
The source of the order risk. |
Orders
Create, update, delete, and query orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, FinancialStatus, FulfillmentStatus, CreatedAt, ProcessedAt and UpdatedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for FinancialStatus, and FulfillmentStatus, and '>' and '<' for the CreatedAt, ProcessedAt, and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = '123'
SELECT * FROM Orders WHERE FinancialStatus = 'pending'
SELECT * FROM Orders WHERE CreatedAt > '2017-10-25'
Insert
-
Create a simple order with only a product variant Id using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2}]') -
Create a simple order with only a product variant Id using temporary table. The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For instance:
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 2)Once your temporary table is populated, it is now time to insert to the actual table in Shopify. You can do this by performing an INSERT to the actual table and setting as a value for LinesAggregate the name of the temporary table. For instance:
INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using aggregates.
INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, '[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]') -
Create a simple order, sending the order receipt and fulfillment receipt to the customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO Orders (Email, FulfillmentStatus, SendReceipt, SendFulfillmentReceipt, LineAggregate) VALUES ('[email protected]', 'fulfilled', true, true, 'OrdersItems#TEMP') -
Create a simple order, with taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"}]') -
Create a simple order, with taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a simple order, with multiple taxes using aggregates.
INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('[{\"variant_id\":\"4236041945111\",\"quantity\":2},{\"variant_id\":\"4236069011479\",\"quantity\":3}]', '[{\"price\":10.2,\"rate\":0.06,\"title\":\"State Tax\"},{\"price\":4.25,\"rate\":0.025,\"title\":\"County Tax\"}]') -
Create a simple order, with multiple taxes using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236041945111', 2) INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('4236069011479', 3) INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (10.2, 0.06, 'State Tax') INSERT INTO TaxItems#TEMP (TaxItemPrice, TaxItemRate, TaxItemTitle) VALUES (4.25, 0.025, 'County Tax') INSERT INTO Orders (LineAggregate, TaxAggregate) VALUES ('OrdersItems#TEMP', 'TaxItems#TEMP') -
Create a more comprehensive order using aggregates.
INSERT INTO Orders (LineAggregate) VALUES ([{\"title\":\"Big Brown Bear Boots\",\"price\":74.99,\"grams\":1300,\"quantity\":3}]) -
Create a more comprehensive order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemTitle, ItemPrice, ItemGrams, ItemQuantity) VALUES ('Big Brown Bear Boots', 74.99, 1300, 3) INSERT INTO Orders (LineAggregate) VALUES ('OrdersItems#TEMP') -
Create a pending order with an existing customer using aggregates.
INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', '456', 'pending') -
Create a pending order with an existing customer using temporary table.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerId, FinancialStatus) VALUES ('OrdersItems#TEMP', '456', 'pending') -
Create a partially paid order with a new customer and addresses using aggregates.
INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('[{\"variant_id\":\"123\",\"quantity\":3}]', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Create a partially paid order with a new customer and addresses using temporary.
INSERT INTO OrdersItems#TEMP (ItemVariantId, ItemQuantity) VALUES ('123', 3) INSERT INTO Orders (LineAggregate, CustomerFirstName, CustomerLastName, CustomerEmail, FinancialStatus) VALUES ('OrdersItems#TEMP', 'Paul', 'Norman', '[email protected]', 'partially_paid') -
Close an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Close') -
Reopen an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Open') -
Cancel an order (you must specify the Id of the order).
INSERT INTO Orders (Id, Operation) VALUES ('123', 'Cancel')
Update
Only columns BuyerAcceptsMarketing, Email, Phone, Note, Tags, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressPhone, ShippingAddressCity, ShippingAddressCompany, ShippingAddressZip, ShippingAddressProvince, ShippingAddressCountry, ShippingAddressLatitude, ShippingAddressLongitude, ShippingAddressName, ShippingAddressCountryCode, ShippingAddressProvinceCode and ShippingAddressDefault can be updated.
-
Update the shipping address of an existing order.
UPDATE Orders SET ShippingAddressAddress1 = '123 Ship Street', ShippingAddressCity = 'Shipsville' WHERE Id = '123'
-
Update an order's tags.
UPDATE Orders SET Tags = 'External, Inbound, Outbound' WHERE Id = '123'
Delete
You must specify the Id of the order when deleting an item from this table.
DELETE FROM Orders WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the order. | |
| Number | Long | True |
A unique identifier for the order, used by the shop owner and customer. | |
| CustomerId | Long | False |
Customers.Id |
A unique numeric identifier for the customer. |
| CustomerFirstName | String | False |
The first name of the customer. | |
| CustomerLastName | String | False |
The last name of the customer. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| String | False |
The customer's email address. | ||
| Name | String | True |
The customer's order name as represented by a number. | |
| TotalDiscounts | Decimal | True |
The total amount of the discounts to be applied to the price of the order. | |
| TotalOrderItemsPrice | Decimal | True |
The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | True |
The sum of all the prices of all the items in the order, taxes and discounts included. | |
| SubtotalPrice | Decimal | True |
Price of the order before shipping and taxes. | |
| TotalTax | Decimal | False |
The sum of all the taxes applied to the order. | |
| TotalWeight | Int | True |
The sum of all the weights of the line items in the order, in grams. | |
| BrowserIp | String | True |
The IP address of the browser used by the customer when placing the order. | |
| BuyerAcceptsMarketing | Bool | False |
Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | True |
The reason why the order was canceled. | |
| CartToken | String | True |
Unique identifier for a particular cart that is attached to a particular order. | |
| OrderStatusUrl | String | True |
The URL pointing to the order status web page. | |
| Token | String | True |
Unique identifier for a particular order. | |
| TaxesIncluded | Bool | False |
States whether or not taxes are included in the order subtotal. | |
| SourceName | String | True |
Where the order originated. | |
| ReferringSite | String | True |
The website that the customer clicked on to come to the shop. | |
| Phone | String | False |
The customer's phone number. | |
| Note | String | False |
The text of an optional note that a shop owner can attach to the order. | |
| LocationId | Long | True |
The unique numeric identifier for the physical location at which the order was processed. | |
| LandingSite | String | True |
The URL for the page where the buyer landed when entering the shop. | |
| Tags | String | False |
Additional short descriptors. | |
| FulfillmentStatus | String | False |
The fulfillment status of the order. Valid values during SELECT: shipped, partial, unshipped, any, unfulfilled. Valid values during INSERT: fulfilled, null, partial, restocked. | |
| FinancialStatus | String | False |
The financial status of the order. Valid values during SELECT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid. Valid values during INSERT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded. | |
| CustomerLocale | String | True |
The customer locale of the order. | |
| InvoiceSentAt | Datetime | True |
This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. | |
| InvoiceUrl | String | True |
The URL for the invoice. Only available for draft orders. | |
| TaxExempt | Bool | True |
States whether or not taxes are exempt for this order. Only available for draft orders. | |
| DiscountCodes | String | True |
Applicable discount codes that can be applied to the order. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the order. | |
| TaxAggregate | String | False |
A JSON aggregate of tax line items associated with the order. Note, these taxes are applied on the order, not on individual items. If you want them to be applied on individual items, use them in LineAggregate. Tax lines must be associated with either order or line item but not both. | |
| ShippingAggregate | String | False |
A JSON aggregate of shipping line items associated with the order. | |
| NoteAttributesAggregate | String | False |
A JSON aggregate of note attributes associated with the order. | |
| DiscountApplicationsAggregate | String | True |
An ordered list of stacked discount applications. | |
| BillingAddressFirstName | String | False |
The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | False |
The last name of the person associated with the payment method. | |
| BillingAddressAddress1 | String | False |
The street address of the billing address. | |
| BillingAddressAddress2 | String | False |
An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | False |
The phone number at the billing address. | |
| BillingAddressCity | String | False |
The city of the billing address. | |
| BillingAddressCompany | String | False |
The company of the person associated with the billing address. | |
| BillingAddressZip | String | False |
The zip or postal code of the billing address. | |
| BillingAddressProvince | String | False |
The name of the state or province of the billing address. | |
| BillingAddressCountry | String | False |
The name of the country of the billing address. | |
| BillingAddressLatitude | Double | False |
The latitude of the billing address. | |
| BillingAddressLongitude | Double | False |
The longitude of the billing address. | |
| BillingAddressName | String | False |
The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | False |
The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | False |
The first name of the person associated with the shipping method. | |
| ShippingAddressLastName | String | False |
The last name of the person associated with the shipping method. | |
| ShippingAddressAddress1 | String | False |
The street address of the shipping address. | |
| ShippingAddressAddress2 | String | False |
An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | False |
The phone number at the shipping address. | |
| ShippingAddressCity | String | False |
The city of the shipping address. | |
| ShippingAddressCompany | String | False |
The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | False |
The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | False |
The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | False |
The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | False |
The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | False |
The longitude of the shipping address. | |
| ShippingAddressName | String | False |
The full name of the person associated with the shipping method. | |
| ShippingAddressCountryCode | String | False |
The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | False |
The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | False |
Whether this address is the default one or not. | |
| AppliedDiscountTitle | String | False |
The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | False |
The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | False |
The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | False |
The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | False |
The amount of the applied discount for this order. Only available for draft orders. | |
| PaymentTermsAmount | Long | True |
The amount that is owed according to the payment terms. | |
| PaymentTermsCurrency | String | True |
The presentment currency for the payment. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the selected payment terms template for the order. | |
| PaymentTermsPaymentTermsType | String | True |
The type of selected payment terms template for the order. | |
| PaymentTermsDueInDays | Int | True |
The number of days between the invoice date and due date that is defined in the selected payment terms template. | |
| PaymentTermsPaymentSchedules | String | True |
An array of schedules associated to the payment terms. | |
| ProcessedAt | Datetime | True |
The date and time when the order was imported, in ISO 8601 format. | |
| CreatedAt | Datetime | True |
The date and time when the order was created. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. | |
| UpdatedAt | Datetime | True |
The date and time when the order was last modified. | |
| SendReceipt | Bool | False |
Determines whether an order confirmation will be sent to the customer. | |
| SendFulfillmentReceipt | Bool | False |
Determines whether a fulfillment confirmation will be sent to the customer. | |
| InventoryBehaviour | String | False |
Determines which inventory updating behavior is used. The following values are available: default, decrement_ignoring_policy, decrementobeying_policy | |
| Operation | String | False |
An operation to apply to the Order. Valid values for order: Close, Open, or Cancel. | |
| TotalShippingPriceSetShopMoneyAmount | Double | True |
The amount of the shop money in the total shipping price set. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
The currency code of the shop money in the total shipping price set. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total shipping price set. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total price set. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total price set. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total tax set. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total tax set. | |
| CheckoutId | Long | True |
The checkout id. | |
| CheckoutToken | String | True |
A unique value when referencing the checkout that's associated with the order. | |
| EstimatedTaxes | Bool | True |
Estimated taxes of the order. | |
| Test | Bool | True |
Test boolean for the order. | |
| TotalOutstanding | Decimal | True |
The outstanding sum of all the items in the order. | |
| TotalTipReceived | Decimal | True |
The total tip for the order. | |
| PresentmentCurrency | String | True |
The currency code of the presentment money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total line items price set. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total line items price set. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the discounts set. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the discounts set. | |
| TotalSubtotalSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the subtotal. | |
| TotalSubtotalSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the subtotal. | |
| OrigTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total additional fees set. | |
| OrigTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total additional fees set. | |
| CurTotalDiscountsSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total discounts set. | |
| CurTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total discounts set. | |
| CurSubtotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current subtotal price set. | |
| CurSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current subtotal price set. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total tax set. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total tax set. | |
| CurTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total additional fees set. | |
| CurTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total additional fees set. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total price set. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total price set. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the original total duties set. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the original total duties set. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the current total duties set. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the current total duties set. | |
| PaymentGatewayNames | String | True |
The list of payment gateway names | |
| FulfillmentAggregate | String | True |
A JSON aggregate of fulfillments associated with the order. Note, these fulfillments are applied on the order, not on individual items. | |
| RefundAggregate | String | True |
A JSON aggregate of refunds associated with the order. Note, these refunds are applied on the order, not on individual items. | |
| ConfirmationNumber | String | True |
A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. This value isn't guaranteed to be unique. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Status | String |
Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
OrderTransactions
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM OrderTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of transactions and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving transactions. Therefore to retrieve all the transactions, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the transactions for each OrderId to build the result set.
SELECT * FROM OrderTransactions WHERE Kind = 'Capture'
Insert
You must specify the OrderId and Kind when inserting a transaction.
-
Capture a specified amount on a previously authorized order.
INSERT INTO OrderTransactions (OrderId, Amount, Kind) VALUES ('123', 10.25, 'Capture') -
Capture a previously authorized order for the full amount.
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'Capture') - Create an Authorization transaction :
INSERT INTO OrderTransactions (OrderId, Kind, Authorization) VALUES ('123', 'authorization', '7') - Create a Capture transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'capture') - Create a Sale transaction :
INSERT INTO OrderTransactions (OrderId, Kind) VALUES ('123', 'sale') - Create a Void transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Currency, Amount) VALUES ('123', 'void', '456', 'USD', '0.1') - Create a Refund transaction:
INSERT INTO OrderTransactions (OrderId, Kind, TransactionItemParentId, Amount) VALUES ('123', 'refund', '456', '1440.00')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the transaction. | |
| OrderId | Long | False |
Orders.Id |
A unique numeric identifier for the order. |
| UserId | Long | True |
The unique identifier for the user. | |
| LocationId | Long | True |
The ID of the physical location where the transaction was processed. | |
| Amount | Decimal | False |
The amount of money that the transaction was for. | |
| Authorization | String | False |
The authorization code associated with the transaction. | |
| Currency | String | False |
The three letter code (ISO 4217) for the currency used for the payment. | |
| DeviceId | String | True |
The unique identifier for the device. | |
| Gateway | String | False |
The name of the gateway the transaction was issued through. | |
| SourceName | String | True |
The origin of the transaction. | |
| Kind | String | False |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. | |
| Message | String | True |
The message associated with this transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| Status | String | False |
The status of the transaction. | |
| Test | Bool | True |
The option to use the transaction for testing purposes. | |
| AVSResultCode | String | True |
The Response code from the address verification system. | |
| CreditCardBin | String | True |
The issuer identification number (IIN). | |
| CVVResultCode | String | True |
The Response code from the credit card company. | |
| CreditCardNumber | String | True |
The customer's credit card number, with most of the leading digits redacted with Xs. | |
| CreditCardCompany | String | True |
The name of the company who issued the customer's credit card. | |
| CreatedAt | Datetime | True |
The date and time when the customer was created. | |
| PaymentsRefundsAttributesStatus | String | True |
The current status of the refund | |
| PaymentsRefundsAttributesAcquirerReferenceNumber | String | True |
A unique number associated with the transaction that can be used to track the refund. | |
| PaymentId | String | True |
The unique identifier for the payment. | |
| ProcessedAt | Datetime | True |
The date and time when the transaction was processed. | |
| CreditCardName | String | True |
The name on the customer's credit card. | |
| CreditCardWallet | String | True |
The wallet of the customer's credit card. | |
| CreditCardExpMonth | Long | True |
The expiration month of the customer's credit card. | |
| CreditCardExpYear | Long | True |
The expiration year of the customer's credit card. | |
| Receipt | String | True |
A JSON aggregate of the order receipt. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
The amount of the shop money in the total unsettled set. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
The amount of the presentment money in the total unsettled set. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| TransactionItemAmount | Decimal |
The amount of money that the transaction was for. Use this when inserting transactions into an order or refund. |
| TransactionItemGateway | String |
The name of the gateway the transaction was issued through. Use this when inserting transactions into an order or refund. |
| TransActionItemKind | String |
The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. Use this when inserting transactions into an order or refund. |
| TransactionItemStatus | String |
The status of the transaction. Use this when inserting transactions into an order or refund. |
| TransactionItemParentId | String |
The parent id of the transaction. Use this when inserting transactions into a refund. |
| TransactionItemSource | String |
The status of the transaction. |
| UpdatedAt | Datetime |
The last time the order is updated. |
Pages
Create, read, update or delete pages
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, CreatedAt, Handle, PublishedAt, Title, UpdatedAt, PublishedStatus columns. The following queries are the only ones processed server-side:SELECT * FROM Pages
SELECT * FROM Pages WHERE Id = '123'
SELECT * FROM Pages WHERE CreatedAt > '2018-05-02'
SELECT * FROM Pages WHERE Handle = 'test'
SELECT * FROM Pages WHERE PublishedAt <= '2018-05-02'
SELECT * FROM Pages WHERE Title = 'new title'
SELECT * FROM Pages WHERE UpdatedAt >= '2018-05-02'
SELECT * FROM Pages WHERE PublishedStatus >= 'published'
Insert
You must specify the Title to create a Page.
INSERT INTO Pages (title) VALUES ('new Page')
Update
You must specify the id to update a Page. For example:
UPDATE Pages SET author = 'Harry' WHERE Id = '77171130'
Delete
You must specify the Id of the Page to delete it.
DELETE FROM Pages WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique numeric identifier for the page. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| Author | String | False |
The name of the person who created the page. | |
| BodyHtml | String | False |
The text content of the page, complete with HTML markup. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was created. | |
| Handle | String | False |
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. | |
| Metafields | String | False |
Additional information attached to the Page object. | |
| PublishedAt | Datetime | False |
The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden. | |
| ShopId | Long | True |
The ID of the shop to which the page belongs. | |
| TemplateSuffix | String | False |
The suffix of the Liquid template being used. | |
| Title | String | False |
The page's title. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601 format) when the page was last updated. | |
| PublishedStatus | String | False |
Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any. |
PriceRules
Create, update, delete, and query price rules.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM PriceRules WHERE Id = '123'
Insert
You must specify the Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, and AllocationMethod columns to create a price rule. For example:
INSERT INTO PriceRules (Title, TargetType, TargetSelection, ValueType, Value, CustomerSelection, StartsAt, AllocationMethod) VALUES ('SUMMERSALE10OFF', 'line_item', 'all', 'fixed_amount', '-10.0', 'all', '2017-01-19T17:59:10Z', 'across')
Update
You must specify the Id to update a price rule. For example:
UPDATE PriceRules SET Title = 'SUMMERSALE10OFF' WHERE Id = '123'
Delete
You must specify the Id of the price rule to delete it.
DELETE FROM PriceRules WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the price rule. | |
| AllocationMethod | String | False |
The allocation method of the price rule. Valid values: each: The discount is applied to each of the entitled items. across: The calculated discount amount will be applied across the entitled items. | |
| CustomerSelection | String | False |
The customer selection for the price rule. Valid values: all: The price rule is valid for all customers. prerequisite: The customer must either belong to one of the customer saved searches specified by PrerequisiteSavedSearchIds. | |
| EntitledCollectionIds | String | False |
A list of Ids of collections whose products will be eligible to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. It can't be used in combination with EntitledProductIds or EntitledVariantIds. | |
| EntitledCountryIds | String | False |
A list of Ids of shipping countries that will be entitled to the discount. It can be used only with TargetType set to shipping_line and TargetSelection set to entitled. | |
| EntitledProductIds | String | False |
A list of Ids of products that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| EntitledVariantIds | String | False |
A list of Ids of product variants that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. | |
| OncePerCustomer | Bool | False |
Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer Id. | |
| PrerequisiteCustomerIds | String | False |
A list of customer Ids which for the price rule to be applicable, the customer must match one of the specified customers. If PrerequisiteCustomerIds is populated, then PrerequisiteSavedSearchIds must be empty. | |
| PrerequisiteQuantityRange | String | False |
The minimum number of items for the price rule to be applicable. It has the following property: greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value. | |
| PrerequisiteSavedSearchIds | String | False |
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 PrerequisiteSavedSearchIds is populated, then PrerequisiteCustomerIds must be empty. | |
| PrerequisiteShippingPriceRange | String | False |
The maximum shipping price for the price rule to be applicable. It has the following property: less_than_or_equal_to: The shipping price must be less than or equal to this value. | |
| PrerequisiteSubtotalRange | String | False |
The minimum subtotal for the price rule to be applicable. It has the following property: 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. | |
| TargetSelection | String | False |
The target selection method of the price rule. Valid values: all: The price rule applies the discount to all line items in the checkout, entitled: The price rule applies the discount to selected entitlements only. | |
| TargetType | String | False |
The target type that the price rule applies to. Valid values: line_item: The price rule applies to the cart's line items, shipping_line: The price rule applies to the cart's shipping lines. | |
| UsageLimit | Int | False |
The maximum number of times the price rule can be used, per discount code. | |
| PrerequisiteProductIds | String | False |
List of product ids that will be a prerequisites for a Buy X Get Y type discount. The PrerequisiteProductIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product variant is included in PrerequisiteVariantIds, then PrerequisiteProductIds can't include the ID of the product associated with that variant. | |
| PrerequisiteVariantIds | String | False |
List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The EntitledVariantIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product is included in PrerequisiteProductIds, then PrerequisiteVariantIds can't include the ID of any variants associated with that product. | |
| PrerequisiteCollectionIds | String | False |
List of collection ids that will be a prerequisites for a Buy X Get Y discount. The EntitledCollectionIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Cannot be used in combination with PrerequisiteProductIds or PrerequisiteVariantIds. | |
| Value | Decimal | False |
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. | |
| ValueType | String | False |
The value type of the price rule. Valid values: fixed_amount: Applies a discount of value as a unit of the store's currency. For example, if value is -30 and the store's currency is USD, then $30 USD is deducted when the discount is applied, percentage: Applies a percentage discount of value. For example, if value is -30, then 30% will be deducted when the discount is applied. If TargetType is shipping_line, then only percentage is accepted. | |
| PrerequisiteToEntitlementQuantityRatio | String | False |
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 PrerequisiteToEntitlementQuantityRatio can be used only with: ValueType set to percentage, TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each, PrerequisiteProductIds or PrerequisiteVariantIds or PrerequisiteCollectionIds defined and EntitledProductIds or EntitledVariantIds or EntitledCollectionIds defined. | |
| Images | String | False |
A list of image objects. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| StartsAt | Datetime | False |
The date and time when the price rule starts. | |
| EndsAt | Datetime | False |
The date and time when the price rule ends. Must be after StartsAt. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the price rule was created. | |
| UpdatedAt | Datetime | True |
The date and time when the price rule was last modified. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductImages
Query, Update and Delete Product Images
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ImageId. The supported SQL operators are '=' for ProductId and '=' for ImageId. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM ProductImages WHERE ProductId = '123'
SELECT * FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Insert
To create a new product image with image data as attachment
INSERT INTO ProductImages (productid, filename, attachment) VALUES ('64146735127', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
To create a new product image using a source URL that will be downloaded by Shopify
INSERT INTO ProductImages (productid, filepath) VALUES ('64146735127', 'http://example.com/rails_logo.gif')")
To create a new product image and make it the main image
INSERT INTO ProductImages (productid, position, filename, filepath) VALUES ('64146735127', 1, 'test.png', 'http://example.com/rails_logo.gif')")
To create a new product image and attach it to product variants
INSERT INTO ProductImages (productid, variantids, filename, attachment) VALUES ('64146735127', '[808950810,457924702]', 'test.png', 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==')")
Update
To update a product image you must specify its ProductId and ImageId.
To change the position and alt tag content for an image
UPDATE ProductImages SET Position = 1, Alt = 'This is the main image' WHERE ProductId = '123' AND ImageId = '2342'
To add it to product variants for an image
UPDATE ProductImages SET VariantIds = '[808950810,457924702]' WHERE ProductId = '123' AND ImageId = '2342'
Delete
To delete a product image you must specify its Id.
DELETE FROM ProductImages WHERE ProductId = '123' AND ImageId = '2342'
Columns
| Name | Type | ReadOnly | References | Description |
| ImageId [KEY] | Long | True |
A unique numeric identifier for the product image. | |
| ProductId | Long | True |
Products.Id |
The id of the product associated with the image. |
| VariantIds | String | False |
The array of variant ids associated with the image. | |
| Position | Int | False |
The order of the product image in the list. | |
| FilePath | String | False |
Full path to the image. Can be locally or online. Example: http://example.com/rails_logo.gif. Either this or Base64Content are required. | |
| Width | Int | True |
The width of the image. | |
| Height | Int | True |
The height of the image. | |
| CreatedAt | Datetime | True |
The datetime when the image was created. | |
| UpdatedAt | Datetime | True |
The datetime when the image was updated. | |
| Alt | String | False |
The Alt content of the image. | |
| Src | String | False |
Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FileName | String |
The name that the image will be displayed in the application. |
| Attachment | String |
Base64 encoded bytes of the image. Either this or FilePath are required. |
ProductListings
Query and delete product listings.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and Handle columns. The supported SQL operators are '=' and 'IN' for ProductId and '=' and 'IN' for Handle column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM ProductListings WHERE ProductId = '123'
SELECT * FROM ProductListings WHERE ProductId IN ('123', '456')
SELECT * FROM ProductListings WHERE Handle = 'ipod-nano'
SELECT * FROM ProductListings WHERE Handle IN ('ipod-nano', 'ipod-nano2')
Delete
Delete a product listing to unpublish a product from your app (ProductId is required):
DELETE FROM ProductListings WHERE Productid = 512433520663
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
The unique identifer of the product this listing is for. The primary key for this resource. | |
| Title | String | False |
The name of the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Variants | String | True |
A list of variant objects, each one representing a slightly different version of the product. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | True |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Tags | String | False |
A categorization that a product can be tagged with, commonly used for filtering. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
ProductOptions
Query product options.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the ProductId and ProductUpdatedAt columns. The supported SQL operators are '=' for ProductId and '>' and '<' for ProductUpdatedAt.
Select
SELECT * FROM ProductOptions WHERE ProductId = '123'
SELECT * FROM ProductOptions WHERE ProductUpdatedAt > '2018-05-10'
Update
To update a product option, you must include the ProductId. For example:
UPDATE ProductOptions SET Name='test' where ProductId='123'"
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The id of the product option. | |
| ProductId | Long | True |
Products.Id |
The id of the product. |
| ProductUpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| Name | String | False |
The name of the product option. | |
| Position | Int | True |
The position of the product option. | |
| Values | String | True |
The values of the product option. |
ProductResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ProductResourceFeedbacks
SELECT * FROM ProductResourceFeedbacks WHERE ProductId = '123'
SELECT * FROM ProductResourceFeedbacks WHERE ProductId IN ('123', '235');
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ProductResourceFeedbacks] ([ProductId], [State], [Messages], [ResourceUpdatedAt], [FeedbackGeneratedAt]) VALUES (6578879004695, 'requires_action', 'My message.', '2023-05-05 09:00:00', '2023-05-05 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| ProductId | Long | False |
Products.Id |
Unique id of the resource. |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
Products
List of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the following columns: Id, Title, Vendor, Handle, ProductType, PublishedStatus, CreatedAt, PublishedAt, and UpdatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Products WHERE Id = '123'
SELECT * FROM Products WHERE Id IN ('123', '456')
SELECT * FROM Products WHERE CreatedAt > '2017-10-25'
SELECT * FROM Products WHERE Title = 'just a title'
SELECT * FROM Products WHERE Vendor = 'just a vendor'
Insert
-
Create a new product with the default product variant.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air') -
Create a new unpublished product.
INSERT INTO Products (Title, BodyHtml, Vendor, ProductType, Tags, Published) VALUES ('Burton Custom Freestyle 151', 'Good snowboard!', 'Burton', 'Snowboard', 'Barnes & Noble, Johns Fav, Big Air', false)
Update
To update a product you must specify its Id.
UPDATE Products SET Published = true WHERE Id = '123'
UPDATE Products SET MetafieldsGlobalTitleTag = 'Brand new title', MetafieldsGlobalDescriptionTag = 'Brand new description' WHERE Id = '123'
Delete
To delete a product you must specify its Id.
DELETE FROM Products WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product. | |
| BodyHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Handle | String | True |
A human-friendly unique string for the Product automatically generated from its title. | |
| Images | String | False |
A list of image objects, each one representing an image associated with the product. | |
| ProductType | String | False |
A categorization that a product can be tagged with, commonly used for filtering and searching. | |
| Options | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| Variants | String | False |
Custom product property names like 'Size', 'Color', and 'Material'. | |
| PublishedScope | String | False |
Indicates whether the product is published to the Point of Sale channel. | |
| Tags | String | False |
A categorization that a product can be tagged with. Use commas to separate categories. | |
| Status | String | False |
The status of the product. | |
| TemplateSuffix | String | True |
The suffix of the liquid template being used. | |
| Title | String | False |
The name of the product. | |
| Vendor | String | False |
The name of the vendor of the product. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store channel. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. | |
| PublishedStatus | String | True |
Return products by their published status: published: show only published products;unpublished: show only unpublished products; any: show all products. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Published | Bool |
Set to true to publish the product or to false to not publish it. |
| MetafieldsGlobalTitleTag | String |
The name of the product, to be used for SEO purposes. |
| MetafieldsGlobalDescriptionTag | String |
The description of the product, to be used for SEO purposes. |
ProductVariants
List of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and ProductId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM ProductVariants WHERE Id = '123'
SELECT * FROM ProductVariants WHERE Id IN ('123', '456')
SELECT * FROM ProductVariants WHERE ProductId = '456'
Insert
You must specify the ProductId to insert a product variant.
INSERT INTO ProductVariants (ProductId, Option1, Price) VALUES ('123', 'Yellow', 3.5)
Update
You must specify the Id of the variant to edit a product variant.
-
Update the title and price of an existing variant.
UPDATE ProductVariants SET Option1 = 'Pink', Price = 99.99 WHERE Id = '123'
Delete
You must specify the ProductId and the Id of the variant to delete a product variant.
DELETE FROM ProductVariants WHERE Id = '123' AND ProductId = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the product variant. | |
| ProductId | Long | False |
A unique numeric identifier for the product this variant belongs to. | |
| InventoryItemId | Long | False |
The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information. | |
| ImageId | Long | False |
A unique numeric identifier for the image this variant belongs to. | |
| Price | Decimal | False |
The price of the product variant. | |
| CompareAtPrice | String | False |
The competitors prices for the same item. | |
| Title | String | False |
The name of the product. | |
| Grams | Int | False |
The weight of the product variant in grams. | |
| Barcode | String | False |
A human-friendly unique string for the Product automatically generated from its title. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified. | |
| WeightUnit | String | True |
The unit of measurement that applies to the product's variant weight. | |
| FulfillmentService | String | False |
Service which is doing the fulfillment. | |
| InventoryManagement | String | False |
Specifies whether or not Shopify tracks the number of items in stock for this product variant. | |
| InventoryPolicy | String | True |
Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock. Valid values are deny or continue. | |
| InventoryQuantity | Int | True |
The number of items in stock for this product variant. Default value 1. | |
| Option1 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option2 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Option3 | String | False |
Custom properties that a shop owner can use to define product variants. | |
| Position | Int | False |
The order of the product variant in the list of product variants. | |
| RequiresShipping | Bool | False |
Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant. | |
| Sku | String | False |
A unique identifier for the product in the shop. | |
| Taxable | Bool | False |
Specifies whether or not a tax is charged when the product variant is sold. | |
| CreatedAt | Datetime | True |
The date and time when the product variant was created. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified. |
Provinces
Query and update information regarding different provinces.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CountryId and Id columns. The supported SQL operator is '=' for ProductId and Id columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Provinces WHERE CountryId = '123'
SELECT * FROM Provinces WHERE CountryId = '123' and Id = '456'
Update
You must specify the CountryId and Id to update a province. For example:
UPDATE Provinces SET Tax = '3.4' WHERE CountryId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the province. | |
| CountryId [KEY] | Long | True |
Countries.Id |
The ID for the country that the province belongs to. |
| Name | String | False |
The full name of the province. | |
| Code | String | False |
The standard abbreviation for the province. | |
| Tax | Decimal | False |
The sales tax rate to be applied to orders made by customers from this province.. | |
| TaxPercentage | Double | False |
The province's tax in percent format. | |
| TaxName | String | False |
The name of the tax for this province. | |
| TaxType | String | False |
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. | |
| ShippingZoneId | Long | True |
The ID for the shipping zone that the province belongs to. |
RecurringApplicationCharges
Create, update, delete, and query Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM RecurringApplicationCharges
SELECT * FROM RecurringApplicationCharges WHERE Id = '123'
Update
UPDATE RecurringApplicationCharges SET Test = 'true', Name = 'cd' WHERE Id = '2'
Delete
You must specify the Id of the recurring application charge to delete it.
DELETE FROM RecurringApplicationCharges WHERE Id = '2'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the recurring application charge. | |
| Name | String | False |
The name of the recurring application charge. | |
| ApiClientId | String | False |
The API Client Id | |
| Price | Decimal | False |
The price of the recurring application charge. The maximum price is 10,000. | |
| Status | String | False |
The status of the recurring charge | |
| ReturnUrl | String | False |
The URL where the merchant is redirected after accepting the charge. | |
| BillingOn | Date | False |
The date and time (ISO 8601 format) when the customer was billed. | |
| Test | String | False |
Whether the application charge is a test transaction. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was created. | |
| UpdatedAt | Datetime | False |
The date and time (ISO 8601 format) when the recurring application charge was last updated. | |
| ActivatedOn | Datetime | False |
The date and time (ISO 8601 format) when the customer activated the recurring application charge. | |
| CancelledOn | Datetime | False |
The date and time (ISO 8601 format) when the merchant canceled their recurring application charge. | |
| TrialDays | Int | False |
The number of days that the customer is eligible for a free trial. | |
| TrialEndsOn | Datetime | False |
The date and time (ISO 8601 format) when the free trial ends. | |
| DecoratedReturnUrl | String | False |
The decorated return url. | |
| CappedAmount | String | False |
The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property. | |
| ConfirmationUrl | String | False |
The URL where the merchant accepts or declines the recurring application charge. | |
| Terms | String | False |
The terms and conditions of usage based billing charges. Must be present in order to create usage charges, |
Redirects
Create, read, update or delete redirects.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Redirects
SELECT * FROM Redirects WHERE Id = '123'
SELECT * FROM Redirects WHERE Target = '/pqr.jsp'
SELECT * FROM Redirects WHERE Path = '/abc.php'
Insert
You must specify path and target to create a Redirect.
INSERT INTO Redirects (path, target) VALUES ('/abc.php', '/pqr.jsp')
Update
You must specify the id to update a Redirect. For example:
UPDATE Redirects SET Path = '/abc.php' WHERE Id = '77171130'
Delete
You must specify the Id of the Redirect to delete it.
DELETE FROM Redirects WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the redirect. | |
| Path | String | False |
The old path to be redirected. | |
| Target | String | False |
The target location where the user will be redirected. |
Refunds
Create and query refunds.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
If you specify the unique identifier of the Order, then this view will only list refund information concerning that order.
SELECT * FROM Refunds WHERE OrderId = '179098550295'
SELECT * FROM Refunds WHERE OrderId = '179098550295' AND Id = '7382073367'
Insert
You must specify the OrderId when inserting a refund.
-
Create a new refund for an order using aggregates.
INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]') -
Create a new refund for an order using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Refunds (OrderId, Restock, Notify, Note, ShippingFullRefund, LineAggregate) VALUES ('123', true, true, 'Wrong size', true, 'OrdersItems#TEMP') -
Create a new refund for an order and attach a transaction to the refund as well using aggregates.
INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', '[{\"id\":\"123\",\"quantity\":3,\"restock_type\": \"return\"}]', '[{\"kind\":\"refund\",\"amount\":5.5,\"gateway\":\"gw\",\"parent_id\":\"789\"}]') -
Create a new refund for an order and attach a transaction to the refund as well using temporary table.
INSERT INTO OrdersItems#TEMP (ItemId, ItemQuantity) VALUES ('123', 3) INSERT INTO Transactions#TEMP (TransactionItemParentId, TransactionItemAmount, TransactionItemKind, TransactionItemGateway) VALUES ('789', 5.5, 'refund', 'gw') INSERT INTO Refunds (OrderId, LineAggregate, OrderTransactionAggregate) VALUES ('123', 'OrdersItems#TEMP', 'Transactions#TEMP') -
Refund a specific amount of shipping using aggregates.
INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, '[{\"parent_id\":\"456\"}]') -
Refund a specific amount of shipping using temporary table.
INSERT INTO Transactions#TEMP (TransactionItemParentId) VALUES ('456') INSERT INTO Refunds (OrderId, ShippingAmount, OrderTransactionAggregate) VALUES ('123', 5.3, 'Transactions#TEMP')
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique identifier for the refund. | |
| OrderId | Long | False |
Orders.Id |
The id of the order. |
| OrderUpdatedAt | Datetime | True |
Orders.UpdatedAt |
The date and time when the order was last modified. |
| Note | String | False |
The optional note attached to a refund. | |
| Restock | Bool | True |
Whether or not the line items were added back to the store inventory. | |
| UserId | Long | True |
The unique identifier of the user who performed the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| ProcessedAt | Datetime | True |
The date and time when the refund was imported. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the refund. | |
| OrderTransactionAggregate | String | False |
A JSON aggregate of transactions associated with the refund. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Notify | Bool |
Whether or not to send a refund notification to the customer. |
| DiscrepancyReason | String |
An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other) |
| ShippingAmount | Decimal |
Set specific amount of shipping to refund. Takes precedence over FullRefund. |
| ShippingFullRefund | Bool |
Whether or not to to refund all remaining shipping. |
ResourceFeedbacks
Returns a list of resource feedback objects..
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM ResourceFeedbacks
Insert
You must specify path and target to create a Redirect.
INSERT INTO [ResourceFeedbacks] ([State], [Messages], [FeedbackGeneratedAt]) VALUES ('requires_action', 'Wow wow.', '2023-09-13 09:00:00');
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Unique id of the resource. | |
| Type | String | False |
TType of resource for which feedback is returned. eg. Shop, Product. | |
| State | String | False |
Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success. | |
| Messages | String | False |
The name of the report. | |
| CreatedAt | Datetime | False |
DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| UpdatedAt | Datetime | False |
DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone. | |
| ResourceUpdatedAt | Datetime | False |
The date and time (ISO 8601) when the report was last modified. | |
| FeedbackGeneratedAt | Datetime | False |
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. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone. |
ScriptTags
Create, read, update or delete script tags.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. For CreatedAt and UpdatedAt the supported SQL operators are '>' and '<'. The following queries are the only ones processed server-side:SELECT * FROM ScriptTags
SELECT * FROM ScriptTags WHERE Id = '123'
SELECT * FROM ScriptTags WHERE CreatedAt > '2018-05-02'
SELECT * FROM ScriptTags WHERE UpdatedAt < '2017-08-15'
SELECT * FROM ScriptTags WHERE Src = 'https://example.com/my_script.js'
Insert
You must specify event and src to create a ScriptTag.
INSERT INTO Scripttags (event, src) VALUES ('onload', 'https://js-aplenty.com/abc.js')
Update
You must specify the id to update a ScriptTag. For example:
UPDATE ScriptTags SET src = 'https://js-aplenty.com/abc.js' WHERE Id = '77171130'
Delete
You must specify the Id of the ScriptTag to delete it.
DELETE FROM ScriptTags WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID for the script tag. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was created. | |
| DisplayScope | String | False |
The page or pages on the online store where the script should be included. | |
| Event | String | False |
The DOM event that triggers the loading of the script. Valid values: onload. | |
| Src | String | False |
The URL of the remote script. | |
| UpdatedAt | Datetime | True |
The date and time (ISO 8601) when the script tag was last updated. |
SmartCollections
Query, insert, update, or delete information regarding different smart collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, Title, Handle, PublishedStatus, UpdatedAt, PublishedAt columns. The supported SQL operators are '=' and 'IN' for Id, '=' for the ProductId, Title, Handle, and PublishedStatus columns and '>' and '<' for the UpdatedAt and PublishedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM SmartCollections WHERE Id = '123'
SELECT * FROM SmartCollections WHERE Id IN ('123', '456')
SELECT * FROM SmartCollections WHERE ProductId = '123'
SELECT * FROM SmartCollections WHERE Title = 'Ducks'
SELECT * FROM SmartCollections WHERE Handle = 'frontpage'
SELECT * FROM SmartCollections WHERE PublishedStatus = 'published'
SELECT * FROM SmartCollections WHERE UpdatedAt > '2018-05-02'
SELECT * FROM SmartCollections WHERE PublishedAt < '2017-08-15'
Insert
You must specify the Title and Rules to create a smart collection. For example:
INSERT INTO SmartCollections (Title, Rules) VALUES ('IPods', '[{"column": "vendor","relation": "equals","condition": "Apple"}]')
Update
You must specify the smart collection Id to update a smart collection. For example:
UPDATE SmartCollections SET BodyHtml = '5000 songs in your pocket' WHERE Id = '123'
Delete
You must specify the Id of the smart collection to delete it.
DELETE FROM SmartCollections WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The ID of the smart collection. | |
| Title | String | False |
The name of the smart collection. Maximum length: 255 characters. | |
| BodyHtml | String | False |
The description of the smart collection. Includes HTML markup. Many shop themes display this on the smart collection page. | |
| Image | String | False |
A JSON aggregate with information regarding the image of smart collection. | |
| Rules | String | False |
A JSON aggregate with the list of rules that define what products go into the smart collection. Valid values for each rule field: column: tag, title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title; relation: equals, greater_than, less_than, starts_with, ends_with, contains; condition: any string | |
| Handle | String | False |
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) | |
| Disjunctive | Bool | False |
Whether the product must match all the rules to be included in the smart collection. Valid values: true: products only need to match one or more of the rules to be included in the smart collection, false: products must match all of the rules to be included in the smart collection. | |
| SortOrder | String | False |
The order in which products in the smart collection appear. | |
| TemplateSuffix | String | False |
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. | |
| PublishedScope | String | False |
Whether the smart collection is published to Point of Sale. Valid values: web: The smart collection is published to the shop's online channels and not published to the Point of Sale channel, global: The smart collection is published to both the online channels and the Point of Sale channel. | |
| UpdatedAt | Datetime | True |
The date and time when the smart collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the smart collection was published. Returns null when the collection is hidden. | |
| ProductId | String | True |
Show smart collections that include a given product. | |
| PublishedStatus | String | True |
Show smart collection with a given published status: published: show only published smart collections, unpublished: show only unpublished smart collections, any: show all smart collections. (default: any). |
Themes
Create, read, update or delete themes
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM Theme
SELECT * FROM Themes WHERE Id = '123'
Insert
You must specify name to create a Theme.
INSERT INTO Themes (name) VALUES ('NewTheme')
Update
You must specify the id to update a Theme. For example:
UPDATE Themes SET name = 'NewTheme' WHERE Id = '77171130'
Delete
You must specify the Id of the Theme to delete it.
DELETE FROM Themes WHERE Id = '555695'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the theme. | |
| AdminGraphqlApiId | String | True |
Displays the Admin Graphql API id. | |
| CreatedAt | Datetime | True |
The date and time (ISO 8601 format) when the theme was created. | |
| Name | String | False |
The name of the theme. | |
| Previewable | Bool | True |
Whether the theme can currently be previewed. | |
| Processing | Bool | True |
Whether files are still being copied into place for this theme. | |
| Role | String | False |
Specifies how the theme is being used within the shop. | |
| ThemeStoreId | Long | True |
A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store. | |
| UpdatedAt | Datetime | True |
The date and time ( ISO 8601 format) when the theme was last updated. |
UsageCharges
Create or view Usage Charges for Recurring Application Charges.
Table-Specific Information
Select
The Sync App processes all filters client-side within the Sync App. The following queries are the only ones processed server-side:SELECT * FROM UsageCharges WHERE Id = 123
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619
SELECT * FROM UsageCharges WHERE RecurringApplicationId = 5569619 AND Id = 123
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
The ID of the usage charge. | |
| Description | String | False |
The name of the usage charge. | |
| Price | Decimal | False |
The price of the usage charge. | |
| CreatedAt | Datetime | False |
The date and time (ISO 8601 format) when the usage charge was created. | |
| BalanceUsed | Decimal | False |
The used balance | |
| BalanceRemaining | Decimal | False |
The remaining balance | |
| RiskLevel | Int | False |
The risk Level | |
| RecurringApplicationId | Long | False |
The Id of the RecurringApplication Charge |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| AbandonedCheckouts | Query abandoned checkouts. |
| AbandonedCheckoutsItems | Query abandoned checkouts items. |
| AssignedFulfillmentOrders | The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level. |
| DiscountApplications | Query note attributes belonging to an order or draft order. |
| DraftOrderItemProperties | Query order item properties. |
| DraftOrderItems | Query draft order items. |
| DraftOrderItemTaxLines | Query draft order items tax lines. |
| Events | Retrieve events which have happened in your shop. |
| FulfillmentOrders | Query fulfillment orders. |
| Locations | Retrieve information regarding store locations. |
| NoteAttributes | Query note attributes belonging to an order or draft order. |
| OrderDiscountCodes | Query note attributes belonging to an order or draft order. |
| OrderItemDiscountAllocations | Query order item discount allocations. |
| OrderItemProperties | Query order item properties. |
| OrdersItems | Query order items. |
| Payouts | Retrieves a list of all payouts ordered by payout date, with the most recent being first. |
| PayoutTransactions | Retrieves a list of all balance transactions ordered by processing time, with the most recent being first. |
| RefundAdjustments | Create and query transactions. |
| RefundsItems | Get data on OrdersItems that have been refunded. |
| RefundTransactions | Query transactions for Refund Object. |
| Reports | To query all the Reports. |
| ShippingItemDiscountAllocations | Query Shipping item discount allocations. |
| ShippingItems | Query order shipping. |
| ShippingZones | Retrieve information regarding shipping zones. |
| Shop | Contains general settings and information about the shop. |
| TaxItems | Query order taxes. |
| Users | Query Users. |
AbandonedCheckouts
Query abandoned checkouts.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckouts WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the order. | |
| AbandonedCheckoutUrl | String | The full recovery URL to be sent to a customer to recover their abandoned checkout. | |
| BuyerAcceptsMarketing | Bool | Indicates whether or not the person who placed the order would like to receive email updates from the shop. | |
| CancelReason | String | The reason why the order was cancelled. | |
| CartToken | String | Unique identifier for a particular cart that is attached to a particular order. | |
| Currency | String | The three letter code (ISO 4217) for the currency used for the payment. | |
| CustomerId | Long |
Customers.Id | A unique numeric identifier for the customer. |
| DiscountCodes | String | Applicable discount codes that can be applied to the order. | |
| String | The customer's email address. | ||
| Note | String | The text of an optional note that a shop owner can attach to the order. | |
| LandingSite | String | The URL for the page where the buyer landed when entering the shop. | |
| ReferringSite | String | The website that the customer clicked on to come to the shop. | |
| SourceName | String | Where the order originated. | |
| SubtotalPrice | Decimal | Price of the order before shipping and taxes. | |
| TotalDiscounts | Decimal | The total amount of the discounts to be applied to the price of the order. | |
| TotalLineItemsPrice | Decimal | The sum of all the prices of all the items in the order. | |
| TotalPrice | Decimal | The sum of all the prices of all the items in the order, taxes and discounts included. | |
| TotalTax | Decimal | The sum of all the taxes applied to the order. | |
| TotalWeight | Double | The sum of all the weights of the line items in the order, in grams. | |
| TaxesIncluded | Bool | States whether or not taxes are included in the order subtotal. | |
| Token | String | Unique identifier for a particular order. | |
| BillingAddressFirstName | String | The first name of the person associated with the payment method. | |
| BillingAddressLastName | String | The last name of the person associated with the payment method. | |
| BillingAddressAdress1 | String | The street address of the billing address. | |
| BillingAddressAdress2 | String | An optional additional field for the street address of the billing address. | |
| BillingAddressPhone | String | The phone number at the billing address. | |
| BillingAddressCity | String | The city of the billing address. | |
| BillingAddressCompany | String | The company of the person associated with the billing address. | |
| BillingAddressZip | String | The zip or postal code of the billing address. | |
| BillingAddressProvince | String | The name of the state or province of the billing address. | |
| BillingAddressCountry | String | The name of the country of the billing address. | |
| BillingAddressLatitude | Double | The latitude of the billing address. | |
| BillingAddressLongitude | Double | The longitude of the billing address. | |
| BillingAddressName | String | The full name of the person associated with the payment method. | |
| BillingAddressCountryCode | String | The two-letter code for the country of the billing address. | |
| BillingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the billing address. | |
| BillingAddressDefault | Bool | Whether this address is the default one or not. | |
| ShippingAddressFirstName | String | The first name of the person associated with the shipping address. | |
| ShippingAddressLastName | String | The last name of the person associated with the shipping address. | |
| ShippingAddressAdress1 | String | The street address of the shipping address. | |
| ShippingAddressAdress2 | String | An optional additional field for the street address of the shipping address. | |
| ShippingAddressPhone | String | The phone number at the shipping address. | |
| ShippingAddressCity | String | The city of the shipping address. | |
| ShippingAddressCompany | String | The company of the person associated with the shipping address. | |
| ShippingAddressZip | String | The zip or postal code of the shipping address. | |
| ShippingAddressProvince | String | The name of the state or province of the shipping address. | |
| ShippingAddressCountry | String | The name of the country of the shipping address. | |
| ShippingAddressLatitude | Double | The latitude of the shipping address. | |
| ShippingAddressLongitude | Double | The longitude of the shipping address. | |
| ShippingAddressName | String | The full name of the person associated with the shipping address. | |
| ShippingAddressCountryCode | String | The two-letter code for the country of the shipping address. | |
| ShippingAddressProvinceCode | String | The two-letter abbreviation of the state or province of the shipping address. | |
| ShippingAddressDefault | Bool | Whether this address is the default one or not. | |
| ClosedAt | Datetime | The date and time when the order was closed. | |
| CompletedAt | Datetime | CompletedAt | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AbandonedCheckoutsItems
Query abandoned checkouts items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the CreatedAt and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AbandonedCheckoutsItems WHERE CreatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| AbandonedCheckoutId [KEY] | Long | The unique numeric identifier for the order. | |
| ProductId [KEY] | Long |
Products.Id | The product ID od the item. |
| ItemVariantId [KEY] | Long | The product variant ID of item. | |
| ItemTitle | String | The title of the product. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item in presentment currency. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier for the item in the shop. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the item's supplier. | |
| FulFillmentsService | String | The fulfillment service provider for the item. | |
| CreatedAt | Datetime | The date and time when the order was created. | |
| UpdatedAt | Datetime | The date and time when the order was last modified. |
AssignedFulfillmentOrders
The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the AssignedLocationId and RequestStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationId IN (1, 2)
SELECT * FROM AssignedFulfillmentOrders WHERE RequestStatus = 'cancellation_requested'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| FulfillmentServiceHandle | String | A unique numeric identifier for the order. | |
| RequestStatus | String | The status of the fulfillment. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| Status | String | The status of the fulfillment order. | |
| Operation | String | An operation to apply to the fulfillment. Complete, Open, or Cancel. |
DiscountApplications
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM DiscountApplications WHERE OrderId = '1'
SELECT * FROM DiscountApplications WHERE OrderId IN ('1', '2')
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt <= '2020-07-20 08:28:03.0'
SELECT * FROM DiscountApplications WHERE OrderUpdatedAt > '2020-07-20 08:28:03.0'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Type | String | The name of the note attribute. | |
| Title | String | The value of the note attribute. | |
| Description | String | The value of the note attribute. | |
| Value | String | The value of the note attribute. | |
| ValueType | String | The value of the note attribute. | |
| AllocationMethod | String | The value of the note attribute. | |
| TargetSelection | String | The value of the note attribute. | |
| TargetType | String | The value of the note attribute. |
DraftOrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId column. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItemProperties WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the order item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. |
DraftOrderItems
Query draft order items.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the DraftOrderId. The supported SQL operators are '=' for DraftOrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM DraftOrderItems WHERE DraftOrderId = '123'
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the line item. | |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| ProductId | Long |
Products.Id | The ID of the product corresponding to the line item product variant. |
| Custom | Bool | States whether this is a custom line item or a product variant line item | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| FulFillmentsService | String | Service provider responsible for fulfillment. | |
| ItemGrams | Int | The weight of the item in grams. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| ItemTitle | String | The title of the product or variant. | |
| ItemVariantId | Long | The id of the product variant. | |
| VariantTitle | String | The title of the product variant. | |
| Vendor | String | The name of the supplier of the item. | |
| Name | String | The name of the product variant. | |
| GiftCard | Bool | States whether or not the product is a gift card. | |
| Properties | String | Shows custom properties for this order item. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| TaxLines | String | Shows tax lines for this order item. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
DraftOrderItemTaxLines
Query draft order items tax lines.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
DraftOrderItems.ItemId | The id of the draft line item. |
| DraftOrderId | Long |
DraftOrders.Id | The id of the draft. |
| TaxTitle | String | The name of the tax. | |
| TaxRate | Decimal | The rate of tax to be applied. | |
| TaxPrice | Decimal | The amount of tax to be charged. |
Events
Retrieve events which have happened in your shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, ProductId, OrderId, Verb, and CreatedAt columns. The supported SQL operators are '=' for the Id, ProductId, OrderId, and Verb columns and ">" and "<" for CreatedAt. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Events WHERE Id = '123'
SELECT * FROM Events WHERE ProductId = '123'
SELECT * FROM Events WHERE OrderId = '123'
SELECT * FROM Events WHERE Verb = 'Confirmed'
SELECT * FROM Events WHERE CreatedAt > '2018-05-02'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the event. | |
| Description | String | A human readable description of the event. | |
| Message | String | A human readable description of the event. Can contain some HTML formatting. | |
| Body | String | A text field containing information about the event. | |
| Path | String | A relative URL to the resource the event is for, if applicable. | |
| SubjectId | Long | The ID of the resource that generated the event. | |
| SubjectType | String | he type of the resource that generated the event. Valid values: Article, Blog, Collection, Comment, Order, Page, Product, ApiPermission. | |
| Verb | String | The type of event that occurred. Different resources generate different types of event. | |
| Author | String | The author of the event. | |
| Arguments | String | Refers to a certain event and its resources. | |
| CreatedAt | Datetime | The date and time when the event was created. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| OrderId | Long | The ID of the Order to retrieve events from. | |
| ProductId | Long | The ID of the Product to retrieve events from. |
FulfillmentOrders
Query fulfillment orders.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and Id columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM FulfillmentOrders WHERE OrderId = '1'
SELECT * FROM FulfillmentOrders WHERE Id = '1'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | An ID for the fulfillment order. | |
| ShopId | Long |
Shop.Id | The ID of the shop that's associated with the fulfillment order. |
| OrderId [KEY] | Long |
Orders.Id | The ID of the order that's associated with the fulfillment order. |
| AssignedLocationId | Long | The ID of the location that has been assigned to do the work. | |
| DestinationId | String | The ID of the fulfillment order destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| FullfillAt | Datetime | The datetime (in UTC) when the fulfillment order is ready for fulfillment. | |
| LineItems | String | Represents line items belonging to a fulfillment order. | |
| RequestStatus | String | The status of the fulfillment. | |
| Status | String | The status of the fulfillment order. | |
| SupportedActions | String | The actions that can be performed on this fulfillment order. | |
| MerchantRequests | String | A list of requests sent by the merchant to the fulfillment service for this fulfillment order.. | |
| FulfillmentHolds | String | Represents the fulfillment holds applied on the fulfillment order. | |
| InternationalDuties | String | The international duties relevant to the fulfillment order. | |
| AssignedLocationAddress1 | String | The street address of the assigned location | |
| AssignedLocationAddress2 | String | An optional additional field for the street address of the assigned location. | |
| AssignedLocationCity | String | The city of the assigned location. | |
| AssignedLocationCountryCode | String | The two-letter code for the country of the assigned location | |
| AssignedLocationName | String | The name of the assigned location. | |
| AssignedLocationPhone | String | The phone number of the assigned location. |
Locations
Retrieve information regarding store locations.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id column. The supported SQL operator is '='. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Locations WHERE Id = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID for the location. | |
| Name | String | The name of the location. | |
| Legacy | Bool | 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. | |
| Address1 | String | The first line of the address. | |
| Address2 | String | The second line of the address. | |
| City | String | The city the location is in. | |
| Zip | String | The zip or postal code. | |
| Province | String | The province the location is in. | |
| Country | String | The country the location is in. | |
| Phone | String | The phone number of the location. This value can contain special characters like - and +. | |
| CountryCode | String | The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in. | |
| CountryName | String | The name of the country the location is in. | |
| CreatedAt | Datetime | The date and time when the location was created. | |
| UpdatedAt | Datetime | The date and time when the location was last updated. | |
| DeletedAt | Datetime | The date and time when the location was deleted. |
NoteAttributes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM NoteAttributes WHERE OrderId = '123'
SELECT * FROM NoteAttributes WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Name | String | The name of the note attribute. | |
| Value | String | The value of the note attribute. |
OrderDiscountCodes
Query note attributes belonging to an order or draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.SELECT * FROM OrderDiscountCodes WHERE OrderId = '1'
SELECT * FROM OrderDiscountCodes WHERE OrderId IN ('1', '2')
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt <= '2019-05-13 09:23:06.0'
SELECT * FROM OrderDiscountCodes WHERE OrderUpdatedAt >= '2019-05-13 09:23:06.0'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Code [KEY] | String | The name of the note attribute. | |
| Amount | String | The value of the note attribute. | |
| Type | String | The value of the note attribute. |
OrderItemDiscountAllocations
Query order item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| amount | String | The Amount of the item discount allocations. | |
| ApplicationIndex | Int | The ApplicationIndex of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrderItemProperties
Query order item properties.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId column. The supported SQL operators are '=' for OrderId. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side. You can set the Type pseudo column to "DraftOrder" to list order items belonging to draft orders instead of orders, or you can set Type to "AbandonedCheckout" to list order items belonging to abandoned checkouts.
SELECT * FROM OrderItemProperties WHERE OrderId = '123'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Name | String | The name of the item property. | |
| Value | String | The value of the item property. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
OrdersItems
Query order items.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long | The id of the order item. Only available for orders. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Type | String | The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout). | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
Payouts
Retrieves a list of all payouts ordered by payout date, with the most recent being first.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id, Status and Date columns. The supported SQL operator is '=' for Id, Status and Date columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side:
SELECT * FROM Payouts WHERE Id = '123'
SELECT * FROM Payouts WHERE Status = 'pending'
SELECT * FROM Payouts WHERE Date = '2018-10-30'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the payout. | |
| Status | String | The transfer status of the payout. | |
| Currency | String | The ISO 4217 currency code of the payout. | |
| Amount | Decimal | The total amount of the payout, in a decimal formatted string. | |
| Date | Datetime | The date the payout was issued. |
PayoutTransactions
Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique identifier of the transaction. | |
| Type | String | The type of the balance transaction. | |
| Test | Bool | If the transaction was created for a test mode Order or payment. | |
| PayoutId | Long |
Payouts.Id | The id of the payout the transaction was paid out in. |
| PayoutStatus | String | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout. | |
| Currency | String | The ISO 4217 currency code of the transaction. | |
| Amount | Decimal | The gross amount of the transaction, in a decimal formatted string. | |
| Fee | Decimal | The total amount of fees deducted from the transaction amount. | |
| Net | Decimal | The net amount of the transaction. | |
| SourceId | Long | The id of the resource leading to the transaction. | |
| SourceType | String | The type of the resource leading to the transaction. | |
| SourceOrderTransactionId | String | The id of the Order Transaction that resulted in this balance transaction. | |
| SourceOrderId | String | The id of the Order that this transaction ultimately originated from. | |
| ProcessedAt | Datetime | The time the transaction was processed. |
RefundAdjustments
Create and query transactions.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundAdjustments WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundAdjustments WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the refund adjustment. | |
| OrderId | Long |
Orders.Id | The unique identifier for the order that the order adjustment is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund that the order adjustment is associated with. |
| Amount | Decimal | The value of the discrepancy between the calculated refund and the actual refund. | |
| TaxAmount | Decimal | The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund. | |
| Kind | String | The order adjustment type. | |
| Reason | String | The reason for the order adjustment. | |
| AmountShopMoney | Decimal | The amount of the order adjustment in shop. | |
| AmountShopCurrency | String | The currency of the order adjustment in shop. | |
| AmountPresentmentMoney | Decimal | The amount of the order adjustment in presentment. | |
| AmountPresentmentCurrency | String | The currency of the order adjustment in presentment. | |
| TaxAmountShopMoney | Decimal | The tax amount of the order adjustment in shop. | |
| TaxAmountShopCurrency | String | The tax currency of the order adjustment in shop. | |
| TaxAmountPresentmentMoney | Decimal | The tax amount of the order adjustment in presentment. | |
| TaxAmountPresentmentCurrency | String | The tax currency of the order adjustment in presentment. |
RefundsItems
Get data on OrdersItems that have been refunded.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
| OrderID [KEY] | Long |
Orders.Id | The id of the refund this refunded item belongs to. |
| RefundId [KEY] | Long |
Refunds.Id | The id of the refund this refunded item belongs to. |
| LocationId | Long | The unique identifier of the location tied to the refund item | |
| ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
| ItemVariantId | Long | The id of the product variant. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The number of products that were purchased. | |
| ItemPrice | Decimal | The price of the item before discounts have been applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier of the item in the fulfillment. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | Shows custom properties for this order item. | |
| Vendor | String | The name of the supplier of the item. | |
| FulFillmentsService | String | Service provider who is doing the fulfillment. | |
| RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
| Taxable | Bool | States whether or not the product was taxable. | |
| GiftCard | Bool | States whether or not the order item is a gift card. | |
| FulfillableQuantity | Int | The amount available to fulfill. | |
| TotalDiscount | Decimal | The total discount amount applied to this order item. | |
| FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
| RefundSubtotal | Decimal | The refunded amount for this item. This is calculated by multiplying ItemPrice with RefundQuantity. | |
| RefundQuantity | Int | The quantity of the item refunded. | |
| RefundRestockType | String | The type of the restock action. | |
| RefundSubtotalPresentmentAmount | Decimal | The total amount of the presentment money. | |
| RefundSubtotalPresentmentCurrencyCode | String | The currency code of the presentment money. | |
| RefundSubtotalShopAmount | Decimal | The total amount of the shop money. | |
| RefundSubtotalShopCurrencyCode | String | The currency code of the shop money. | |
| RefundTotalTax | Decimal | Total tax for the refunded item. | |
| RefundTotalTaxPresentmentAmount | Decimal | Total tax amount for the presentment money. | |
| RefundTotalTaxPresentmentCurrencyCode | String | Currency code for the tax on presentment money. | |
| RefundTotalTaxShopAmount | Decimal | Total tax amount for the shop money. | |
| RefundTotalTaxShopCurrencyCode | String | Currency code for the tax on shop money. | |
| AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
| AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |
RefundTransactions
Query transactions for Refund Object.
Table-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The Sync App processes other filters client-side within the Sync App.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the Sync App will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the Sync App will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the Sync App will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundTransactions WHERE OrderId = '123' AND RefundId = '123'
Columns
| Name | Type | References | Description |
| TransactionsId [KEY] | Long | The ID for the refund transaction. | |
| OrderId | Long |
Orders.Id | The ID for the order that the transaction is associated with. |
| RefundId | Long |
Refunds.Id | The unique identifier for the refund associated with. |
| Amount | Decimal | The amount of money included in the transaction. | |
| Authorization | String | The authorization code associated with the transaction.. | |
| CreatedAt | Datetime | The date and time (ISO 8601 format) when the transaction was created. | |
| Currency | String | The three-letter code (ISO 4217 format) for the currency used for the payment. | |
| DeviceId | String | The ID for the device. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| GraphqlAPIId | String | The order adjustment type. | |
| Gateway | String | The name of the gateway the transaction was issued through. | |
| Kind | String | The transaction's type. | |
| LocationId | String | The ID of the physical location where the transaction was processed. | |
| Message | String | A string generated by the payment provider with additional information about why the transaction succeeded or failed. | |
| ParentId | Long | The ID of an associated transaction.. | |
| ProcessedAt | Datetime | The date and time (ISO 8601 format) when a transaction was processed. | |
| Status | String | The status of the transaction. | |
| SourceName | String | The origin of the transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| UserId | String | The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable. |
Reports
To query all the Reports.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the Id and UpdatedAt columns. The Sync App processes other filters client-side within the Sync App.For example, the following queries are processed server-side.
SELECT * FROM Reports WHERE Id = '123'
SELECT * FROM Reports WHERE UpdatedAt > '2017-10-25'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the report. | |
| Name | String | The name of the report. | |
| ShopifyQl | String | The ShopifyQL query that generates the report. | |
| UpdatedAt | Datetime | The date and time (ISO 8601) when the report was last modified. | |
| Category | String | The category for the report. When you create a report, the API will return custom_app_reports. |
ShippingItemDiscountAllocations
Query Shipping item discount allocations.
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| ItemId | Long |
ShippingItems.ItemId | The id of the shipping item. Only available for orders. |
| OrderId | Long |
Orders.Id | The id of the order. |
| Amount | String | The Amount of the item discount allocations. | |
| ShopMoneyAmount | Decimal | The ShopMoneyAmount of the item discount allocations. | |
| ShopMoneyCurrencyCode | String | The ShopMoneyCurrencyCode of the item discount allocations. | |
| PresentmentMoneyAmount | Decimal | The PresentmentMoneyAmount of the item discount allocations. | |
| PresentmentMoneyCurrencyCode | String | The PresentmentMoneyCurrencyCode of the item discount allocations. | |
| DiscountApplicationIndex | Int | The Discount application index for an order. | |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. |
ShippingItems
Query order shipping.
View-Specific Information
Select
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.
SELECT * FROM ShippingItems WHERE OrderId = '123'
SELECT * FROM ShippingItems WHERE OrderUpdatedAt > '2018-05-05'
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The id of the shipping item. | |
| OrderId [KEY] | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| Price | Decimal | The price of this shipping method. | |
| Code | String | A reference to the shipping method. | |
| Title | String | The title of the shipping method. | |
| Source | String | The source of the shipping method. | |
| CarrierIdentifier | String | A reference to the carrier service that provided the rate. | |
| RequestedFulfillmentServiceId | String | A reference to the fulfillment service that is being requested for the shipping method. |
ShippingZones
Retrieve information regarding shipping zones.
View-Specific Information
Select
The Sync App processes all filters client-side within the Sync App.The following query is the only one processed server-side:
SELECT * FROM ShippingZones
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The unique numeric identifier for the shipping zone. | |
| Name | String | The name of the shipping zone, specified by the user. | |
| ProfileId | String | The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates. | |
| LocationGroupId | String | 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. | |
| Countries | String | A list of countries that belong to the shipping zone. | |
| CarrierShippingRateProviders | String | Information about carrier shipping providers and the rates used. | |
| PriceBasedShippingRates | String | Information about price based shipping rates used. | |
| WeightBasedShippingRates | String | Information about weight based shipping rates used. |
Shop
Contains general settings and information about the shop.
View-Specific Information
Select
The Sync App processes the WHERE clause client-side within the Sync App for all queries to this table. For example, the following query is the only query processed server-side:SELECT * FROM Shop
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | A unique numeric identifier for the shop. | |
| Name | String | The name of the shop. | |
| String | The contact email address for the shop. | ||
| Address1 | String | The shop's street address. | |
| Address2 | String | The shop's additional street address (apt, suite, etc.). | |
| City | String | The city in which the shop is located. | |
| Country | String | The shop's country (by default equal to the two-letter country code). | |
| CountryCode | String | The two-letter country code corresponding to the shop's country. | |
| CountryName | String | The shop's normalized country name. | |
| CustomerEmail | String | The customer's email. | |
| Currency | String | The three-letter code for the currency that the shop accepts. | |
| Domain | String | The shop's domain. | |
| GoogleAppsDomain | String | The URL of the domain if the shop has a google apps domain. | |
| GoogleAppsLoginEnabled | String | Indicated whether the shop has google apps login enabled. | |
| Latitude | Double | Geographic coordinate specifying the north/south location of a shop. | |
| Longitude | Double | Geographic coordinate specifying the east/west location of a shop. | |
| MoneyFormat | String | A string representing the way currency is formatted when the currency isn't specified. | |
| MoneyWithCurrencyFormat | String | A string representing the way currency is formatted when the currency is specified. | |
| WeightUnit | String | A string representing the default unit of weight measurement for the shop. | |
| MyshopifyDomain | String | The shop's 'myshopify.com' domain. | |
| PlanName | String | The name of the Shopify plan the shop is on. | |
| HasDiscounts | Bool | Indicates if any active discounts exist for the shop. | |
| HasGiftCards | Bool | Indicates if any active gift cards exist for the shop. | |
| PlanDisplayName | String | The display name of the Shopify plan the shop is on. | |
| PasswordEnabled | Bool | Indicates whether the Storefront password protection is enabled. | |
| Phone | String | The contact phone number for the shop. | |
| PrimaryLocale | String | The shop's primary locale. | |
| Province | String | The shop's normalized province or state name. | |
| ProvinceCode | String | The two-letter code for the shop's province or state. | |
| ShopOwner | String | The username of the shop owner. | |
| Source | String | Source | |
| TaxShipping | Bool | Specifies whether or not taxes were charged for shipping. | |
| TaxesIncluding | Bool | The setting for whether applicable taxes are included in product prices. | |
| CountryTaxes | Bool | The setting for whether the shop is applying taxes on a per-county basis or not (US-only). | |
| Timezone | String | The name of the timezone the shop is in. | |
| IANATimezone | String | The named timezone assigned by the IANA. | |
| Zip | String | The zip or postal code of the shop's address. | |
| HasStorefront | Bool | Indicates whether the shop has web-based storefront or not. | |
| CreatedAt | Datetime | The date and time when the shop was created. | |
| UpdatedAt | Datetime | The date and time when the shop was last updated. | |
| SetupRequired | Bool | Indicates whether the shop has any outstanding setup steps or not. |
TaxItems
Query order taxes.
View-Specific Information
The Sync App uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns. The supported SQL operators are '=' for OrderId and '>' and '<' for OrderUpdatedAt. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server-side.Select
SELECT * FROM TaxItems WHERE OrderId = '123'
SELECT * FROM TaxItems WHERE OrderUpdatedAt > '2018-05-21'
Columns
| Name | Type | References | Description |
| LineNumber [KEY] | Long | A unique numeric identifier for the table. | |
| OrderId | Long |
Orders.Id | The id of the order. |
| OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. | |
| TaxItemPrice | Decimal | The amount of tax to be charged. | |
| TaxItemRate | Decimal | The rate of tax to be applied. | |
| TaxItemTitle | String | The name of the tax. |
Users
Query Users.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the user. | |
| FirstName | String | The first name of the user. | |
| String | The email of the user. | ||
| Url | String | The url of the user. | |
| IM | String | The IM of the user. | |
| ScreenName | String | The screen name of the user. | |
| Phone | String | The phone number of the of the user. | |
| LastName | String | The last name of the user. | |
| AccountOwner | Bool | If the user is the account owner. | |
| ReceiveAnnouncements | Bool | If the user receives announcements. | |
| Bio | String | The bio of the user. | |
| Permissions | String | The list of permissions of the user. | |
| Locale | String | The Locale of the user. | |
| UserType | String | The type of the user. | |
| AdminGraphQLAPIId | String | The Admin GraphQL API Id of the user. | |
| TFAEnabled | Bool | If TFA is enabled. |
GRAPHQL Data Model
The CData Sync App models the Shopify API as relational views, and stored procedures.
To use GraphQL Data Model, simply set Schema to GraphQL.
Tables
テーブル are tables that can be modified.
Views
ビュー are tables that cannot be modified. Typically, model data that is read-only and cannot be updated are shown as views.
Stored Procedures
ストアドプロシージャ are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Using Bulk API
When UseBulkApi is set to True CData Sync App performs Shopify Bulk Operations. This option offers better performance when you need to select or export a lot of data from Shopify.
テーブル
Sync App はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Shopify Connector for CData Sync テーブル
| Name | Description |
| AppFeedbacks | Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store. |
| AppSubscriptionLineItems | Returns the plans attached to the app subscription. |
| AppSubscriptions | Lists all subscriptions created for a shop on the installed application. |
| Catalogs | The catalogs belonging to the shop. |
| Collections | Returns a list of collections. |
| Companies | Returns the list of companies in the shop. |
| CompanyLocations | Returns a list of locations in the company. |
| Customers | Retrieves a list of customers. |
| DeliveryProfiles | Returns a list of saved delivery profiles. |
| DiscountsAutomaticApp | Returns a list of discounts. |
| DiscountsAutomaticBasic | Returns a list of discounts. |
| DiscountsAutomaticBxgy | Returns a list of discounts. |
| DiscountsCodeApp | Returns a list of discounts. |
| DiscountsCodeBasic | Returns a list of discounts. |
| DiscountsCodeBxgy | Returns a list of discounts. |
| DraftOrders | Returns a list of saved draft orders. |
| FulfillmentEvents | Retrieves the history of events associated with one or many fulfillments. |
| FulfillmentOrders | Retrieves a paginated list of merchant-managed and third-party fulfillment orders. |
| Fulfillments | Fulfillment represents a shipment of one or more items in an order. |
| FulfillmentServices | Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner. |
| FulfillmentTrackingInfo | Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL. |
| GiftCards | Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription) |
| InventoryItems | Returns a list of inventory items. |
| Locations | Returns a list of active inventory locations. |
| Metafields | Retrieves a list of metafields that belong to one or many resource IDs. |
| Orders | Retrieves a list of orders. |
| OrderTransactions | Retrieves the transactions associated with the resource. |
| PriceLists | All price lists for a shop. |
| ProductImages | Returns the images associated with the product. |
| ProductResourceFeedbacks | Returns the product resource feedback for the currently authenticated app. |
| Products | Returns a list of products. |
| ProductVariants | Returns a list of the product variants. |
| Publications | Returns the list of publications. |
| Refunds | Represents a refund of items or transactions in an order. |
| Returns | Retrieves a list of returns for the order. |
| ScriptTags | Returns a list of script tags. |
| SellingPlanGroups | Returns a list Selling Plan Groups. |
| StorefrontAccessTokens | Retrieves the storefront access token of a private application. These are scoped per-application. |
| UrlRedirects | Returns a list of redirects for a shop. |
AppFeedbacks
Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.For example, the following queries are processed client-side:
SELECT * FROM AppFeedbacks WHERE Id = 'VALUE'
Insert
INSERT statements are mapped to the 'shopResourceFeedbackCreate' GraphQL mutation.
The following column can be used to create a new record:
Message
The following pseudo-columns can be used to create a new record:
State, FeedbackGeneratedAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | True |
Name of the app. | |
| Message | String | True |
The feedback message presented to the merchant. | |
| Url | String | True |
The URL that the link visits. | |
| Label | String | True |
A context-sensitive label for the link. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| State | String |
The state of the feedback and whether it requires merchant action. |
| FeedbackGeneratedAt | Datetime |
The date and time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. |
AppSubscriptionLineItems
Returns the plans attached to the app subscription.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppSubscriptionLineItems WHERE AppInstallationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'appSubscriptionLineItemUpdate' GraphQL mutation.
The following columns can be updated:
UsagePricingPlanCappedAmount, UsagePricingPlanCappedAmountCurrencyCode
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppSubscriptionId | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| RecurringPricingPlanDiscountDurationLimitInIntervals | Int | True |
The total number of billing intervals to which the discount will be applied. The discount will be applied to an indefinite number of billing intervals if this value is blank. | |
| RecurringPricingPlanDiscountPriceAfterDiscountAmount | Decimal | True |
The price of the subscription after the discount is applied. Decimal money amount. | |
| RecurringPricingPlanDiscountPriceAfterDiscountCurrencyCode | String | True |
The price of the subscription after the discount is applied. Currency of the money. | |
| RecurringPricingPlanDiscountRemainingDurationInIntervals | Int | True |
The remaining number of billing intervals to which the discount will be applied. | |
| RecurringPricingPlanValueAmount | Decimal | True |
The value of the discount applied every billing interval. Decimal money amount. | |
| RecurringPricingPlanValueAmountCurrencyCode | String | True |
The value of the discount applied every billing interval. Currency of the money. | |
| RecurringPricingPlanValuePercentage | Double | True |
The value of the discount applied every billing interval. The percentage value of a discount. | |
| RecurringPricingPlanInterval | String | True |
The frequency at which the subscribing shop is billed for an app subscription. | |
| RecurringPricingPlanPriceAmount | Decimal | True |
The amount to be charged to the subscribing shop every billing interval. Decimal money amount. | |
| RecurringPricingPlanPriceCurrencyCode | String | True |
The currency to be charged to the subscribing shop every billing interval. Currency of the money. | |
| UsagePricingPlanBalanceUsedAmount | Decimal | True |
The total usage records for interval. Decimal money amount. | |
| UsagePricingPlanBalanceUsedCurrencyCode | String | True |
The total usage records for interval. Currency of the money. | |
| UsagePricingPlanCappedAmount | Decimal | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Decimal money amount. | |
| UsagePricingPlanCappedAmountCurrencyCode | String | False |
The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Currency of the money. | |
| UsagePricingPlanInterval | String | True |
The frequency with which the app usage records are billed. | |
| UsagePricingPlanTerms | String | True |
The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges. |
AppSubscriptions
Lists all subscriptions created for a shop on the installed application.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- AppInstallationId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM AppSubscriptions
SELECT * FROM AppSubscriptions WHERE AppInstallationId = 'Val1'
Insert
Insert statements are mapped to the 'appSubscriptionCreate' GraphQL mutation.
The following columns can be used to create a new record:
Name, Test, ReturnUrl, TrialDays, LineItem
Delete
Delete statements are mapped to the 'appSubscriptionCancel' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| Name | String | True |
The name of the app subscription. | |
| Status | String | True |
The status of the app subscription. | |
| Test | Bool | True |
Specifies whether the app subscription is a test transaction. | |
| ReturnUrl | String | True |
The URL that the merchant is redirected to after approving the app subscription. | |
| TrialDays | Int | True |
The number of free trial days, starting at the subscription's creation date, by which billing is delayed. | |
| CurrentPeriodEnd | Datetime | True |
The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active. | |
| CreatedAt | Datetime | True |
The date and time when the app subscription was created. | |
| LineItemIds | String | True |
The IDs of the plans attached to the app subscription. | |
| LineItem | String | True |
LineItem |
Catalogs
The catalogs belonging to the shop.
Select
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server side:
SELECT * FROM Catalogs
Insert
Insert statements are mapped to the 'catalogCreate' GraphQL mutation.
The following columns can be used to create a new record:
Status, Title, PriceListId, PublicationId
The following pseudo-columns can be used to create a new record:
CompanyLocationIds
Update
Update statements are mapped to the 'catalogUpdate' GraphQL mutation.
The following columns can be updated:
Id, Status, Title, PriceListId, PublicationId
The following pseudo-columns can be updated:
CompanyLocationIds
Delete
Delete statements are mapped to the 'catalogDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the catalog. | |
| Title | String | False |
The name of the catalog. | |
| PriceListId | String | False |
A globally-unique ID. | |
| PublicationId | String | False |
A globally-unique ID. | |
| OperationId | String | True |
A globally-unique ID. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| CompanyLocationIds | String |
The IDs of the company locations to associate to the catalog. |
Collections
Returns a list of collections.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Collections WHERE Id='VALUE'
SELECT * FROM Collections WHERE Title='VALUE'
SELECT * FROM Collections WHERE UpdatedAt<'2000-01-01 01:00:00.0'
UPDATE
UPDATE statements are mapped to the 'collectionUpdate' GraphQL mutation.
The following column can be updated:
SortOrder
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Title | String | True |
The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. | |
| Handle | String | True |
A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title 'Summer Catalog 2022' might have the handle 'summer-catalog-2022'. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. | |
| DescriptionHtml | String | True |
The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. | |
| ProductsCount | Int | True |
The number of products in the collection. | |
| SortOrder | String | False |
The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. | |
| TemplateSuffix | String | True |
The suffix of the Liquid template being used to show the collection in an online store. 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' template. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| PublishedOnCurrentPublication | Bool | True |
Check to see whether the resource is published to the calling app's publication. | |
| UpdatedAt | Datetime | True |
The date and time when the collection was last modified. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| RuleSetAppliedDisjunctively | Bool | True |
Whether products must match any or all of the rules to be included in the collection. If true, then products must match at least one of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection. | |
| SeoTitle | String | True |
SEO Title. | |
| SeoDescription | String | True |
SEO Description. |
Companies
Returns the list of companies in the shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExternalId supports the '=,!=' comparison operators.
- Name supports the '=,!=' comparison operators.
- CustomerSince supports the '=,!=' comparison operators.
- CreatedAt supports the '=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Companies WHERE Id='VALUE'
SELECT * FROM Companies WHERE ExternalId='VALUE'
SELECT * FROM Companies WHERE Name='VALUE'
SELECT * FROM Companies WHERE CustomerSince='2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'companyCreate' GraphQL mutation.
The following columns can be used to create a new record:
ExternalId, Name, Note, CustomerSince
UPDATE
UPDATE statements are mapped to the 'companyUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Note
DELETE
DELETE statements are mapped to the 'companyDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ExternalId | String | False |
A unique externally-supplied ID for the company. | |
| Name | String | False |
The name of the company. | |
| Note | String | False |
A note about the company. | |
| ContactCount | Int | True |
The number of contacts that belong to the company. | |
| CustomerSince | Datetime | True |
The date and time at which the company became the customer. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| LifetimeDuration | String | True |
The lifetime duration of the company, since it became a customer of the shop. Examples: '2 days', '3 months', '1 year'. | |
| LocationCount | Int | True |
The number of locations that belong to the company. | |
| OrderCount | Int | True |
The total number of orders placed for this company, across all its locations. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company. | |
| CreatedAt | Datetime | True |
The date and time at which the company was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company was last modified. | |
| DefaultRoleId | String | True |
A globally-unique ID. | |
| DefaultRoleName | String | True |
The name of a role. For example, 'admin' or 'buyer'. | |
| DefaultRoleNote | String | True |
A note for the role. | |
| MainContactId | String | True |
A globally-unique ID. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
CompanyLocations
Returns a list of locations in the company.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CompanyId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyLocations WHERE CompanyId='VALUE'
Insert
INSERT statements are mapped to the 'companyLocationCreate' GraphQL mutation.
The following columns can be used to create a new record:
CompanyId, ExternalId, TaxRegistrationId, Name, Locale, Note, Phone, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressPhone, BillingAddressRecipient, BillingAddressZip, BillingAddressCountryCode, BillingAddressZoneCode, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressPhone, ShippingAddressRecipient, ShippingAddressZip, ShippingAddressCountryCode, ShippingAddressZoneCode
UPDATE
UPDATE statements are mapped to the 'companyLocationUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Locale, Note, Phone
DELETE
DELETE statements are mapped to the 'companyLocationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| CompanyId | String | True |
Companies.Id |
A globally-unique ID. |
| ExternalId | String | False |
A unique externally-supplied ID for the company location. | |
| TaxRegistrationId | String | True |
The tax registration ID for the company location. | |
| Name | String | False |
The name of the company location. | |
| Currency | String | True |
The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. | |
| Locale | String | False |
The preferred locale of the company location. | |
| Note | String | False |
A note about the company location. | |
| Phone | String | False |
The phone number of the company location. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| OrderCount | Int | True |
The total number of orders placed for the location. | |
| TaxExemptions | String | True |
The list of tax exemptions applied to the location. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company location. | |
| CreatedAt | Datetime | True |
The date and time at which the company location was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time at which the company location was last modified. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCompanyName | String | True |
The name of the company. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| BillingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| BuyerExperienceConfigurationCheckoutToDraft | Bool | True |
Whether to checkout to draft order for merchant review. | |
| BuyerExperienceConfigurationPayNowOnly | Bool | True |
Whether a buyer must pay at checkout or they can also choose to pay later using net terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplateId | String | True |
A globally-unique ID. | |
| BuyerExperienceConfigurationPaymentTermsTemplateName | String | True |
The name of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName | String | True |
The translated payment terms template name. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDescription | String | True |
The description of the payment terms template. | |
| BuyerExperienceConfigurationPaymentTermsTemplateDueInDays | Int | True |
The number of days between the issued date and due date if this is the net type of payment terms. | |
| BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType | String | True |
The type of the payment terms template. | |
| MarketId | String | True |
A globally-unique ID. | |
| ShippingAddressId | String | True |
A globally-unique ID. | |
| ShippingAddressCompanyName | String | True |
The name of the company. | |
| ShippingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | True |
The name of the city, district, village, or town. | |
| ShippingAddressCountry | String | True |
The name of the country. | |
| ShippingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| ShippingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
| ShippingAddressZip | String | True |
The zip or postal code of the address. | |
| ShippingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
| ShippingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
| TotalSpentAmount | Decimal | True |
Decimal money amount. | |
| TotalSpentCurrencyCode | String | True |
Currency of the money. |
Customers
Retrieves a list of customers.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Email supports the '=,!=' comparison operators.
- Phone supports the '=,!=' comparison operators.
- State supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AcceptsMarketing supports the '=,!=' comparison operators.
- AmountSpentAmount supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Customers
SELECT * FROM Customers WHERE Id = 'Val1'
SELECT * FROM Customers WHERE Email = 'Val1'
SELECT * FROM Customers WHERE Phone = 'Val1'
SELECT * FROM Customers WHERE State = 'Val1'
SELECT * FROM Customers WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM Customers WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM Customers WHERE AcceptsMarketing = 123
SELECT * FROM Customers WHERE AmountSpentAmount = 123
Insert
Insert statements are mapped to the 'customerCreate' GraphQL mutation.
The following columns can be used to create a new record:
FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt
Update
Update statements are mapped to the 'customerUpdate' GraphQL mutation.
The following columns can be updated:
Id, FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt
Delete
Delete statements are mapped to the 'customerDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| MultipassIdentifier | String | True |
A unique identifier for the customer that's used with Multipass login. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| ValidEmailAddress | Bool | True |
Whether the email address is formatted correctly. Returns 'true' when the email is formatted correctly and belongs to an existing domain. This doesn't guarantee that the email address actually exists. | |
| DisplayName | String | True |
The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. | |
| FirstName | String | False |
The customer's first name. | |
| LastName | String | False |
The customer's last name. | |
| String | False |
The customer's email address. | ||
| Locale | String | False |
The customer's locale. | |
| Note | String | False |
A note about the customer. | |
| Phone | String | False |
The customer's phone number. | |
| State | String | True |
The state of the customer's account with the shop. | |
| Tags | String | False |
A comma separated list of tags that have been added to the customer. | |
| CanDelete | Bool | True |
Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store. | |
| LifetimeDuration | String | True |
The amount of time since the customer was first added to the store. Example: 'about 12 years'. | |
| TaxExempt | Bool | False |
Whether the customer is exempt from being charged taxes on their orders. | |
| TaxExemptions | String | False |
The list of tax exemptions applied to the customer. | |
| UnsubscribeUrl | String | True |
The URL to unsubscribe the customer from the mailing list. | |
| VerifiedEmail | Bool | True |
Whether the customer has verified their email address. Defaults to 'true' if the customer is created through the Shopify admin or API. | |
| HasTimelineComment | Bool | True |
Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. | |
| NumberOfOrders | String | True |
The number of orders that the customer has made at the store in their lifetime. | |
| ProductSubscriberStatus | String | True |
Possible subscriber states of a customer defined by their subscription contracts. | |
| CreatedAt | Datetime | True |
The date and time when the customer was added to the store. | |
| UpdatedAt | Datetime | True |
The date and time when the customer was last updated. | |
| AcceptsMarketing | Bool | True |
Whether the customer has agreed to receive marketing materials. | |
| AmountSpentAmount | Decimal | True |
Decimal money amount. | |
| AmountSpentCurrencyCode | String | True |
Currency of the money. | |
| DefaultAddressId | String | True |
A globally-unique ID. | |
| DefaultAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DefaultAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DefaultAddressFirstName | String | False |
The first name of the customer. | |
| DefaultAddressLastName | String | False |
The last name of the customer. | |
| DefaultAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| DefaultAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DefaultAddressCity | String | False |
The name of the city, district, village, or town. | |
| DefaultAddressCompany | String | False |
The name of the customer's company or organization. | |
| DefaultAddressCountry | String | False |
The name of the country. | |
| DefaultAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DefaultAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DefaultAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DefaultAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| DefaultAddressZip | String | False |
The zip or postal code of the address. | |
| DefaultAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DefaultAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| DefaultAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| EmailMarketingConsentMarketingState | String | True |
The current email marketing state for the customer. | |
| EmailMarketingConsentMarketingOptInLevel | String | True |
The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email. | |
| EmailMarketingConsentConsentUpdatedAt | Datetime | True |
The date and time at which the customer consented to receive marketing material by email. The customer's consent state reflects the consent record with the most recent 'consent_updated_at' date. If no date is provided, then the date and time at which the consent information was sent is used. | |
| ImageId | String | True |
A unique ID for the image. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| LastOrderId | String | True |
A globally-unique ID. | |
| MarketId | String | True |
A globally-unique ID. | |
| MergeableReason | String | True |
The reason why the customer can't be merged with another customer. | |
| MergeableErrorFields | String | True |
The list of fields preventing the customer from being merged. | |
| MergeableIsMergeable | Bool | True |
Whether the customer can be merged with another customer. | |
| MergeableMergeInProgressJobId | String | True |
The UUID of the merge job. | |
| MergeableMergeInProgressResultingCustomerId | String | True |
The ID of the customer resulting from the merge. | |
| MergeableMergeInProgressStatus | String | True |
The status of the customer merge request. | |
| SmsMarketingConsentMarketingState | String | False |
The current SMS marketing state for the customer. | |
| SmsMarketingConsentConsentCollectedFrom | String | True |
The source from which the SMS marketing information for the customer was collected. | |
| SmsMarketingConsentMarketingOptInLevel | String | False |
The marketing subscription opt-in level that was set when the customer consented to receive marketing information. | |
| SmsMarketingConsentConsentUpdatedAt | Datetime | False |
The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used. | |
| StatisticsPredictedSpendTier | String | True |
The predicted spend tier of a customer with a shop. |
DeliveryProfiles
Returns a list of saved delivery profiles.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- MerchantOwnedOnly supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DeliveryProfiles WHERE Id='VALUE'
SELECT * FROM DeliveryProfiles WHERE MerchantOwnedOnly='true'
Insert
INSERT statements are mapped to the 'deliveryProfileCreate' GraphQL mutation.
The following column can be used to create a new record:
Name
UPDATE
UPDATE statements are mapped to the 'deliveryProfileUpdate' GraphQL mutation.
The following column can be updated:
Name
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Name | String | False |
The name of the delivery profile. | |
| Default | Bool | True |
Whether this is the default profile. | |
| LegacyMode | Bool | True |
Whether this shop has enabled legacy compatibility mode for delivery profiles. | |
| OriginLocationCount | Int | True |
The number of active origin locations for the profile. | |
| ZoneCountryCount | Int | True |
The number of countries with active rates to deliver to. | |
| ActiveMethodDefinitionsCount | Int | True |
The number of active shipping rates for the profile. | |
| LocationsWithoutRatesCount | Int | True |
The number of locations without rates defined. | |
| ProductVariantsCountV2Capped | Bool | True |
Whether the count has reached the cap of 500. | |
| ProductVariantsCountV2Count | Int | True |
The product variant count. | |
| MerchantOwnedOnly | Bool | True |
If 'true', returns only delivery profiles that were created by the merchant. |
DiscountsAutomaticApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticApp WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountAutomaticAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
UPDATE
UPDATE statements are mapped to the 'discountAutomaticAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| UpdatedAt | Datetime | True |
The date and time when the discount was updated. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. |
DiscountsAutomaticBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsAutomaticBasic WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, MinimumQuantity, MinimumSubtotal
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | True |
The minimum quantity of items that's required for the discount to be applied. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| MinimumQuantity | String |
The minimum quantity of items that's required for the discount to be applied. |
| MinimumSubtotal | String |
The minimum subtotal that's required for the discount to be applied. |
DiscountsAutomaticBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Title supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
SELECT * FROM DiscountsAutomaticBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE Status='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsAutomaticBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountAutomaticBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
UPDATE
UPDATE statements are mapped to the 'discountAutomaticBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| AsyncUsageCount | Int | True |
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountQuantityToBuy | String |
The quantity of prerequisite items. |
| DiscountAmountToBuy | String |
The value of the discount. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
DiscountsCodeApp
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
- AppDiscountTypeTitle supports the '=,!=' comparison operators.
- AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeApp WHERE Title='VALUE'
SELECT * FROM DiscountsCodeApp WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeApp WHERE StartsAt<'2000-01-01 01:00:00.0'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeTitle='VALUE'
SELECT * FROM DiscountsCodeApp WHERE AppDiscountTypeDiscountClass='VALUE'
Insert
INSERT statements are mapped to the 'discountCodeAppCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be used to create a new record:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeAppUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, DiscountCustomerAllAllCustomers
The following pseudo-columns can be updated:
Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| DiscountId | String | True |
The ID for the discount. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | True |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| AppDiscountTypeFunctionId | String | False |
The ID of the function providing the app discount type. | |
| AppDiscountTypeTitle | String | True |
The title of the app discount type. | |
| AppDiscountTypeDescription | String | True |
A description of the app discount type. | |
| AppDiscountTypeAppKey | String | True |
The client ID of the app providing the app discount type. | |
| AppDiscountTypeDiscountClass | String | True |
The class of the app discount type. | |
| AppDiscountTypeTargetType | String | True |
The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| ErrorHistoryFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryErrorsFirstOccurredAt | Datetime | True |
The date and time that the first error occurred. | |
| ErrorHistoryHasSharedRecentErrors | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| ErrorHistoryHasBeenSharedSinceLastError | Bool | True |
Whether the merchant has shared all the recent errors with the developer. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBasic
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBasic WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBasic WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBasicCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be used to create a new record:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBasicUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, RecurringCycleLimit, AppliesOncePerCustomer, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts, CustomerGetsAppliesOnSubscription, CustomerGetsAppliesOnOneTimePurchase, DiscountCustomerAllAllCustomers, DiscountMinimumQuantityGreaterThanOrEqualToQuantity
The following pseudo-columns can be updated:
Code, AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | True |
A short summary of the discount. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | False |
The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | False |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | False |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | False |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | False |
The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| AppliesOnEachItem | Bool |
If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. |
| DiscountAmount | Decimal |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DiscountsCodeBxgy
Returns a list of discounts.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBxgy WHERE Title='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeBxgy WHERE StartsAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'discountCodeBxgyCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
UPDATE
UPDATE statements are mapped to the 'discountCodeBxgyUpdate' GraphQL mutation.
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be updated:
Code, DiscountOnQuantity, DiscountPercentage, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsToAdd, ProductsToRemove, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
DELETE
DELETE statements are mapped to the 'discountCodeDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Title | String | False |
The title of the discount. | |
| Status | String | True |
The status of the discount. | |
| Summary | String | True |
A detailed summary of the discount. | |
| CodeCount | Int | True |
The number of redeem codes for the discount. | |
| DiscountClass | String | True |
The class of the discount for combining purposes. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| StartsAt | Datetime | False |
The date and time when the discount starts. | |
| UsageLimit | Int | False |
The maximum number of times that the discount can be used. | |
| AsyncUsageCount | Int | True |
The number of times that the discount has been used. | |
| HasTimelineComment | Bool | True |
Indicates whether there are any timeline comments on the discount. | |
| AppliesOncePerCustomer | Bool | False |
Whether the discount can be applied only once per customer. | |
| UsesPerOrderLimit | Int | False |
The maximum number of times that the discount can be applied to an order. | |
| CreatedAt | Datetime | True |
The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | False |
Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Combines with shipping discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | True |
Whether the discount applies on subscription items. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | True |
Whether the discount applies on regular one-time-purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | True |
Whether the discount can be applied by all customers. This value is always 'true'. | |
| TotalSalesAmount | Decimal | True |
Decimal money amount. | |
| TotalSalesCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Code | String |
The code to use the discount. |
| DiscountOnQuantity | String |
The value of the discount. |
| DiscountPercentage | Double |
The value of the discount. |
| ProductsToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| DiscountAmountToBuy | String |
The value of the discount. |
| DiscountQuantityToBuy | Double |
The quantity of prerequisite items. |
| ProductsBuysToAdd | String |
A simple, comma-separated list of products IDs to add. |
| ProductsBuysToRemove | String |
A simple, comma-separated list of products IDs to remove. |
| AddAllCustomers | Bool |
Whether all customers can use this discount. |
| CustomersToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomersToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
| CustomerSegmentsToAdd | String |
A simple, comma-separated list of customers IDs to add. |
| CustomerSegmentsToRemove | String |
A simple, comma-separated list of customers IDs to remove. |
DraftOrders
Returns a list of saved draft orders.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM DraftOrders
SELECT * FROM DraftOrders WHERE Id = 'Val1'
SELECT * FROM DraftOrders WHERE Status = 'Val1'
SELECT * FROM DraftOrders WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE CustomerId = 'Val1'
Insert
Insert statements are mapped to the 'draftOrderCreate' GraphQL mutation.
The following columns can be used to create a new record:
Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Update
Update statements are mapped to the 'draftOrderUpdate' GraphQL mutation.
The following columns can be updated:
Id, Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Delete
Delete statements are mapped to the 'draftOrderDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Name | String | True |
The identifier for the draft order, which is unique within the store. For example, _#D1223_. | |
| MarketName | String | True |
The name of the selected market. | |
| String | False |
Email address of the customer, which is used to send notifications to. | ||
| Note2 | String | True |
The text from an optional note attached to the draft order. | |
| Phone | String | True |
The phone number assigned to the draft order. | |
| Ready | Bool | True |
Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish. | |
| Status | String | True |
Status of the draft order. | |
| Tags | String | True |
A comma separated list of tags associated with the draft order. Updating 'tags' overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the mutation. | |
| CompletedAt | Datetime | True |
The date and time when the draft order converted to a new order, and the draft order's status changed to **Completed**. | |
| CurrencyCode | String | True |
The three letter code for the currency of the store at the time of the most recent update to the draft order. | |
| DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
| InvoiceUrl | String | True |
The link to the checkout, which is sent to the customer in the invoice email. | |
| SubtotalPrice | Decimal | True |
The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. | |
| TaxExempt | Bool | True |
Whether the draft order is tax exempt. | |
| TaxesIncluded | Bool | True |
Whether the line item prices include taxes. | |
| TotalPrice | Decimal | True |
The total amount of the draft order, including taxes, shipping charges, and discounts. | |
| TotalTax | Decimal | True |
The total amount of taxes for the draft order. | |
| TotalWeight | String | True |
The total weight in grams of the draft order. | |
| HasTimelineComment | Bool | True |
Whether the merchant has added timeline comments to the draft order. | |
| InvoiceSentAt | Datetime | True |
The date and time when the invoice was last emailed to the customer. | |
| PresentmentCurrencyCode | String | True |
The payment currency of the customer for this draft order. | |
| ReserveInventoryUntil | Datetime | True |
The time after which inventory will automatically be restocked. | |
| TotalShippingPrice | Decimal | True |
The total shipping charge for the draft order. | |
| VisibleToCustomer | Bool | True |
Whether the draft order will be visible to the customer on the self-serve portal. | |
| InvoiceEmailTemplateSubject | String | True |
The subject defined for the draft invoice email template. | |
| MarketRegionCountryCode | String | True |
The selected market region country code for the draft order. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CreatedAt | Datetime | True |
The date and time when the draft order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the draft order was last changed. The format is YYYY-MM-DD HH: mm: ss. For example, 2016-02-05 17: 04: 01. | |
| OrderId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | False |
Customers.Id |
Customer who will be sent an invoice for the draft order, if there is one. |
| BillingAddressId | String | False |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | False |
The first name of the customer. | |
| BillingAddressLastName | String | False |
The last name of the customer. | |
| BillingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | False |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | False |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | False |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | False |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| AppliedDiscountTitle | String | False |
Name of the order-level discount. | |
| AppliedDiscountDescription | String | False |
Description of the order-level discount. | |
| AppliedDiscountValue | Double | False |
Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount). | |
| AppliedDiscountValueType | String | False |
Type of the order-level discount. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsOrderId | String | True |
A globally-unique ID. | |
| AppliedDiscountAmountV2Amount | Decimal | False |
Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPricePresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPricePresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| LineItemsSubtotalPriceShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| LineItemsSubtotalPriceShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalLineItemsPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| DraftOrderLineItems | String | False |
The list of the line items in the draft order. |
FulfillmentEvents
Retrieves the history of events associated with one or many fulfillments.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentEvents WHERE FulfillmentId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentEventCreate' GraphQL mutation.
The following columns can be used to create a new record:
FulfillmentId, Status, Address1, City, Country, Latitude, Longitude, Message, Province, Zip, EstimatedDeliveryAt
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| FulfillmentId | String | True |
Fulfillments.Id |
A globally-unique ID. |
| OrderId | String | True |
Orders.Id |
A globally-unique identifier. |
| Status | String | True |
The status of this fulfillment event. | |
| HappenedAt | Datetime | True |
The time at which this fulfillment event happened. | |
| Address1 | String | True |
The street address where this fulfillment event occurred. | |
| City | String | True |
The city where this fulfillment event occurred. | |
| Country | String | True |
The country where this fulfillment event occurred. | |
| Latitude | Double | True |
The latitude where this fulfillment event occurred. | |
| Longitude | Double | True |
The longitude where this fulfillment event occurred. | |
| Message | String | True |
A message associated with this fulfillment event. | |
| Province | String | True |
The province where this fulfillment event occurred. | |
| Zip | String | True |
The zip code of the location where this fulfillment event occurred. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated delivery date and time of the fulfillment. |
FulfillmentOrders
Retrieves a paginated list of merchant-managed and third-party fulfillment orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- AssignedLocationLocationId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM FulfillmentOrders WHERE Id='VALUE'
SELECT * FROM FulfillmentOrders WHERE Status='VALUE'
SELECT * FROM FulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
UPDATE
UPDATE statements are mapped to the 'dynamic_depends_on_status' GraphQL mutation.
The following column can be updated:
Status
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Status | String | False |
The status of the fulfillment order. | |
| FulfillAt | Datetime | True |
The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | True |
The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| OrderName | String | True |
The unique identifier for the order that appears on the order page. | |
| RequestStatus | String | True |
The request status of the fulfillment order. | |
| CreatedAt | Datetime | True |
Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment order was last updated. | |
| OrderProcessedAt | Datetime | True |
The date and time when the fulfillment order was processed at. | |
| AssignedLocationName | String | True |
The name of the location. | |
| AssignedLocationAddress1 | String | True |
The first line of the address for the location. | |
| AssignedLocationAddress2 | String | True |
The second line of the address for the location. | |
| AssignedLocationCity | String | True |
The city of the location. | |
| AssignedLocationPhone | String | True |
The phone number of the location. | |
| AssignedLocationProvince | String | True |
The province of the location. | |
| AssignedLocationZip | String | True |
The ZIP code of the location. | |
| AssignedLocationCountryCode | String | True |
The two-letter country code of the location. | |
| AssignedLocationLocationId | String | True |
A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | True |
The name of the location. | |
| AssignedLocationLocationActivatable | Bool | True |
Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | True |
Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | True |
Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | True |
Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | True |
The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | True |
Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | True |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | True |
Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | True |
Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | True |
Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | True |
A globally-unique ID. | |
| DeliveryMethodMethodType | String | True |
The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | True |
The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | True |
The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | True |
A globally-unique ID. | |
| DestinationFirstName | String | True |
The first name of the customer at the destination. | |
| DestinationLastName | String | True |
The last name of the customer at the destination. | |
| DestinationAddress1 | String | True |
The first line of the address of the destination. | |
| DestinationAddress2 | String | True |
The second line of the address of the destination. | |
| DestinationCity | String | True |
The city of the destination. | |
| DestinationCompany | String | True |
The company of the destination. | |
| DestinationEmail | String | True |
The email of the customer at the destination. | |
| DestinationPhone | String | True |
The phone number of the customer at the destination. | |
| DestinationProvince | String | True |
The province of the destination. | |
| DestinationZip | String | True |
The ZIP code of the destination. | |
| DestinationCountryCode | String | True |
The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | True |
The method of duties payment. Example values: 'DDP', 'DAP'. | |
| OrderId | String | True |
A globally-unique ID. |
Fulfillments
Fulfillment represents a shipment of one or more items in an order.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderIdcolumn, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Fulfillments WHERE OrderId='VALUE'
Insert
INSERT statements are mapped to the 'fulfillmentCreateV2' GraphQL mutation.
The following columns can be used to create a new record:
OriginAddressAddress1, OriginAddressAddress2, OriginAddressCity, OriginAddressCountryCode, OriginAddressProvinceCode, OriginAddressZip, TrackingInfoNumber, TrackingInfoUrl, FulfillmentOrderIds
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Globally unique identifier. | |
| Name | String | True |
Human readable reference identifier for this fulfillment. | |
| Status | String | True |
The status of the fulfillment. | |
| DeliveredAt | Datetime | True |
The date that this fulfillment was delivered. | |
| DisplayStatus | String | True |
Human readable display status for this fulfillment. | |
| RequiresShipping | Bool | True |
Whether any of the line items in the fulfillment require shipping. | |
| TotalQuantity | Int | True |
Sum of all line item quantities for the fulfillment. | |
| EstimatedDeliveryAt | Datetime | True |
The estimated date that this fulfillment will arrive. | |
| InTransitAt | Datetime | True |
The date and time when the fulfillment went into transit. | |
| CreatedAt | Datetime | True |
The date and time when the fulfillment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the fulfillment was last modified. | |
| LocationId | String | True |
A globally-unique ID. | |
| ServiceId | String | True |
The ID of the fulfillment service. | |
| OriginAddressAddress1 | String | True |
The street address of the fulfillment location. | |
| OriginAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| OriginAddressCity | String | True |
The city in which the fulfillment location is located. | |
| OriginAddressCountryCode | String | True |
The country code of the fulfillment location. | |
| OriginAddressProvinceCode | String | True |
The province code of the fulfillment location. | |
| OriginAddressZip | String | True |
The zip code of the fulfillment location. | |
| TrackingInfoNumber | String | True |
TrackingInfoNumber | |
| TrackingInfoUrl | String | True |
TrackingInfoUrl |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| FulfillmentOrderIds | String |
An aggregated object containing the FulfillmentOrder ids. Ex: [{'fulfillmentOrderId': 'gid://shopify/FulfillmentOrder/xxx'}] |
FulfillmentServices
Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'fulfillmentServiceCreate' GraphQL mutation.
The following columns can be used to create a new record:
ServiceName, InventoryManagement, FulfillmentOrdersOptIn, CallbackUrl
UPDATE
UPDATE statements are mapped to the 'fulfillmentServiceUpdate' GraphQL mutation.
The following columns can be updated:
ServiceName, FulfillmentOrdersOptIn, CallbackUrl
DELETE
DELETE statements are mapped to the 'fulfillmentServiceDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the fulfillment service. | |
| ServiceName | String | False |
The name of the fulfillment service as seen by merchants. | |
| Handle | String | True |
Human-readable unique identifier for this fulfillment service. | |
| Type | String | True |
Type associated with the fulfillment service. | |
| CallbackUrl | String | False |
The callback URL the fulfillment service has registered for requests. | |
| InventoryManagement | Bool | True |
Whether the fulfillment service tracks product inventory and provides updates to Shopify. | |
| ProductBased | Bool | True |
Whether the fulfillment service supports local deliveries. | |
| PermitsSkuSharing | Bool | True |
Whether the fulfillment service can stock inventory alongside other locations. | |
| FulfillmentOrdersOptIn | Bool | False |
Whether the fulfillment service has opted into fulfillment order based requests. | |
| LocationId | String | True |
Globally unique identifier. |
FulfillmentTrackingInfo
Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the FulfillmentId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM FulfillmentTrackingInfo WHERE FulfillmentId='VALUE'
UPDATE
UPDATE statements are mapped to the 'fulfillmentTrackingInfoUpdateV2' GraphQL mutation.
The following columns can be updated:
FulfillmentId, Company, Number, Url
Columns
| Name | Type | ReadOnly | References | Description |
| FulfillmentId [KEY] | String | True |
Fulfillments.Id |
The ID of the Fulfillment to return. |
| Company | String | False |
The name of the tracking company. | |
| Number | String | False |
The tracking number of the fulfillment. | |
| Url | String | False |
The URLs to track the fulfillment. |
GiftCards
Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription)
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExpiresOn supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InitialValueAmount supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM GiftCards WHERE Id='VALUE'
SELECT * FROM GiftCards WHERE ExpiresOn<'2000-01-01'
SELECT * FROM GiftCards WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM GiftCards WHERE InitialValueAmount<'100.000000'
Insert
INSERT statements are mapped to the 'giftCardCreate' GraphQL mutation.
The following columns can be used to create a new record:
Note, ExpiresOn, InitialValueAmount, CustomerId
UPDATE
UPDATE statements are mapped to the 'giftCardUpdate' GraphQL mutation.
The following columns can be updated:
Note, ExpiresOn, CustomerId
DELETE
DELETE statements are mapped to the 'giftCardDisable' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Enabled | Bool | True |
Whether the gift card is enabled. | |
| Note | String | False |
The note associated with the gift card, which is not visible to the customer. | |
| DisabledAt | Datetime | True |
The date and time at which the gift card was disabled. | |
| ExpiresOn | Date | False |
The date at which the gift card will expire. | |
| LastCharacters | String | True |
The final four characters of the gift card code. | |
| MaskedCode | String | True |
The gift card code. Everything but the final four characters is masked. | |
| CreatedAt | Datetime | True |
The date and time at which the gift card was created. | |
| BalanceAmount | Decimal | True |
Decimal money amount. | |
| BalanceCurrencyCode | String | True |
Currency of the money. | |
| InitialValueAmount | Decimal | True |
Decimal money amount. | |
| InitialValueCurrencyCode | String | True |
Currency of the money. | |
| CustomerId | String | False |
A globally-unique ID. | |
| OrderId | String | True |
A globally-unique ID. |
InventoryItems
Returns a list of inventory items.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Sku supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM InventoryItems
SELECT * FROM InventoryItems WHERE Id = 'Val1'
SELECT * FROM InventoryItems WHERE Sku = 'Val1'
SELECT * FROM InventoryItems WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM InventoryItems WHERE UpdatedAt = '2023-01-01 11:10:00'
Update
Update statements are mapped to the 'inventoryItemUpdate' GraphQL mutation.
The following columns can be updated:
Id, Tracked, HarmonizedSystemCode, CountryCodeOfOrigin, ProvinceCodeOfOrigin, UnitCostAmount, InventoryItemCountryHarmonizedSystemCodes
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| VariantId | String | True |
A globally-unique ID. | |
| Sku | String | True |
Inventory item SKU. | |
| Tracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| LocationsCount | Int | True |
The number of locations where this inventory item is stocked. | |
| RequiresShipping | Bool | True |
Whether the inventory item requires shipping. | |
| DuplicateSkuCount | Int | True |
The number of inventory items that share the same SKU with this item. | |
| HarmonizedSystemCode | String | False |
The harmonized system code of the item. | |
| InventoryHistoryUrl | String | True |
The URL that points to the inventory history for the item. | |
| CountryCodeOfOrigin | String | False |
The ISO 3166-1 alpha-2 country code of where the item originated from. | |
| ProvinceCodeOfOrigin | String | False |
The ISO 3166-2 alpha-2 province code of where the item originated from. | |
| CreatedAt | Datetime | True |
The date and time when the inventory item was created. | |
| UpdatedAt | Datetime | True |
The date and time when the inventory item was updated. | |
| TrackedEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| TrackedEditableReason | String | True |
The reason the attribute is locked for editing. | |
| UnitCostAmount | Decimal | False |
Decimal money amount. | |
| UnitCostCurrencyCode | String | True |
Currency of the money. | |
| InventoryItemCountryHarmonizedSystemCodes | String | False |
List of country-specific harmonized system codes. |
Locations
Returns a list of active inventory locations.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- IsActive supports the '=,!=' comparison operators.
- AddressAddress1 supports the '=,!=' comparison operators.
- AddressAddress2 supports the '=,!=' comparison operators.
- AddressCity supports the '=,!=' comparison operators.
- AddressCountry supports the '!=' comparison operators.
- AddressProvince supports the '=,!=' comparison operators.
- AddressZip supports the '=,!=' comparison operators.
- IncludeInactive supports the '=,IN' comparison operators.
- IncludeLegacy supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Locations
SELECT * FROM Locations WHERE Id = 'Val1'
SELECT * FROM Locations WHERE Name = 'Val1'
SELECT * FROM Locations WHERE IsActive = 123
SELECT * FROM Locations WHERE AddressAddress1 = 'Val1'
SELECT * FROM Locations WHERE AddressAddress2 = 'Val1'
SELECT * FROM Locations WHERE AddressCity = 'Val1'
SELECT * FROM Locations WHERE AddressCountry != 'Val1'
SELECT * FROM Locations WHERE AddressProvince = 'Val1'
SELECT * FROM Locations WHERE AddressZip = 'Val1'
SELECT * FROM Locations WHERE IncludeInactive = 123
SELECT * FROM Locations WHERE IncludeLegacy = 123
Insert
Insert statements are mapped to the 'locationAdd' GraphQL mutation.
The following columns can be used to create a new record:
Name, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode
Update
Update statements are mapped to the 'locationEdit' GraphQL mutation.
The following columns can be updated:
Id, Name, IsActive, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode
Delete
Delete statements are mapped to the 'locationDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Name | String | False |
The name of the location. | |
| Activatable | Bool | True |
Whether this location can be reactivated. | |
| Deactivatable | Bool | True |
Whether this location can be deactivated. | |
| Deletable | Bool | True |
Whether this location can be deleted. | |
| AddressVerified | Bool | True |
Whether the location address has been verified. | |
| DeactivatedAt | String | True |
The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| IsActive | Bool | False |
Whether the location is active. | |
| ShipsInventory | Bool | True |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| FulfillsOnlineOrders | Bool | False |
Whether this location can fulfill online orders. | |
| HasActiveInventory | Bool | True |
Whether this location has active inventory. | |
| HasUnfulfilledOrders | Bool | True |
Whether this location has orders that need to be fulfilled. | |
| AddressAddress1 | String | False |
The first line of the address for the location. | |
| AddressAddress2 | String | False |
The second line of the address for the location. | |
| AddressCity | String | False |
The city of the location. | |
| AddressCountry | String | True |
The country of the location. | |
| AddressFormatted | String | True |
A formatted version of the address for the location. | |
| AddressLatitude | Double | True |
The latitude coordinates of the location. | |
| AddressLongitude | Double | True |
The longitude coordinates of the location. | |
| AddressPhone | String | False |
The phone number of the location. | |
| AddressProvince | String | True |
The province of the location. | |
| AddressZip | String | False |
The ZIP code of the location. | |
| AddressCountryCode | String | False |
The country code of the location. | |
| AddressProvinceCode | String | False |
The code for the province, state, or district of the address of the location. | |
| FulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| LocalPickupSettingsV2Instructions | String | True |
Additional instructions or information related to the local pickup. | |
| LocalPickupSettingsV2PickupTime | String | True |
The estimated pickup time to show customers at checkout. | |
| IncludeInactive | Bool | True |
If true, also include the locations that are deactivated. | |
| IncludeLegacy | Bool | True |
If true, also include the legacy locations of fulfillment services. |
Metafields
Retrieves a list of metafields that belong to one or many resource IDs.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=' comparison operator.
- OwnerId supports the '=,IN' comparison operators.
- OwnerResource supports the '=' comparison operator.
OwnerResource is a required column, and eligible values include "product","variant","shop","draft_order","order","customer","collection".
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Metafields WHERE OwnerResource = 'product'
SELECT * FROM Metafields WHERE OwnerResource = 'product' AND Id = 'gid://shopify/Metafield/19334473318423'
SELECT * FROM Metafields WHERE OwnerId = 'gid://shopify/ProductVariant/39378393497623' AND OwnerResource = 'variant'
SELECT * FROM Metafields WHERE OwnerId IN ('gid://shopify/ProductVariant/39378393497623', 'gid://shopify/Product/1418248224791') AND OwnerResource = 'variant'
Insert
INSERT statements are mapped to the 'metafieldsSet' GraphQL mutation.
The following columns can be used to create a new record:
Namespace, Key, Value, Type, OwnerId
DELETE
DELETE statements are mapped to the 'metafieldDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique ID of the metafield. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Namespace | String | True |
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. | |
| Key | String | True |
The name of the metafield. | |
| Value | String | True |
The information to be stored as metadata. | |
| Type | String | True |
The metafield's information type. | |
| Description | String | True |
A description of the information that the metafield contains. | |
| OwnerId | String | True |
The ID of the resource that the metafield is attached to. | |
| OwnerResource | String | True |
The type of resource that the metafield is attached to. | |
| CreatedAt | Datetime | True |
The date and time when the metafield was created. | |
| UpdatedAt | Datetime | True |
The date and time when the metafield was last updated. |
Orders
Retrieves a list of orders.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- Email supports the '=,!=' comparison operators.
- Test supports the '=,!=' comparison operators.
- DiscountCode supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- RiskLevel supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
- ConfirmationNumber supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Orders WHERE Id = 'gid://shopify/Order/232220695'
SELECT * FROM Orders WHERE Id IN ('gid://shopify/Order/232220695', 'gid://shopify/Order/23220695')
SELECT * FROM Orders WHERE Name='VALUE'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId != 'gid://shopify/Customer/3514040471'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Test = true
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel = 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND RiskLevel != 'LOW'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email = '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND Email != '[email protected]'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode = 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND DiscountCode != 'BlackFriday'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt = '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt != '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt <= '2022-01-18 02:32:26.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND UpdatedAt >= '2022-01-18 02:32:26.0' AND UpdatedAt <= '2022-05-10 07:52:22.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND ProcessedAt >= '2017-09-19 06:10:39.0' AND ProcessedAt <= '2021-10-07 23:45:38.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt = '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt != '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt <= '2017-09-19 06:10:39.0'
SELECT * FROM Orders WHERE CustomerId = 'gid://shopify/Customer/3514040471' AND CreatedAt >= '2017-09-19 06:10:39.0' AND CreatedAt <= '2021-10-07 23:45:38.0'
SELECT * FROM Orders where ConfirmationNumber = 'TCIIRW5FL'
UPDATE
UPDATE statements are mapped to the 'orderUpdate' GraphQL mutation.
The following columns can be updated:
Email, Note, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Unpaid | Bool | True |
Whether no payments have been made for the order. | |
| FullyPaid | Bool | True |
Whether the order has been paid in full. | |
| SourceIdentifier | String | True |
A unique POS or third party order identifier. For example, '1234-12-1000' or '111-98567-54'. The 'receipt_number' field is derived from this value for POS orders. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| CanMarkAsPaid | Bool | True |
Whether the order can be manually marked as paid. | |
| Name | String | True |
The unique identifier for the order that appears on the order page in the Shopify admin and the order status page. For example, '#1001', 'EN1001', or '1001-A'. This value isn't unique across multiple stores. | |
| PaymentGatewayNames | String | True |
A list of the names of all payment gateways used for the order. For example, 'Shopify Payments' and 'Cash on Delivery (COD)'. | |
| Capturable | Bool | True |
Whether payment for the order can be captured. | |
| Closed | Bool | True |
Whether the order is closed. | |
| Confirmed | Bool | True |
Whether inventory has been reserved for the order. | |
| Edited | Bool | True |
Whether the order has had any edits applied. | |
| String | False |
The email address associated with the customer. | ||
| Fulfillable | Bool | True |
Whether there are line items that can be fulfilled. This field returns 'false' when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the object. | |
| Note | String | False |
The contents of the note associated with the order. | |
| Phone | String | True |
The phone number associated with the customer. | |
| Refundable | Bool | True |
Whether the order can be refunded. | |
| Restockable | Bool | True |
Whether any line item on the order can be restocked. | |
| Tags | String | True |
A comma separated list of tags associated with the order. Updating 'tags' overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the mutation. | |
| Test | Bool | True |
Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order cannot be converted into a real order and vice versa. | |
| CancelReason | String | True |
The reason provided when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| CancelledAt | Datetime | True |
The date and time when the order was canceled. Returns 'null' if the order wasn't canceled. | |
| ClientIp | String | True |
The IP address of the API client that created the order. | |
| ClosedAt | Datetime | True |
The date and time when the order was closed. Returns 'null' if the order is not closed. | |
| ConfirmationNumber | String | True |
A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, XPAV284CT, R50KELTJP or 35PKUN0UJ. This value isn't guaranteed to be unique. | |
| CurrencyCode | String | True |
The shop currency when the order was placed. | |
| CustomerLocale | String | True |
A two-letter or three-letter language code, optionally followed by a region modifier. | |
| DiscountCode | String | True |
The discount code used for the order. | |
| DiscountCodes | String | True |
The discount codes used for the order. | |
| EstimatedTaxes | Bool | True |
Whether taxes on the order are estimated. This field returns 'false' when taxes on the order are finalized and aren't subject to any changes. | |
| MerchantEditable | Bool | True |
Whether the order can be edited by the merchant. For example, canceled orders can't be edited. | |
| ProcessedAt | Datetime | True |
The date and time when the order was processed. This date and time might not match the date and time when the order was created. | |
| RequiresShipping | Bool | True |
Whether the order has shipping lines or at least one line item on the order that requires shipping. | |
| ReturnStatus | String | True |
The order's aggregated return status for display purposes. | |
| RiskLevel | String | True |
The fraud risk level of the order. | |
| TaxesIncluded | Bool | True |
Whether taxes are included in the subtotal price of the order. | |
| TotalWeight | String | True |
The total weight of the order before returns, in grams. | |
| CanNotifyCustomer | Bool | True |
Whether a customer email exists for the order. | |
| CurrentTotalWeight | String | True |
The total weight of the order after returns, in grams. | |
| CustomerAcceptsMarketing | Bool | True |
Whether the customer agreed to receive marketing materials. | |
| DisplayFinancialStatus | String | True |
The financial status of the order that can be shown to the merchant. This field does not capture all the details of an order's financial state. It should only be used for display summary purposes. | |
| DisplayFulfillmentStatus | String | True |
The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the object. | |
| HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the order. | |
| MerchantEditableErrors | String | True |
A list of reasons why the order can't be edited. For example, 'Canceled orders can't be edited'. | |
| PresentmentCurrencyCode | String | True |
The payment 'CurrencyCode' of the customer for the order. | |
| RegisteredSourceUrl | String | True |
The URL of the source that the order originated from, if found in the domain registry. | |
| SubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's subtotal price. | |
| BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
| CurrentSubtotalLineItemsQuantity | Int | True |
The sum of the quantities for all line items that contribute to the order's current subtotal price. | |
| CreatedAt | Datetime | True |
Date and time when the order was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the order was modified last. | |
| AppId | String | True |
The application ID. | |
| MerchantOfRecordAppId | String | True |
The application ID. | |
| PhysicalLocationId | String | True |
A globally-unique ID. | |
| ChannelInformationId | String | True |
A globally-unique ID. | |
| ChannelInformationChannelId | String | True |
The unique ID for the channel. | |
| ChannelInformationAppId | String | True |
A globally-unique ID. | |
| PublicationId | String | True |
A globally-unique ID. | |
| PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
| PurchasingEntityCompanyId | String | True |
A globally-unique ID. | |
| CustomerId | String | True |
A globally-unique ID. | |
| CustomerFirstName | String | True |
The customer's first name. | |
| CustomerLastName | String | True |
The customer's last name. | |
| CustomerJourneySummaryReady | Bool | True |
Whether the attributed sessions for the order have been created yet. | |
| CustomerJourneySummaryMomentsCount | Int | True |
The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. | |
| CustomerJourneySummaryCustomerOrderIndex | Int | True |
The position of the current order within the customer's order history. Test orders aren't included. | |
| CustomerJourneySummaryDaysToConversion | Int | True |
The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. | |
| CustomerJourneySummaryFirstVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryFirstVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryFirstVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryFirstVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryFirstVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryFirstVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryFirstVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryFirstVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryFirstVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryFirstVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| CustomerJourneySummaryLastVisitId | String | True |
A globally-unique ID. | |
| CustomerJourneySummaryLastVisitSource | String | True |
Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
| CustomerJourneySummaryLastVisitLandingPage | String | True |
URL of the first page the customer landed on for the session. | |
| CustomerJourneySummaryLastVisitOccurredAt | Datetime | True |
The date and time when the customer's session occurred. | |
| CustomerJourneySummaryLastVisitReferralCode | String | True |
Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
| CustomerJourneySummaryLastVisitReferrerUrl | String | True |
Webpage where the customer clicked a link that sent them to the online store. For example, _https: //randomblog. com/page1_ or _android-app: //com. google. android. gm_. | |
| CustomerJourneySummaryLastVisitSourceDescription | String | True |
Describes the source explicitly for first or last session. | |
| CustomerJourneySummaryLastVisitSourceType | String | True |
Type of marketing tactic. | |
| CustomerJourneySummaryLastVisitLandingPageHtml | String | True |
Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1. | |
| CustomerJourneySummaryLastVisitReferralInfoHtml | String | True |
Referral information with URLs linked in HTML. | |
| DisplayAddressId | String | True |
A globally-unique ID. | |
| DisplayAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| DisplayAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| DisplayAddressFirstName | String | True |
The first name of the customer. | |
| DisplayAddressLastName | String | True |
The last name of the customer. | |
| DisplayAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| DisplayAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| DisplayAddressCity | String | True |
The name of the city, district, village, or town. | |
| DisplayAddressCompany | String | True |
The name of the customer's company or organization. | |
| DisplayAddressCountry | String | True |
The name of the country. | |
| DisplayAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| DisplayAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| DisplayAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| DisplayAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| DisplayAddressZip | String | True |
The zip or postal code of the address. | |
| DisplayAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| DisplayAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| DisplayAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| BillingAddressId | String | True |
A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| BillingAddressFirstName | String | True |
The first name of the customer. | |
| BillingAddressLastName | String | True |
The last name of the customer. | |
| BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
| BillingAddressCompany | String | True |
The name of the customer's company or organization. | |
| BillingAddressCountry | String | True |
The name of the country. | |
| BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | True |
The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | True |
The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | True |
The two-letter code for the country of the address. For example, US. | |
| ShippingAddressId | String | False |
A globally-unique ID. | |
| ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
| ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
| ShippingAddressFirstName | String | False |
The first name of the customer. | |
| ShippingAddressLastName | String | False |
The last name of the customer. | |
| ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
| ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
| ShippingAddressCountry | String | False |
The name of the country. | |
| ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
| ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
| ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
| ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
| ShippingAddressZip | String | False |
The zip or postal code of the address. | |
| ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
| ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
| ShippingLineId | String | True |
A globally-unique ID. | |
| ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
| ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
| ShippingLineCode | String | True |
A reference to the shipping method. | |
| ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
| ShippingLinePhone | String | True |
The phone number at the shipping address. | |
| ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
| ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
| ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
| ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
| PaymentTermsId | String | True |
A globally-unique ID. | |
| PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
| PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
| PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
| PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
| PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
| PaymentTermsDraftOrderId | String | True |
A globally-unique ID. | |
| CartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| ChannelInformationChannelDefinitionId | String | True |
The unique ID for the channel definition. | |
| CurrentCartDiscountAmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentCartDiscountAmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentCartDiscountAmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentSubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentSubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| CurrentTotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| CurrentTotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| NetPaymentSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| NetPaymentSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalAdditionalFeesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalAdditionalFeesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalDutiesSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalDutiesSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| OriginalTotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| OriginalTotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| PaymentCollectionDetailsAdditionalPaymentCollectionUrl | String | True |
The URL to use for collecting an additional payment on the order. | |
| RefundDiscrepancySetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| RefundDiscrepancySetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| RefundDiscrepancySetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalCapturableSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalCapturableSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalOutstandingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalOutstandingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedShippingSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedShippingSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalTipReceivedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalTipReceivedSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
OrderTransactions
Retrieves the transactions associated with the resource.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTransactions WHERE ResourceId='VALUE'
Insert
INSERT statements are mapped to the 'orderCapture' GraphQL mutation.
The following columns can be used to create a new record:
ResourceId, ParentTransactionId, Amount, Currency
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ResourceId [KEY] | String | True |
Orders.Id |
A globally-unique ID. |
| PaymentId | String | True |
The payment ID associated with the transaction. | |
| ParentTransactionId | String | True |
The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | True |
The masked account number associated with the payment method. | |
| Gateway | String | True |
The payment gateway used to process the transaction. | |
| Kind | String | True |
The kind of transaction. | |
| Status | String | True |
The status of this transaction. | |
| Test | Bool | True |
Whether the transaction is a test transaction. | |
| AuthorizationCode | String | True |
Authorization code associated with the transaction. | |
| ErrorCode | String | True |
A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | True |
The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | True |
Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | True |
Date and time when the transaction was processed. | |
| ReceiptJson | String | True |
The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | True |
The settlement currency. | |
| AuthorizationExpiresAt | Datetime | True |
The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | True |
The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | True |
Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | True |
The holder of the credit card. | |
| CardPaymentDetailsBin | String | True |
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. | |
| CardPaymentDetailsCompany | String | True |
The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | True |
The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | True |
Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | True |
The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | True |
The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | True |
The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | True |
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. | |
| PaymentIconId | String | True |
A unique ID for the image. | |
| PaymentIconWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | True |
Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | True |
Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | True |
The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | True |
The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | True |
The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | True |
Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Amount | Decimal |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
| Currency | String |
The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
PriceLists
All price lists for a shop.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM PriceLists
SELECT * FROM PriceLists WHERE Id = 'Val1'
Insert
Insert statements are mapped to the 'priceListCreate' GraphQL mutation.
The following columns can be used to create a new record:
Currency, Name, ParentAdjustmentType, ParentAdjustmentValue, ParentSettingsCompareAtMode
Update
Update statements are mapped to the 'priceListUpdate' GraphQL mutation.
The following columns can be updated:
Id, Currency, Name, ParentAdjustmentType, ParentAdjustmentValue, ParentSettingsCompareAtMode
Delete
Delete statements are mapped to the 'priceListDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| Currency | String | False |
The currency for fixed prices associated with this price list. | |
| FixedPricesCount | Int | True |
The number of fixed prices on the price list. | |
| Name | String | False |
The unique name of the price list, used as a human-readable identifier. | |
| ParentAdjustmentType | String | False |
The type of price adjustment, such as percentage increase or decrease. | |
| ParentAdjustmentValue | Double | False |
The value of price adjustment, where positive numbers reduce the prices and negative numbers increase them. | |
| ParentSettingsCompareAtMode | String | False |
The type of price list adjustment setting for compare at price. |
ProductImages
Returns the images associated with the product.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- ProductId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM ProductImages
SELECT * FROM ProductImages WHERE ProductId = 'Val1'
Insert
Insert statements are mapped to the 'productAppendImages' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, AltText, Url
Update
Update statements are mapped to the 'productImageUpdate' GraphQL mutation.
The following columns can be updated:
Id, ProductId, AltText, Url
Delete
Delete statements are mapped to the 'productDeleteImages' GraphQL mutation.
You can delete entries by specifying the Id and ProductId
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the image. | |
| ProductId [KEY] | String | True |
Products.Id |
A globally-unique identifier. |
| AltText | String | False |
A word or phrase to share the nature or contents of an image. | |
| Height | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Width | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| Url | String | False |
The location of the image as a URL. |
ProductResourceFeedbacks
Returns the product resource feedback for the currently authenticated app.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductResourceFeedbacks WHERE Id='VALUE'
Insert
INSERT statements are mapped to the 'bulkProductResourceFeedbackCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, FeedbackGeneratedAt, Messages, ProductUpdatedAt, State
Columns
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | String | True |
Products.Id |
The product associated with the resource feedback. |
| FeedbackGeneratedAt | Datetime | True |
The time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback. | |
| Messages | String | True |
The feedback messages presented to the merchant. | |
| ProductUpdatedAt | Datetime | True |
The timestamp of the product associated with the feedback. | |
| State | String | True |
Conveys the state of the feedback and whether it requires merchant action or not. |
Products
Returns a list of products.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- ProductType supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- Vendor supports the '=,!=' comparison operators.
- TotalInventory supports the '=,!=,<,>,>=,<=' comparison operators.
- HasOnlyDefaultVariant supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Products WHERE Id='VALUE'
SELECT * FROM Products WHERE Title='VALUE'
SELECT * FROM Products WHERE ProductType='VALUE'
SELECT * FROM Products WHERE Status='VALUE'
SELECT * FROM Products WHERE Vendor='VALUE'
SELECT * FROM Products WHERE TotalInventory<'100'
SELECT * FROM Products WHERE HasOnlyDefaultVariant='true'
SELECT * FROM Products WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Products WHERE CreatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'productCreate' GraphQL mutation.
The following columns can be used to create a new record:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, IsGiftCard, SeoTitle, SeoDescription
The following pseudo-columns can be used to create a new record:
VariantPrice, VariantTaxable, VariantRequiresShipping
UPDATE
UPDATE statements are mapped to the 'productUpdate' GraphQL mutation.
The following columns can be updated:
DescriptionHtml, Title, Handle, ProductType, Tags, Status, Vendor, RequiresSellingPlan, GiftCardTemplateSuffix, SeoTitle, SeoDescription
The following pseudo-columns can be updated:
VariantPrice, VariantTaxable, VariantRequiresShipping
DELETE
DELETE statements are mapped to the 'productDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| Description | String | True |
The description of the product, complete with HTML formatting. | |
| DescriptionHtml | String | False |
The description of the product, complete with HTML formatting. | |
| Title | String | False |
The title of the product. | |
| Handle | String | False |
A unique human-friendly string of the product's title. | |
| ProductType | String | False |
The product type specified by the merchant. | |
| Tags | String | False |
A comma separated list of tags associated with the product. Updating 'tags' overwrites any existing tags that were previously added to the product. | |
| Status | String | False |
The product status. This controls visibility across all channels. | |
| Vendor | String | False |
The name of the product's vendor. | |
| OnlineStorePreviewUrl | String | True |
The online store preview URL. | |
| OnlineStoreUrl | String | True |
The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel. | |
| RequiresSellingPlan | Bool | False |
Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription ('requiresSellingPlan: true') can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store. | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product. | |
| TracksInventory | Bool | True |
Whether inventory tracking has been enabled for the product. | |
| TotalInventory | Int | True |
The quantity of inventory in stock. | |
| HasOnlyDefaultVariant | Bool | True |
Whether the product has only a single variant with the default option and value. | |
| HasOutOfStockVariants | Bool | True |
Whether the product has out of stock variants. | |
| TotalVariants | Int | True |
The number of variants that are associated with the product. | |
| TemplateSuffix | String | True |
The theme template used when viewing the product in a store. | |
| GiftCardTemplateSuffix | String | False |
The theme template used when viewing the gift card in a store. | |
| IsGiftCard | Bool | True |
Whether the product is a gift card. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store. | |
| AvailablePublicationCount | Int | True |
The number of publications a resource is published to without feedback errors. | |
| UpdatedAt | Datetime | True |
The date and time when the product was last modified.A product's 'updatedAt' value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. | |
| CreatedAt | Datetime | True |
The date and time when the product was created. | |
| FeedbackSummary | String | True |
Summary of resource feedback pertaining to the resource. | |
| PriceRangeMaxVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMaxVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| PriceRangeMinVariantPriceAmount | Decimal | True |
Decimal money amount. | |
| PriceRangeMinVariantPriceCurrencyCode | String | True |
Currency of the money. | |
| SeoTitle | String | False |
SEO Title. | |
| SeoDescription | String | False |
SEO Description. | |
| MediaCount | Int | True |
Total count of media belonging to a product. | |
| FeaturedImageId | String | True |
A unique identifier for the image. | |
| FeaturedImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| FeaturedImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageUrl | String | True |
The location of the image as a URL. | |
| ResourcePublicationOnCurrentPublicationIsPublished | Bool | True |
Whether the resource publication is published. If true, then the resource publication is published to the publication. If false, then the resource publication is staged to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublishDate | Datetime | True |
The date that the resource publication was or is going to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationId | String | True |
A globally-unique identifier. | |
| ResourcePublicationOnCurrentPublicationPublicationName | String | True |
Name of the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| ProductCategoryProductTaxonomyNodeId | String | True |
The ID of the product taxonomy node. | |
| ProductCategoryProductTaxonomyNodeName | String | True |
The name of the product taxonomy node. For example, Dog Beds. | |
| ProductCategoryProductTaxonomyNodeFullName | String | True |
The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. | |
| ProductCategoryProductTaxonomyNodeIsLeaf | Bool | True |
Whether the node is a leaf node. | |
| ProductCategoryProductTaxonomyNodeIsRoot | Bool | True |
Whether the node is a root node. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| VariantPrice | Double |
The price of the variant. |
| VariantTaxable | Bool |
Whether the variant is taxable. |
| VariantRequiresShipping | Bool |
Whether the variant requires shipping. |
ProductVariants
Returns a list of the product variants.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ProductId supports the '=,!=' comparison operators.
- Title supports the '=,!=' comparison operators.
- Barcode supports the '=,!=' comparison operators.
- Sku supports the '=,!=' comparison operators.
- Taxable supports the '=,!=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InventoryQuantity supports the '=,!=,<,>,>=,<=' comparison operators.
- DeliveryProfileId supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ProductVariants WHERE Id = 'gid://shopify/ProductVariant/6788079091735'
SELECT * FROM ProductVariants WHERE Id IN ('gid://shopify/ProductVariant/6830135181335', 'gid://ProductVariant/Product/6830135181336')
SELECT * FROM ProductVariants WHERE ProductId='VALUE'
SELECT * FROM ProductVariants WHERE Title='VALUE'
SELECT * FROM ProductVariants WHERE Barcode='VALUE'
SELECT * FROM ProductVariants WHERE Sku='VALUE'
SELECT * FROM ProductVariants WHERE Taxable='true'
SELECT * FROM ProductVariants WHERE UpdatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM ProductVariants WHERE InventoryQuantity<'100'
SELECT * FROM ProductVariants WHERE DeliveryProfileId='VALUE'
Insert
INSERT statements are mapped to the 'productVariantCreate' GraphQL mutation.
The following columns can be used to create a new record:
ProductId, Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
UPDATE
UPDATE statements are mapped to the 'productVariantUpdate' GraphQL mutation.
The following columns can be updated:
Position, Price, CompareAtPrice, Barcode, Weight, WeightUnit, Sku, Taxable, TaxCode, InventoryPolicy, InventoryItemTracked, ImageId, Options
DELETE
DELETE statements are mapped to the 'productVariantDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique identifier. | |
| LegacyResourceId | Long | True |
The ID of the corresponding resource in the REST Admin API. | |
| ProductId | String | True |
Products.Id |
A globally-unique identifier. |
| Position | Int | False |
The order of the product variant in the list of product variants. The first position in the list is 1. | |
| AvailableForSale | Bool | True |
Whether the product variant is available for sale. | |
| SellableOnlineQuantity | Int | True |
The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture (limitations based on customer location). | |
| SellingPlanGroupCount | Int | True |
Count of selling plan groups associated with the product variant. | |
| Price | Decimal | False |
The price of the product variant in the default shop currency. | |
| CompareAtPrice | Decimal | False |
The compare-at price of the variant in the default shop currency. | |
| DisplayName | String | True |
Display name of the variant, based on product's title + variant's title. | |
| Barcode | String | False |
The value of the barcode associated with the product. | |
| Weight | Double | False |
The weight of the product variant in the unit system specified with weight_unit. | |
| WeightUnit | String | False |
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', 'lb'. | |
| Sku | String | False |
An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. | |
| Title | String | False |
The title of the product variant. | |
| Taxable | Bool | False |
Whether a tax is charged when the product variant is sold. | |
| TaxCode | String | False |
The tax code for the product variant. | |
| UpdatedAt | Datetime | True |
The date and time when the product variant was last modified. | |
| CreatedAt | Datetime | True |
The date and time when the variant was created. | |
| InventoryPolicy | String | False |
Whether customers are allowed to place an order for the product variant when it's out of stock. | |
| InventoryQuantity | Int | True |
The total sellable quantity of the variant. | |
| InventoryItemId | String | True |
A globally-unique identifier. | |
| InventoryItemTracked | Bool | False |
Whether inventory levels are tracked for the item. | |
| ImageId | String | False |
A unique identifier for the image. | |
| ImageAltText | String | True |
A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | True |
The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageWidth | Int | True |
The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | True |
The location of the image as a URL. | |
| DeliveryProfileId | String | True |
A globally-unique identifier. | |
| FulfillmentServiceEditableLocked | Bool | True |
Whether the attribute is locked for editing. | |
| FulfillmentServiceEditableReason | String | True |
The reason the attribute is locked for editing. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| Options | String |
The custom properties that a shop owner uses to define product variants. |
Publications
Returns the list of publications.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- CatalogType supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Publications WHERE Id='VALUE'
SELECT * FROM Publications WHERE CatalogType='VALUE'
Insert
INSERT statements are mapped to the 'publicationCreate' GraphQL mutation.
The following columns can be used to create a new record:
AutoPublish, CatalogId, DefaultState
UPDATE
UPDATE statements are mapped to the 'publicationUpdate' GraphQL mutation.
The following columns can be updated:
AutoPublish, PublishablesToAdd, PublishablesToRemove
DELETE
DELETE statements are mapped to the 'publicationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AutoPublish | Bool | False |
Whether new products are automatically published to this publication. | |
| SupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| CatalogId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationStatus | String | True |
The status of this operation. | |
| AddAllProductsOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| AddAllProductsOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| AddAllProductsOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogCsvOperationId | String | True |
A globally-unique ID. | |
| CatalogCsvOperationStatus | String | True |
The status of this operation. | |
| CatalogCsvOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| CatalogCsvOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| CatalogCsvOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| PublicationResourceOperationId | String | True |
A globally-unique ID. | |
| PublicationResourceOperationStatus | String | True |
The status of this operation. | |
| PublicationResourceOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| PublicationResourceOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| PublicationResourceOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogType | String | True |
Filter publications by catalog type. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| DefaultState | String |
Whether to create an empty publication or prepopulate it with all products. |
| PublishablesToAdd | String |
A simple, comma-separated list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50. |
| PublishablesToRemove | String |
A simple, comma-separated list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50. |
Refunds
Represents a refund of items or transactions in an order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrderId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Refunds
SELECT * FROM Refunds WHERE OrderId = 'Val1'
Insert
Insert statements are mapped to the 'refundCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrderId, Note, RefundLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| OrderId | String | True |
Orders.Id |
A globally-unique ID. |
| Note | String | True |
The optional note associated with the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| UpdatedAt | Datetime | True |
The date and time when the refund was updated. | |
| ReturnId | String | True |
A globally-unique ID. | |
| TotalRefundedSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
| TotalRefundedSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
| TotalRefundedSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
| RefundLineItems | String | True |
The list of the line items in the draft order. |
Returns
Retrieves a list of returns for the order.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- OrdersId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Returns
SELECT * FROM Returns WHERE OrdersId = 'Val1'
Insert
Insert statements are mapped to the 'returnCreate' GraphQL mutation.
The following columns can be used to create a new record:
OrdersId, ReturnLineItems
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| OrdersId | String | True |
Orders.Id |
A globally-unique ID. |
| Name | String | True |
The name of the return. | |
| Status | String | True |
The status of the return. | |
| TotalQuantity | Int | True |
The sum of all line item quantities for the return. | |
| DeclineReason | String | True |
The reason the customer's return request was declined. | |
| DeclineNote | String | True |
The notification message sent to the customer about their declined return request. Maximum length: 500 characters. | |
| ReturnLineItems | String | True |
The list of the line items in the return. |
ScriptTags
Returns a list of script tags.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Src supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ScriptTags WHERE Id='VALUE'
SELECT * FROM ScriptTags WHERE Src='VALUE'
Insert
INSERT statements are mapped to the 'scriptTagCreate' GraphQL mutation.
The following columns can be used to create a new record:
Cache, Src, DisplayScope
UPDATE
UPDATE statements are mapped to the 'scriptTagUpdate' GraphQL mutation.
The following columns can be updated:
Cache, Src, DisplayScope
DELETE
DELETE statements are mapped to the 'scriptTagDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
| Cache | Bool | False |
Whether the Shopify CDN can cache and serve the script tag. If 'true', then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If 'false', then the script will be served as is. | |
| Src | String | False |
The URL to the remote script. | |
| DisplayScope | String | False |
The page or pages on the online store that the script should be included. | |
| CreatedAt | Datetime | True |
The date and time when the script tag was created. | |
| UpdatedAt | Datetime | True |
The date and time when the script tag was last updated. |
SellingPlanGroups
Returns a list Selling Plan Groups.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- CreatedAt supports the '<,>,>=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM SellingPlanGroups
SELECT * FROM SellingPlanGroups WHERE Id = 'Val1'
SELECT * FROM SellingPlanGroups WHERE Name = 'Val1'
SELECT * FROM SellingPlanGroups WHERE CreatedAt < '2023-01-01 11:10:00'
Insert
Insert statements are mapped to the 'sellingPlanGroupCreate' GraphQL mutation.
The following columns can be used to create a new record:
AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate
The following pseudo-columns can be used to create a new record:
ProductIds, ProductVariantIds
Update
Update statements are mapped to the 'sellingPlanGroupUpdate' GraphQL mutation.
The following columns can be updated:
Id, AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate, SellingPlansToUpdate
The following pseudo-columns can be updated:
SellingPlansToDelete
Delete
Delete statements are mapped to the 'sellingPlanGroupDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppId | String | False |
The ID for app, exposed in Liquid and product JSON. | |
| Name | String | False |
The buyer-facing label of the selling plan group. | |
| Description | String | False |
The merchant-facing description of the selling plan group. | |
| Options | String | False |
The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | False |
The relative position of the selling plan group for display. | |
| Summary | String | True |
A summary of the policies associated to the selling plan group. | |
| MerchantCode | String | False |
The merchant-facing label of the selling plan group. | |
| ProductCount | Int | True |
A count of products associated to the selling plan group. | |
| CreatedAt | Datetime | True |
The date and time when the selling plan group was created. | |
| SellingPlansToCreate | String | False |
List of selling plans to create. | |
| SellingPlansToUpdate | String | False |
List of selling plans to update. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description |
| SellingPlansToDelete | String |
List of selling plans to delete as a simple, comma-separated list. |
| ProductIds | String |
The IDs of the Products to add to the Selling Plan Group as a simple, comma-separated list. |
| ProductVariantIds | String |
The IDs of the Variants to add to the Selling Plan Group as a simple, comma-separated list. |
StorefrontAccessTokens
Retrieves the storefront access token of a private application. These are scoped per-application.
Table-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Insert
INSERT statements are mapped to the 'storefrontAccessTokenCreate' GraphQL mutation.
The following columns can be used to create a new record:
Title
DELETE
DELETE statements are mapped to the 'storefrontAccessTokenDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| ShopId | String | True |
Shop.Id |
A globally-unique ID. |
| Title | String | True |
An arbitrary title for each token determined by the developer, used for reference purposes. | |
| AccessToken | String | True |
The issued public access token. | |
| CreatedAt | Datetime | True |
The date and time when the public access token was created. | |
| UpdatedAt | Datetime | True |
The date and time when the storefront access token was updated. |
UrlRedirects
Returns a list of redirects for a shop.
Table-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Path supports the '=,!=' comparison operators.
- Target supports the '=,!=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM UrlRedirects WHERE Id='VALUE'
SELECT * FROM UrlRedirects WHERE Path='VALUE'
SELECT * FROM UrlRedirects WHERE Target='VALUE'
Insert
INSERT statements are mapped to the 'urlRedirectCreate' GraphQL mutation.
The following columns can be used to create a new record:
Path, Target
UPDATE
UPDATE statements are mapped to the 'urlRedirectUpdate' GraphQL mutation.
The following columns can be updated:
Path, Target
DELETE
DELETE statements are mapped to the 'urlRedirectDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the URL redirect. | |
| Path | String | False |
The old path to be redirected from. When the user visits this path, they will be redirected to the target location. | |
| Target | String | False |
The target location where the user will be redirected to. |
ビュー
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Shopify Connector for CData Sync ビュー
| Name | Description |
| Abandonment | Returns abandonment. |
| AbandonmentProductsAddedToCart | Returns the products added to the cart during the customer abandoned visit. |
| AbandonmentProductsViewed | Returns the products viewed during the customer abandoned visit. |
| AppCredits | Lists credits that can be used towards future app purchases. |
| ArticleComments | Returns a list of comments posted on an article. |
| Articles | Returns a list of the shop's visible articles. |
| AssignedFulfillmentOrders | Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default. |
| Blogs | Retrieves a list of the shop's blogs. |
| CarrierServices | Returns a list of activated carrier services and associated shop locations that support them. |
| CollectionProducts | Retrieves a list of the products inside of a collection. |
| CompanyEvents | Retrieves a paginated list of events associated with the host subject. |
| CustomerEvents | Retrieves a paginated list of events associated with the host subject. |
| DeliveryProfileLocationGroupCountries | Lists countries already selected in any zone for the specified location group. |
| DeliveryProfileLocationGroupCountryProvinces | Returns the list of regions associated with this country. |
| DeliveryProfileLocationGroups | Lists the location groups using this profile. |
| DeliveryProfileLocationGroupZones | Lists the applicable zones associated to the specified location group. |
| DeliveryProfileUnassignedLocations | Lists the locations that have not been assigned to a location group for this profile. |
| DiscountEvents | Retrieves a paginated list of events associated with the host subject. |
| DiscountsCodeFreeShipping | Returns a list of discounts. |
| DraftOrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderEvents | Retrieves a paginated list of events associated with the host subject. |
| DraftOrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| DraftOrderLineItems | Returns a list of the line items in the draft order. |
| DraftOrderLineItemTaxLines | Represents a single tax applied to the associated resource. |
| DraftOrderTaxLines | Represents a single tax applied to the associated resource. |
| InventoryItemCountryHarmonizedSystemCodes | Returns a list of country specific harmonized system codes. |
| InventoryItemInventoryLevels | Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at. |
| Jobs | Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. |
| MarketingEvents | Returns a list of marketing events associated with the marketing app. |
| MetaobjectDefinitions | Provides the definition of a generic object structure composed of metafields. |
| MetaObjects | All metaobjects for the shop. |
| OrderCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderDiscountApplications | Returns a list of discounts that are applied to the order, not including order edits and refunds. |
| OrderEvents | Retrieves a paginated list of events associated with the host subject. |
| OrderLineItemCustomAttributes | Retrieves custom attributes associated with the resource. |
| OrderLineItemDiscountAllocations | Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds. |
| OrderLineItems | Retrieves a list of line items in the associated resource. |
| OrderNonFulfillableLineItems | Retrieves a list of line items in the associated resource. |
| OrderRisks | Lists the order risks associated with this order. |
| OrderTaxLines | Represents a single tax applied to the associated resource. |
| Pages | Returns a list of the shop's pages. |
| ProductOptions | Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. |
| PublicationCollections | Returns a list of collections published to the publication. |
| PublicationProducts | Returns the list of publication for products. |
| RefundDuties | Lists the refunded duties as part of this refund. |
| RefundLineItems | Retrieves the 'RefundLineItem' resources attached to the refund. |
| RefundTransactionFees | Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions. |
| RefundTransactions | Retrieves the transactions associated with the resource. |
| ReturnLineItems | Retrieves the return line items attached to the return. |
| SellingPlanGroupSellingPlans | Retrieves selling plans associated to the selling plan group. |
| Shop | Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop. |
| ShopifyPaymentsAccount | Returns Shopify Payments account information, including balances and payouts. |
| ShopifyPaymentsAccountBalance | Returns current balances in all currencies for the account. |
| ShopifyPaymentsAccountBankAccounts | Lists all bank accounts configured for the Shopify Payments account. |
| ShopifyPaymentsAccountDisputes | Lists all disputes related to the Shopify Payments account. |
| ShopifyPaymentsAccountPayouts | Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries. |
| ShopifyPaymentsAccountPermittedVerificationDocuments | Retrieves the permitted documents for identity verification. |
| ShopifyPaymentsAccountVerifications | Returns the verifications necessary for this account. |
| StaffMembers | Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription) |
| TenderTransactions | Returns a list of TenderTransactions associated with the shop. |
Abandonment
Returns abandonment.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- Id supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Abandonment WHERE Id='VALUE'
SELECT * FROM Abandonment WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppId | String | A globally-unique ID. | |
| CustomerId | String | A globally-unique ID. | |
| AbandonmentType | String | The abandonment type. | |
| EmailState | String | The email state (e.g., sent or not sent). | |
| InventoryAvailable | Bool | Whether the products in abandonment are available. | |
| EmailSentAt | Datetime | When the email was sent, if that is the case. | |
| MostRecentStep | String | The most recent step type. | |
| VisitStartedAt | Datetime | The date and time when the visit started. | |
| IsFromOnlineStore | Bool | Whether the abandonment event comes from the Online Store sales channel. | |
| IsFromShopApp | Bool | Whether the abandonment event comes from the Shop app sales channel. | |
| IsFromShopPay | Bool | Whether the abandonment event comes from Shop Pay. | |
| IsMostSignificantAbandonment | Bool | Whether the customer did not complete another most significant step since this abandonment. | |
| LastBrowseAbandonmentDate | Datetime | The date for the latest browse abandonment. | |
| LastCartAbandonmentDate | Datetime | The date for the latest cart abandonment. | |
| LastCheckoutAbandonmentDate | Datetime | The date for the latest checkout abandonment. | |
| DaysSinceLastAbandonmentEmail | Int | The number of days since the last abandonment email was sent to the customer. | |
| HoursSinceLastAbandonedCheckout | Double | The number of hours since the customer has last abandoned a checkout. | |
| CustomerHasNoOrderSinceAbandonment | Bool | Whether the customer has completed an order since this checkout has been abandoned. | |
| CreatedAt | Datetime | The date and time when the abandonment was created. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadDefaultCursor | String | A default cursor that returns the single next record, sorted ascending by ID. | |
| AbandonedCheckoutPayloadAbandonedCheckoutUrl | String | The URL for the buyer to recover their checkout. | |
| AbandonedCheckoutPayloadLineItemsQuantity | Int | The number of products in the checkout. |
AbandonmentProductsAddedToCart
Returns the products added to the cart during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsAddedToCart WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String | A globally-unique ID. | |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AbandonmentProductsViewed
Returns the products viewed during the customer abandoned visit.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- AbandonmentId supports the '=' comparison operator.
- AbandonedCheckoutPayloadId supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM AbandonmentProductsViewed WHERE AbandonmentId='VALUE'
SELECT * FROM AbandonmentProductsViewed WHERE AbandonedCheckoutPayloadId='VALUE'
Columns
| Name | Type | References | Description |
| AbandonmentId [KEY] | String |
Abandonment.Id | A globally-unique ID. |
| AbandonedCheckoutPayloadId | String | A globally-unique ID. | |
| ProductId [KEY] | String | A globally-unique ID. | |
| VariantId | String | A globally-unique ID. | |
| Quantity | Int | The quantity of the product that the customer requested. |
AppCredits
Lists credits that can be used towards future app purchases.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AppInstallationId column, which supports the '=' comparison operator.The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AppCredits WHERE AppInstallationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppInstallationId | String | A globally-unique ID. | |
| Description | String | The description of the app credit. | |
| Test | Bool | Whether the app credit is a test transaction. | |
| CreatedAt | Datetime | The date and time when the app credit was created. | |
| Amount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. |
ArticleComments
Returns a list of comments posted on an article.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ArticleId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ArticleComments WHERE ArticleId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ArticleId | String |
Articles.Id | A globally-unique ID. |
| ContentHtml | String | The content of the comment, complete with HTML formatting. | |
| AuthorName | String | The author's name. | |
| AuthorEmail | String | The author's email. |
Articles
Returns a list of the shop's visible articles.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AuthorV2Name supports the '=,!=' comparison operators.
- AuthorV2FirstName supports the '=,!=' comparison operators.
- AuthorV2LastName supports the '=,!=' comparison operators.
- BlogTitle supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Articles WHERE Id='VALUE'
SELECT * FROM Articles WHERE AuthorV2Name='VALUE'
SELECT * FROM Articles WHERE AuthorV2FirstName='VALUE'
SELECT * FROM Articles WHERE AuthorV2LastName='VALUE'
SELECT * FROM Articles WHERE BlogTitle='VALUE'
SELECT * FROM Articles WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Articles WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The article's name. | |
| Handle | String | A human-friendly unique string for the Article automatically generated from its title. | |
| Tags | String | A categorization that a article can be tagged with. | |
| ContentHtml | String | The content of the article, complete with HTML formatting. | |
| ExcerptHtml | String | The excerpt of the article, complete with HTML formatting. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| PublishedAt | Datetime | The date and time when the article was published. | |
| AuthorV2Name | String | The author's full name. | |
| AuthorV2FirstName | String | The author's first name. | |
| AuthorV2LastName | String | The author's last name. | |
| AuthorV2Bio | String | The author's bio. | |
| AuthorV2Email | String | The author's email. | |
| BlogId | String | A globally-unique ID. | |
| BlogTitle | String | The blogs's title. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the article was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the article was last updated. This column can only be used as an input for filtering. |
AssignedFulfillmentOrders
Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the AssignedLocationLocationId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM AssignedFulfillmentOrders WHERE AssignedLocationLocationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| OrderId | String | A globally-unique ID. | |
| Status | String | The status of the fulfillment order. | |
| FulfillAt | Datetime | The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date. | |
| FulfillBy | Datetime | The latest date and time by which all items in the fulfillment order need to be fulfilled. | |
| RequestStatus | String | The request status of the fulfillment order. | |
| CreatedAt | Datetime | Date and time when the fulfillment order was created. | |
| UpdatedAt | Datetime | The date and time when the fulfillment order was last updated. | |
| AssignedLocationName | String | The name of the location. | |
| AssignedLocationAddress1 | String | The first line of the address for the location. | |
| AssignedLocationAddress2 | String | The second line of the address for the location. | |
| AssignedLocationCity | String | The city of the location. | |
| AssignedLocationPhone | String | The phone number of the location. | |
| AssignedLocationProvince | String | The province of the location. | |
| AssignedLocationZip | String | The ZIP code of the location. | |
| AssignedLocationCountryCode | String | The two-letter country code of the location. | |
| AssignedLocationLocationId | String | A globally-unique ID. | |
| AssignedLocationLocationLegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AssignedLocationLocationName | String | The name of the location. | |
| AssignedLocationLocationActivatable | Bool | Whether this location can be reactivated. | |
| AssignedLocationLocationDeactivatable | Bool | Whether this location can be deactivated. | |
| AssignedLocationLocationDeletable | Bool | Whether this location can be deleted. | |
| AssignedLocationLocationAddressVerified | Bool | Whether the location address has been verified. | |
| AssignedLocationLocationDeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| AssignedLocationLocationIsActive | Bool | Whether the location is active. | |
| AssignedLocationLocationShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| AssignedLocationLocationFulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| AssignedLocationLocationHasActiveInventory | Bool | Whether this location has active inventory. | |
| AssignedLocationLocationHasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| DeliveryMethodId | String | A globally-unique ID. | |
| DeliveryMethodMethodType | String | The type of the delivery method. | |
| DeliveryMethodMaxDeliveryDateTime | Datetime | The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DeliveryMethodMinDeliveryDateTime | Datetime | The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. | |
| DestinationId | String | A globally-unique ID. | |
| DestinationFirstName | String | The first name of the customer at the destination. | |
| DestinationLastName | String | The last name of the customer at the destination. | |
| DestinationAddress1 | String | The first line of the address of the destination. | |
| DestinationAddress2 | String | The second line of the address of the destination. | |
| DestinationCity | String | The city of the destination. | |
| DestinationCompany | String | The company of the destination. | |
| DestinationEmail | String | The email of the customer at the destination. | |
| DestinationPhone | String | The phone number of the customer at the destination. | |
| DestinationProvince | String | The province of the destination. | |
| DestinationZip | String | The ZIP code of the destination. | |
| DestinationCountryCode | String | The two-letter country code of the destination. | |
| InternationalDutiesIncoterm | String | The method of duties payment. Example values: 'DDP', 'DAP'. |
Blogs
Retrieves a list of the shop's blogs.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Blogs WHERE Id='VALUE'
SELECT * FROM Blogs WHERE Title='VALUE'
SELECT * FROM Blogs WHERE Handle='VALUE'
SELECT * FROM Blogs WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Blogs WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The blogs's title. | |
| Handle | String | A human-friendly unique string for the Blog automatically generated from its title. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. | |
| CreatedAt | Datetime | The date and time when the blog was created. This column can only be used as an input for filtering. | |
| UpdatedAt | Datetime | The date and time when the blog was last updated. This column can only be used as an input for filtering. |
CarrierServices
Returns a list of activated carrier services and associated shop locations that support them.
Table-Specific Information
Select
The Sync App WHERE clause conditions are processed client-side within the Sync App.
For example, the following queries are processed client-side:
SELECT * FROM CarrierServices WHERE Id = 'VALUE'
Columns
| Name | Type | References | Description |
| Id | String | A globally-unique ID. | |
| Name | String | The name of the shipping service provider. | |
| FormattedName | String | The properly formatted name of the shipping service provider, ready to display. | |
| IconAltText | String | A word or phrase to share the nature or contents of an image. | |
| IconHeight | Int | The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. | |
| IconId | String | A unique ID for the image. | |
| IconWidth | Int | The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. |
CollectionProducts
Retrieves a list of the products inside of a collection.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the CollectionId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CollectionProducts WHERE CollectionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique identifier. | |
| CollectionId | String |
Collections.Id | A globally-unique identifier for the collection. |
| Title | String | The title of the product. | |
| Position | Int | The position in which the products are sorted. |
CompanyEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CompanyEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Companies.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
CustomerEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM CustomerEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Customers.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DeliveryProfileLocationGroupCountries
Lists countries already selected in any zone for the specified location group.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| CountryId [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Zone | String | The name of the shipping zone. | |
| CountryName | String | The full name of the country. | |
| CountryTranslatedName | String | The translated name of the country. The translation returned is based on the system's locale. | |
| CountryCodeCountryCode | String | The country code in the ISO 3166-1 alpha-2 format. | |
| CountryCodeRestOfWorld | Bool | Whether the country is a part of the 'Rest of World' shipping zone. |
DeliveryProfileLocationGroupCountryProvinces
Returns the list of regions associated with this country.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| CountryId | String | A globally-unique ID. | |
| Code | String | The code of the region. | |
| Name | String | The full name of the region. | |
| TranslatedName | String | The translated name of the region. The translation returned is based on the system's locale. |
DeliveryProfileLocationGroups
Lists the location groups using this profile.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| LocationsCount | Int | A count of all locations that are part of this location group. |
DeliveryProfileLocationGroupZones
Lists the applicable zones associated to the specified location group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileLocationGroupZones WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LocationGroupId [KEY] | String | Filter the location groups of the profile by location group ID. | |
| DeliveryProfileId | String | The ID of the DeliveryProfile to return. | |
| Name | String | The name of the zone. | |
| MethodDefinitionCountsParticipantDefinitionsCount | Int | The number of participant method definitions for the specified zone. | |
| MethodDefinitionCountsRateDefinitionsCount | Int | The number of merchant-defined method definitions for the specified zone. |
DeliveryProfileUnassignedLocations
Lists the locations that have not been assigned to a location group for this profile.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DeliveryProfileId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DeliveryProfileUnassignedLocations WHERE DeliveryProfileId='VALUE'
Columns
| Name | Type | References | Description |
| DeliveryProfileId [KEY] | String | A globally-unique ID. | |
| LocationId [KEY] | String |
Locations.Id | A globally-unique ID. |
DiscountEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DiscountEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String | A globally-unique ID. | |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DiscountsCodeFreeShipping
Returns a list of discounts.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeFreeShipping WHERE Title='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE StartsAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the discount. | |
| Status | String | The status of the discount. | |
| Summary | String | A detailed summary of the discount. | |
| CodeCount | Int | The number of redeem codes for the discount. | |
| DiscountClass | String | The class of the discount for combining purposes. | |
| EndsAt | Datetime | The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | A short summary of the discount. | |
| StartsAt | Datetime | The date and time when the discount starts. | |
| UsageLimit | Int | The maximum number of times that the discount can be used. | |
| AppliesOnSubscription | Bool | Whether the discount applies on subscription shipping lines. | |
| AsyncUsageCount | Int | The number of times that the discount has been used. | |
| HasTimelineComment | Bool | Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | Whether the discount can be applied only once per customer. | |
| AppliesOnOneTimePurchase | Bool | Whether the discount applies on regular one-time-purchase shipping lines. | |
| CreatedAt | Datetime | The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountCountriesCountries | String | The codes for the countries where the discount can be applied. | |
| DiscountCountriesIncludeRestOfWorld | Bool | Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. | |
| DiscountCountryAllAllCountries | Bool | Whether the discount can be applied to all countries as shipping destination. This value is always 'true'. | |
| MaximumShippingPriceAmount | Decimal | Decimal money amount. | |
| MaximumShippingPriceCurrencyCode | String | Currency of the money. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | Decimal money amount. | |
| TotalSalesCurrencyCode | String | Currency of the money. |
DraftOrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
DraftOrders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
DraftOrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
DraftOrderLineItems
Returns a list of the line items in the draft order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the DraftOrderId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItems WHERE DraftOrderId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| DraftOrderId | String |
DraftOrders.Id | A globally-unique ID. |
| Name | String | The name of the product. | |
| Title | String | The title of the product or variant. This field only applies to custom line items. | |
| VariantTitle | String | The name of the variant. | |
| Custom | Bool | Whether the line item is a custom line item ('true') or a product variant line item ('false'). | |
| Quantity | Int | The number of product variants that are requested in the draft order. | |
| Sku | String | The SKU number of the product variant. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who created the product variant. | |
| DiscountedTotal | Decimal | The line item price after discounts are applied. | |
| OriginalTotal | Decimal | The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| TotalDiscount | Decimal | The total value of the discount that is applied to the line item. | |
| DiscountedUnitPrice | Decimal | The 'discountedTotal' divided by 'quantity', resulting in the value of the discount per unit. | |
| IsGiftCard | Bool | Whether the line item is a gift card. | |
| OriginalUnitPrice | Decimal | The variant price without any discounts applied. | |
| AppliedDiscountTitle | String | Name of the order-level discount. | |
| AppliedDiscountDescription | String | Description of the order-level discount. | |
| AppliedDiscountValue | Double | The order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount. | |
| AppliedDiscountValueType | String | Type of the order-level discount. | |
| AppliedDiscountAmountV2Amount | Decimal | Decimal money amount. | |
| AppliedDiscountAmountV2CurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ProductId | String | A globally-unique ID. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| VariantId | String | A globally-unique ID. | |
| WeightValue | Double | The weight value using the unit system specified with 'unit'. | |
| WeightUnit | String | The unit of measurement for 'value'. |
DraftOrderLineItemTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderLineItemTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
DraftOrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM DraftOrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
DraftOrders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
InventoryItemCountryHarmonizedSystemCodes
Returns a list of country specific harmonized system codes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemCountryHarmonizedSystemCodes WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| InventoryItemId | String | A globally-unique ID. | |
| CountryCode | String | The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. | |
| HarmonizedSystemCode [KEY] | String | The country-specific harmonized system code. These are usually longer than 6 digits. |
InventoryItemInventoryLevels
Returns a list of the inventory item's quantities for each location that the inventory item can be stocked at.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the InventoryItemId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM InventoryItemInventoryLevels WHERE InventoryItemId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| InventoryItemId | String | A globally-unique ID. | |
| LocationId | String | A globally-unique ID. | |
| CanDeactivate | Bool | Whether the inventory items associated with the inventory level can be deactivated. | |
| DeactivationAlert | String | Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. | |
| CreatedAt | Datetime | The date and time when the inventory level was created. | |
| UpdatedAt | Datetime | The date and time when the inventory level was updated. |
Jobs
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM Jobs WHERE Id='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID that's returned when running an asynchronous mutation. | |
| Done | Bool | This indicates if the job is still queued or has been run. |
MarketingEvents
Returns a list of marketing events associated with the marketing app.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- AppId supports the '=,!=' comparison operators.
- Type supports the '=,!=' comparison operators.
- StartedAt supports the '=,!=,<,>,>=,<=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM MarketingEvents WHERE Id='VALUE'
SELECT * FROM MarketingEvents WHERE AppId='VALUE'
SELECT * FROM MarketingEvents WHERE Type='VALUE'
SELECT * FROM MarketingEvents WHERE StartedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| RemoteId | String | An optional ID that helps Shopify validate engagement data. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AppId | String | A globally-unique ID. | |
| Channel | String | The marketing channel used by the marketing event. | |
| Description | String | A human-readable description of the marketing event. | |
| Type | String | The marketing event type. | |
| EndedAt | Datetime | The date and time when the marketing event ended. | |
| ManageUrl | String | The URL where the marketing event can be managed. | |
| PreviewUrl | String | The URL where the marketing event can be previewed. | |
| StartedAt | Datetime | The date and time when the marketing event started. | |
| UtmCampaign | String | The name of the marketing campaign. | |
| UtmMedium | String | The medium that the marketing campaign is using. Example values: 'cpc', 'banner'. | |
| UtmSource | String | The referrer of the marketing event. Example values: 'google', 'newsletter'. | |
| SourceAndMedium | String | Where the 'MarketingEvent' occurred and what kind of content was used. Because 'utmSource' and 'utmMedium' are often used interchangeably, this is based on a combination of 'marketingChannel', 'referringDomain', and 'type' to provide a consistent representation for any given piece of marketing regardless of the app that created it. | |
| ScheduledToEndAt | Datetime | The date and time when the marketing event is scheduled to end. |
MetaobjectDefinitions
Provides the definition of a generic object structure composed of metafields.
Select
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server side:
SELECT * FROM MetaobjectDefinitions
Columns
| Name | Type | References | Description |
| ID | String | A globally-unique ID. | |
| Name | String | The human-readable name. | |
| MetaobjectsCount | Int | The count of metaobjects created for the definition. | |
| Type | String | The type of the object definition. Defines the namespace of associated metafields. | |
| Description | String | The administrative description. | |
| DisplayNameKey | String | The key of a field to reference as the display name for each object. |
MetaObjects
All metaobjects for the shop.
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
- Type supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM MetaObjects
SELECT * FROM MetaObjects WHERE Type = 'Val1'
Columns
| Name | Type | References | Description |
| ID [KEY] | String | A globally-unique ID. | |
| Handle | String | The unique handle of the object, useful as a custom ID. | |
| DisplayName | String | The preferred display name field value of the metaobject. | |
| CreatedByDeveloperName | String | The name of the app developer. | |
| Title | String | Name of the app. | |
| Type | String | The type of the metaobject. | |
| Key [KEY] | String | The object key of this field. | |
| Value | String | The assigned field value, always stored as a string regardless of the field type. | |
| UpdatedAt | Datetime | When the object was last updated. |
OrderCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderDiscountApplications
Returns a list of discounts that are applied to the order, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderDiscountApplications WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String |
Orders.Id | A globally-unique ID. |
| AllocationMethod | String | The method by which the discount's value is applied to its entitled items. | |
| Index [KEY] | Int | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| TargetSelection | String | How the discount amount is distributed on the discounted lines. | |
| TargetType | String | Whether the discount is applied on line items or shipping lines. | |
| ValueAmount | Decimal | The value of the discount application. Decimal money amount. | |
| ValueCurrencyCode | String | The value of the discount application. Currency of the money. | |
| ValuePercentage | Double | The value of the discount application. The percentage value of the object. This is a number between -100 (free) and 0 (no discount). | |
| AutomaticDiscountApplicationTitle | String | The title of the discount application. | |
| DiscountCodeApplicationCode | String | The string identifying the discount code that was used at the time of application. | |
| ManualDiscountApplicationTitle | String | The title of the discount application. | |
| ManualDiscountApplicationDescription | String | The description of the discount application. | |
| ScriptDiscountApplicationTitle | String | The title of the discount application. |
OrderEvents
Retrieves a paginated list of events associated with the host subject.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the HostId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderEvents WHERE HostId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| HostId | String |
Orders.Id | A globally-unique ID. |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Message | String | Human readable text that describes the event. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |
OrderLineItemCustomAttributes
Retrieves custom attributes associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemCustomAttributes WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| ResourceId [KEY] | String | A globally-unique ID. | |
| Key | String | Key or name of the attribute. | |
| Value | String | Value of the attribute. |
OrderLineItemDiscountAllocations
Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderLineItemId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItemDiscountAllocations WHERE OrderLineItemId='VALUE'
Columns
| Name | Type | References | Description |
| OrderLineItemId | String | The ID of the Order to return. | |
| DiscountApplicationIndex [KEY] | Decimal | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| AllocatedAmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AllocatedAmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AllocatedAmountSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderNonFulfillableLineItems
Retrieves a list of line items in the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderNonFulfillableLineItems WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId | String |
Orders.Id | A globally-unique ID. |
| Name | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| Title | String | The title of the product at time of order creation. | |
| VariantTitle | String | The title of the variant at time of order creation. | |
| VariantId | String | A globally-unique ID. | |
| ProductId | String | A globally-unique ID. | |
| SellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The number of variant units ordered. | |
| Restockable | Bool | Whether the line item can be restocked. | |
| Sku | String | The variant SKU number. | |
| Taxable | Bool | Whether the variant is taxable. | |
| Vendor | String | The name of the vendor who made the variant. | |
| CurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| MerchantEditable | Bool | Whether the line item can be edited or not. | |
| RefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| RequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| UnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| NonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| DiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| DiscountedUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| DiscountedUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| ImageId | String | A unique ID for the image. | |
| ImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| ImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| ImageUrl | String | The location of the image as a URL. | |
| OriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| OriginalUnitPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| OriginalUnitPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalDiscountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalDiscountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledDiscountedTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| UnfulfilledOriginalTotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| UnfulfilledOriginalTotalSetShopMoneyCurrencyCode | String | Currency of the money. |
OrderRisks
Lists the order risks associated with this order.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the OrderId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderRisks WHERE OrderId='VALUE'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String | The order which this order risk is associated. | |
| Display | Bool | Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. | |
| Level | String | The likelihood that an order is fraudulent, based on this order risk. The level can be set by Shopify risk analysis or by an app. | |
| Message [KEY] | String | The risk message that's shown to the merchant in the Shopify admin. |
OrderTaxLines
Represents a single tax applied to the associated resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrderTaxLines WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Title [KEY] | String | The name of the tax. | |
| ResourceId [KEY] | String |
Orders.Id | A globally-unique ID. |
| Rate | Double | The proportion of the line item price that the tax represents as a decimal. | |
| ChannelLiable | Bool | Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. | |
| RatePercentage | Double | The proportion of the line item price that the tax represents as a percentage. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. |
Pages
Returns a list of the shop's pages.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- Handle supports the '=' comparison operator.
- CreatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Pages WHERE Title='VALUE'
SELECT * FROM Pages WHERE Handle='VALUE'
SELECT * FROM Pages WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Pages WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the page. | |
| Body | String | The description of the page, complete with HTML formatting. | |
| Handle | String | A human-friendly unique string for the page automatically generated from its title. | |
| BodySummary | String | Summary of the page body. | |
| OnlineStoreUrl | String | The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel. | |
| CreatedAt | Datetime | The timestamp of the page creation. | |
| UpdatedAt | Datetime | The timestamp of the latest page update. | |
| SeoTitle | String | The SEO title. | |
| SeoDescription | String | The meta description. |
ProductOptions
Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ProductId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ProductOptions WHERE ProductId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique identifier. | |
| ProductId | String |
Products.Id | A globally-unique identifier. |
| Name | String | The product option's name. | |
| Position | Int | The product option's position. | |
| Values | String | The corresponding value to the product option name. |
PublicationCollections
Returns a list of collections published to the publication.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationCollections WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| PublicationId | String |
Publications.Id | A globally-unique ID. |
PublicationProducts
Returns the list of publication for products.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the PublicationId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM PublicationProducts WHERE PublicationId='VALUE'
Columns
| Name | Type | References | Description |
| ProductId [KEY] | String |
Products.Id | A globally-unique ID. |
| PublishDate | Datetime | The date that the resource publication was or is going to be published to the publication. | |
| IsPublished | Bool | Whether the resource publication is published. | |
| PublicationId [KEY] | String | A globally-unique ID. | |
| PublicationName | String | Name of the publication. |
RefundDuties
Lists the refunded duties as part of this refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundDuties WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| OriginalDutyId [KEY] | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| OriginalDutyHarmonizedSystemCode | String | The harmonized system code of the item used in calculating the duty. | |
| OriginalDutyCountryCodeOfOrigin | String | The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundLineItems
Retrieves the 'RefundLineItem' resources attached to the refund.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the RefundId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundLineItems WHERE RefundId='VALUE'
Columns
| Name | Type | References | Description |
| LineItemId | String | A globally-unique ID. | |
| RefundId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| LineItemName | String | The title of the product, optionally appended with the title of the variant (if applicable). | |
| LineItemTitle | String | The title of the product at time of order creation. | |
| LineItemVariantTitle | String | The title of the variant at time of order creation. | |
| LineItemQuantity | Int | The number of variant units ordered. | |
| LineItemRestockable | Bool | Whether the line item can be restocked. | |
| LineItemSku | String | The variant SKU number. | |
| LineItemTaxable | Bool | Whether the variant is taxable. | |
| LineItemVendor | String | The name of the vendor who made the variant. | |
| LineItemCurrentQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemMerchantEditable | Bool | Whether the line item can be edited or not. | |
| LineItemRefundableQuantity | Int | The line item's quantity, minus the removed quantity. | |
| LineItemNonFulfillableQuantity | Int | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details. | |
| LineItemRequiresShipping | Bool | Whether physical shipping is required for the variant. | |
| LineItemUnfulfilledQuantity | Int | The number of units not yet fulfilled. | |
| LineItemImageId | String | A unique ID for the image. | |
| LineItemImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| LineItemImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| LineItemImageUrl | String | The location of the image as a URL. | |
| LineItemProductId | String | A globally-unique ID. | |
| LineItemVariantId | String | A globally-unique ID. | |
| LineItemSellingPlanSellingPlanId | String | The ID of the selling plan associated with the line item. | |
| Quantity | Int | The quantity of a refunded line item. | |
| Restocked | Bool | Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. | |
| RestockType | String | The type of restock for the refunded line item. | |
| LocationId | String | A globally-unique ID. | |
| PriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| PriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| PriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| SubtotalSetShopMoneyAmount | Decimal | Decimal money amount. | |
| SubtotalSetShopMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalTaxSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalTaxSetShopMoneyCurrencyCode | String | Currency of the money. |
RefundTransactionFees
Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionId column, which supports the '=,IN' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactionFees WHERE TransactionId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| TransactionId | String | A globally-unique ID. | |
| RateName | String | Name of the credit card rate. | |
| FlatFeeName | String | Name of the credit card flat fee. | |
| Rate | Decimal | Percentage charge. | |
| Type | String | Name of the type of fee. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| FlatFeeAmount | Decimal | Decimal money amount. | |
| FlatFeeCurrencyCode | String | Currency of the money. | |
| TaxAmountAmount | Decimal | Decimal money amount. | |
| TaxAmountCurrencyCode | String | Currency of the money. |
RefundTransactions
Retrieves the transactions associated with the resource.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the ResourceId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM RefundTransactions WHERE ResourceId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ResourceId [KEY] | String |
Refunds.Id | A globally-unique ID. |
| PaymentId | String | The payment ID associated with the transaction. | |
| ParentTransactionId | String | The associated parent transaction, for example the authorization of a capture. | |
| AccountNumber | String | The masked account number associated with the payment method. | |
| Gateway | String | The payment gateway used to process the transaction. | |
| Kind | String | The kind of transaction. | |
| Status | String | The status of this transaction. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| AuthorizationCode | String | Authorization code associated with the transaction. | |
| ErrorCode | String | A standardized error code, independent of the payment provider. | |
| FormattedGateway | String | The human-readable payment gateway name used to process the transaction. | |
| ManuallyCapturable | Bool | Whether the transaction can be manually captured. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| ReceiptJson | String | The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| SettlementCurrency | String | The settlement currency. | |
| AuthorizationExpiresAt | Datetime | The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. | |
| SettlementCurrencyRate | Decimal | The rate used when converting the transaction amount to settlement currency. | |
| CreatedAt | Datetime | Date and time when the transaction was created. | |
| CardPaymentDetailsName | String | The holder of the credit card. | |
| CardPaymentDetailsBin | String | 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. | |
| CardPaymentDetailsCompany | String | The name of the company that issued the customer's credit card. | |
| CardPaymentDetailsNumber | String | The customer's credit card number, with most of the leading digits redacted. | |
| CardPaymentDetailsWallet | String | Digital wallet used for the payment. | |
| CardPaymentDetailsExpirationMonth | Int | The month in which the used credit card expires. | |
| CardPaymentDetailsExpirationYear | Int | The year in which the used credit card expires. | |
| CardPaymentDetailsAvsResultCode | String | The response code from the address verification system (AVS). The code is always a single letter. | |
| CardPaymentDetailsCvvResultCode | String | 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. | |
| PaymentIconId | String | A unique ID for the image. | |
| PaymentIconWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| PaymentIconAltText | String | A word or phrase to share the nature or contents of an image. | |
| PaymentIconHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| AmountSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| AmountSetShopMoneyAmount | Decimal | Decimal money amount. | |
| AmountSetShopMoneyCurrencyCode | String | Currency of the money. | |
| MaximumRefundableV2Amount | Decimal | Decimal money amount. | |
| MaximumRefundableV2CurrencyCode | String | Currency of the money. | |
| ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt | Datetime | The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. | |
| ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt | Datetime | The time after which capture will incur an additional fee. | |
| ShopifyPaymentsSetRefundSetAcquirerReferenceNumber | String | The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. | |
| TotalUnsettledSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| TotalUnsettledSetShopMoneyAmount | Decimal | Decimal money amount. | |
| TotalUnsettledSetShopMoneyCurrencyCode | String | Currency of the money. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御したり、INSERT ステートメントのパラメータとして使用したりすることができます。
| Name | Type | Description | |
| Amount | Decimal | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. | |
| Currency | String | The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. |
ReturnLineItems
Retrieves the return line items attached to the return.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the Id column, which supports the '=' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ReturnLineItems WHERE ReturnId='VALUE'
Insert
INSERT statements are mapped to the 'priceListCreate' GraphQL mutation.
The following columns can be used to create a new record:
Quantity, ReturnReason, ReturnReasonNote, FulfillmentLineItemId
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ReturnId [KEY] | String |
Returns.Id | A globally-unique ID. |
| Quantity | Int | The quantity being returned. | |
| CustomerNote | String | A note from the customer that describes the item to be returned. Maximum length: 300 characters. | |
| RefundableQuantity | Int | The quantity that can be refunded. | |
| RefundedQuantity | Int | The quantity that was refunded. | |
| ReturnReason | String | The reason for returning the item. | |
| ReturnReasonNote | String | Additional information about the reason for the return. Maximum length: 255 characters. | |
| TotalWeightUnit | String | The unit of measurement for `value`. | |
| TotalWeightValue | Double | The weight value using the unit system specified with `unit`. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetPresentmentMoneyCurrencyCode | String | Currency of the money. | |
| WithCodeDiscountedTotalPriceSetShopMoneyAmount | Decimal | Decimal money amount. | |
| WithCodeDiscountedTotalPriceSetShopMoneyCurrencyCode | String | Currency of the money. | |
| FulfillmentLineItemId | String | A globally-unique ID. |
SellingPlanGroupSellingPlans
Retrieves selling plans associated to the selling plan group.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the SellingPlanGroupId column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM SellingPlanGroupSellingPlans WHERE SellingPlanGroupId='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| SellingPlanGroupId | String | A globally-unique ID. | |
| Name | String | A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies. | |
| Category | String | The category used to classify the selling plan for reporting purposes. | |
| Description | String | Buyer facing string which describes the selling plan commitment. | |
| Options | String | The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. | |
| Position | Int | Relative position of the selling plan for display. A lower position will be displayed before a higher position. | |
| CreatedAt | Datetime | The date and time when the selling plan was created. | |
| InventoryPolicyReserve | String | When to reserve inventory for the order. | |
| FixedBillingPolicyCheckoutChargeType | String | The charge type for the checkout charge. | |
| FixedBillingPolicyCheckoutChargeValueAmount | Decimal | The charge value for the checkout charge. Decimal money amount. | |
| FixedBillingPolicyCheckoutChargeValueCurrencyCode | String | The charge value for the checkout charge. Currency of the money. | |
| FixedBillingPolicyCheckoutChargeValuePercentage | Double | The charge value for the checkout charge. The percentage value of the price used for checkout charge. | |
| FixedBillingPolicyRemainingBalanceChargeExactTime | Datetime | The exact time when to capture the full payment. | |
| FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout | String | The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. | |
| FixedBillingPolicyRemainingBalanceChargeTrigger | String | When to capture payment for amount due. | |
| RecurringBillingPolicyAnchors | String | Specific anchor dates upon which the billing interval calculations should be made. Aggregate value. | |
| RecurringBillingPolicyCreatedAt | Datetime | The date and time when the selling plan billing policy was created. | |
| RecurringBillingPolicyInterval | String | The billing frequency, it can be either: day, week, month or year. | |
| RecurringBillingPolicyIntervalCount | Int | The number of intervals between billings. | |
| RecurringBillingPolicyMaxCycles | Int | Maximum number of billing iterations. | |
| RecurringBillingPolicyMinCycles | Int | Minimum number of billing iterations. | |
| FixedDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| FixedDeliveryPolicyCutoff | Int | A buffer period for orders to be included in next fulfillment anchor. | |
| FixedDeliveryPolicyFulfillmentExactTime | Datetime | The date and time when the fulfillment should trigger. | |
| FixedDeliveryPolicyFulfillmentTrigger | String | What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. | |
| FixedDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| FixedDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| RecurringDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. | |
| RecurringDeliveryPolicyCreatedAt | Datetime | The date and time when the selling plan delivery policy was created. | |
| RecurringDeliveryPolicyCutoff | Int | Number of days which represent a buffer period for orders to be included in a cycle. | |
| RecurringDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. | |
| RecurringDeliveryPolicyInterval | String | The delivery frequency, it can be either: day, week, month or year. | |
| RecurringDeliveryPolicyIntervalCount | Int | The number of intervals between deliveries. | |
| RecurringDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. | |
| FixedPricingPolicies | String | Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value. | |
| RecurringPricingPolicies | String | Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value. |
Shop
Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Name | String | The shop's name. | |
| RichTextEditorUrl | String | The URL of the rich text editor that can be used for mobile devices. | |
| Description | String | The shop's meta description used in search engine results. | |
| String | The shop owner's email address. Shopify will use this email address to communicate with the shop owner. | ||
| Url | String | The URL of the shop's online store. | |
| ContactEmail | String | The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. | |
| CurrencyCode | String | The three letter code for the currency that the shop sells in. | |
| CustomerAccounts | String | Whether customer accounts are required, optional, or disabled for the shop. | |
| IanaTimezone | String | The shop's time zone as defined by the IANA. | |
| MyshopifyDomain | String | The shop's . myshopify. com domain name. | |
| PublicationCount | Int | The number of publications for the shop. | |
| SetupRequired | Bool | Whether the shop has outstanding setup steps. | |
| TaxShipping | Bool | Whether the shop charges taxes for shipping. | |
| TaxesIncluded | Bool | Whether applicable taxes are included in the shop's product prices. | |
| TimezoneAbbreviation | String | The shop's time zone abbreviation. | |
| TimezoneOffset | String | The shop's time zone offset. | |
| UnitSystem | String | The shop's unit system for weights and measures. | |
| WeightUnit | String | The shop's primary unit of weight for products and shipping. | |
| CheckoutApiSupported | Bool | Specifies whether the shop supports checkouts via Checkout API. | |
| EnabledPresentmentCurrencies | String | The presentment currencies enabled for the shop. | |
| ShipsToCountries | String | The list of countries that the shop ships to. | |
| TimezoneOffsetMinutes | Int | The shop's time zone offset expressed as a number of minutes. | |
| TransactionalSmsDisabled | Bool | Whether transactional SMS sent by Shopify have been disabled for a shop. | |
| OrderNumberFormatPrefix | String | The prefix that appears before order numbers. | |
| OrderNumberFormatSuffix | String | The suffix that appears after order numbers. | |
| BillingAddressId | String | A globally-unique ID. | |
| BillingAddressCoordinatesValidated | Bool | Whether the address coordinates are valid. | |
| BillingAddressAddress1 | String | The first line of the address. Typically the street address or PO Box number. | |
| BillingAddressAddress2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
| BillingAddressCity | String | The name of the city, district, village, or town. | |
| BillingAddressCompany | String | The name of the company or organization. | |
| BillingAddressCountry | String | The name of the country. | |
| BillingAddressLatitude | Double | The latitude coordinate of the address. | |
| BillingAddressLongitude | Double | The longitude coordinate of the address. | |
| BillingAddressPhone | String | A phone number associated with the address. Formatted using E. 164 standard. For example, _+16135551111_. | |
| BillingAddressProvince | String | The region of the address, such as the province, state, or district. | |
| BillingAddressZip | String | The zip or postal code of the address. | |
| BillingAddressFormattedArea | String | A comma-separated list of the values for city, province, and country. | |
| BillingAddressProvinceCode | String | The two-letter code for the region. For example, ON. | |
| BillingAddressCountryCodeV2 | String | The two-letter code for the country of the address. For example, US. | |
| CountriesInShippingZonesCountryCodes | String | The list of all the countries from all the combined shipping zones. | |
| CountriesInShippingZonesIncludeRestOfWorld | Bool | Whether 'Rest of World' has been defined in any of the shipping zones. | |
| CurrencyFormatsMoneyFormat | String | Money without currency in HTML. | |
| CurrencyFormatsMoneyInEmailsFormat | String | Money without currency in emails. | |
| CurrencyFormatsMoneyWithCurrencyFormat | String | Money with currency in HTML. | |
| CurrencyFormatsMoneyWithCurrencyInEmailsFormat | String | Money with currency in emails. | |
| FeaturesInternationalPriceOverrides | Bool | Whether a shop can enable international price overrides. | |
| FeaturesBranding | String | The branding of the shop, which influences its look and feel in the Shopify admin. | |
| FeaturesCaptcha | Bool | Whether a shop's online store can have CAPTCHA protection. | |
| FeaturesReports | Bool | Whether a shop has access to all reporting features. | |
| FeaturesStorefront | Bool | Whether a shop has an online store. | |
| FeaturesAvalaraAvatax | Bool | Whether a shop has access to Avalara AvaTax. | |
| FeaturesDynamicRemarketing | Bool | Whether a shop has access to the Google Analytics dynamic remarketing feature. | |
| FeaturesGiftCards | Bool | Whether a shop can create gift cards. | |
| FeaturesInternationalDomains | Bool | Whether a shop can enable international domains. | |
| FeaturesLiveView | Bool | Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial or don't have a storefront. | |
| FeaturesSellsSubscriptions | Bool | Whether a shop has ever had subscription products. | |
| FeaturesShowMetrics | Bool | Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. | |
| FeaturesCaptchaExternalDomains | Bool | Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. | |
| FeaturesEligibleForSubscriptions | Bool | Whether a shop is configured properly to sell subscriptions. | |
| FeaturesHarmonizedSystemCode | Bool | Whether a shop displays Harmonized System codes on products. This is used for customs when shipping internationally. | |
| FeaturesInternationalPriceRules | Bool | Whether a shop can enable international price rules. | |
| FeaturesEligibleForSubscriptionMigration | Bool | Whether a shop can be migrated to use Shopify subscriptions. | |
| FeaturesLegacySubscriptionGatewayEnabled | Bool | Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. | |
| FeaturesPaypalExpressSubscriptionGatewayStatus | String | Whether a shop is configured to sell subscriptions with PayPal Express. | |
| LimitedPendingOrderCountCount | Int | The number of pendings orders on the shop. Limited to a maximum of 10000. | |
| LimitedPendingOrderCountAtMax | Bool | This is set when the number of pending orders has reached the maximum. | |
| PaymentSettingsSupportedDigitalWallets | String | List of the digital wallets which the shop supports. | |
| PlanDisplayName | String | The name of the shop's billing plan. | |
| PlanPartnerDevelopment | Bool | Whether the shop is a partner development shop for testing purposes. | |
| PlanShopifyPlus | Bool | Whether the shop has a Shopify Plus subscription. | |
| PrimaryDomainId | String | A globally-unique ID. | |
| PrimaryDomainHost | String | The host name of the domain. For example, 'example. com'. | |
| PrimaryDomainUrl | String | The URL of the domain (for example, 'https: //example. com'). | |
| PrimaryDomainSslEnabled | Bool | Whether SSL is enabled. | |
| PrimaryDomainLocalizationCountry | String | The ISO code for the country assigned to the domain. For example, 'CA' or '*' for a domain set to 'Rest of world'. | |
| PrimaryDomainLocalizationAlternateLocales | String | The ISO codes for the domain's alternate locales. For example, '['en']'. | |
| PrimaryDomainLocalizationDefaultLocale | String | The ISO code for the domain's default locale. For example, 'en'. | |
| PrimaryDomainMarketWebPresenceId | String | A globally-unique ID. | |
| PrimaryDomainMarketWebPresenceAlternateLocales | String | The ISO codes for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and 'example. ca' is the market's domain, then 'example. ca/en' will load in English. | |
| PrimaryDomainMarketWebPresenceDefaultLocale | String | The ISO code for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and 'example. ca' is the market's domian, then 'example. ca' will load in French. | |
| PrimaryDomainMarketWebPresenceSubfolderSuffix | String | The market-specific suffix of the subfolders defined by the web presence. Example: in '/en-us' the subfolder suffix is 'us'. This field will be null if 'domain' isn't null. | |
| ResourceLimitsLocationLimit | Int | Maximum number of locations allowed. | |
| ResourceLimitsMaxProductOptions | Int | Maximum number of product options allowed. | |
| ResourceLimitsMaxProductVariants | Int | The maximum number of variants allowed per product. | |
| ResourceLimitsRedirectLimitReached | Bool | Whether the shop has reached the limit of the number of URL redirects it can make for resources. | |
| ResourceLimitsSkuResourceLimitsAvailable | Bool | Whether the resource is available. | |
| ResourceLimitsSkuResourceLimitsQuantityAvailable | Int | Quantity available. If null the quantity available is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityLimit | Int | Quantity limit of the resource. If null the quantity is unlimited. | |
| ResourceLimitsSkuResourceLimitsQuantityUsed | Int | Quantity used of the resource. If null the quantity used cannot be retrieved. |
ShopifyPaymentsAccount
Returns Shopify Payments account information, including balances and payouts.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Activated | Bool | Whether the Shopify Payments setup is completed. | |
| Country | String | The Shopify Payments account country. | |
| Onboardable | Bool | Whether the Shopify Payments account can be onboarded. | |
| DefaultCurrency | String | The default payout currency for the Shopify Payments account. | |
| PayoutStatementDescriptor | String | The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout. | |
| FraudSettingsDeclineChargeOnAvsFailure | Bool | Decline a charge if there is an AVS failure. | |
| FraudSettingsDeclineChargeOnCvcFailure | Bool | Decline a charge if there is an CVC failure. | |
| NotificationSettingsPayouts | Bool | Receive email notifications when new payouts are sent or payouts fail. | |
| PayoutScheduleInterval | String | The interval at which payouts are sent to the connected bank account. | |
| PayoutScheduleMonthlyAnchor | Int | The day of the month funds will be paid out. The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. | |
| PayoutScheduleWeeklyAnchor | String | The day of the week funds will be paid out. The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used. |
ShopifyPaymentsAccountBalance
Returns current balances in all currencies for the account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Amount | Decimal | Decimal money amount. | |
| CurrencyCode [KEY] | String | Currency of the money. |
ShopifyPaymentsAccountBankAccounts
Lists all bank accounts configured for the Shopify Payments account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| BankName | String | The name of the bank. | |
| Country | String | The country of the bank. | |
| Currency | String | The currency of the bank account. | |
| Status | String | The status of the bank account. | |
| AccountNumber | String | The account number of the bank account. | |
| RoutingNumber | String | The routing number of the bank account. | |
| AccountNumberLastDigits | String | The last digits of the account number (the rest is redacted). | |
| CreatedAt | Datetime | The date that the bank account was created. |
ShopifyPaymentsAccountDisputes
Lists all disputes related to the Shopify Payments account.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,!=' comparison operators.
- Status supports the '=,!=' comparison operators.
- InitiatedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Id='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE Status='VALUE'
SELECT * FROM ShopifyPaymentsAccountDisputes WHERE InitiatedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| EvidenceDueBy | Date | The deadline for evidence submission. | |
| EvidenceSentOn | Date | The date when evidence was sent. Returns null if evidence has not yet been sent. | |
| Status | String | The current state of the dispute. | |
| Type | String | Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. | |
| FinalizedOn | Date | The date when this dispute was resolved. Returns null if the dispute is not yet resolved. | |
| InitiatedAt | Datetime | The date when this dispute was initiated. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| OrderId | String | A globally-unique ID. | |
| ReasonDetailsReason | String | The reason for the dispute provided by the cardholder's banks. | |
| ReasonDetailsNetworkReasonCode | String | The raw code provided by the payment network. |
ShopifyPaymentsAccountPayouts
Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the TransactionType column, which supports the '=' comparison operator.
The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ShopifyPaymentsAccountPayouts WHERE TransactionType='VALUE'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The transfer status of the payout. | |
| IssuedAt | Datetime | The exact time when the payout was issued. The payout only contains balance transactions that were available at this time. | |
| TransactionType | String | The direction of the payout. | |
| BankAccountId | String | A globally-unique ID. | |
| NetAmount | Decimal | Decimal money amount. | |
| NetCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsFeeAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsFeeCurrencyCode | String | Currency of the money. | |
| SummaryAdjustmentsGrossAmount | Decimal | Decimal money amount. | |
| SummaryAdjustmentsGrossCurrencyCode | String | Currency of the money. | |
| SummaryChargesFeeAmount | Decimal | Decimal money amount. | |
| SummaryChargesFeeCurrencyCode | String | Currency of the money. | |
| SummaryChargesGrossAmount | Decimal | Decimal money amount. | |
| SummaryChargesGrossCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRefundsFeeGrossAmount | Decimal | Decimal money amount. | |
| SummaryRefundsFeeGrossCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsFeeAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsFeeCurrencyCode | String | Currency of the money. | |
| SummaryReservedFundsGrossAmount | Decimal | Decimal money amount. | |
| SummaryReservedFundsGrossCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsFeeAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsFeeCurrencyCode | String | Currency of the money. | |
| SummaryRetriedPayoutsGrossAmount | Decimal | Decimal money amount. | |
| SummaryRetriedPayoutsGrossCurrencyCode | String | Currency of the money. |
ShopifyPaymentsAccountPermittedVerificationDocuments
Retrieves the permitted documents for identity verification.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Type [KEY] | String | The type of the document which can be used for verification. | |
| BackRequired | Bool | True if the back side of the document is required. | |
| FrontRequired | Bool | True if the front side of the document is required. |
ShopifyPaymentsAccountVerifications
Returns the verifications necessary for this account.
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopifyPaymentsAccountId | String | A globally-unique ID. | |
| Status | String | The status of the verification. | |
| SubjectFamilyName | String | The family name of the individual to verify. | |
| SubjectGivenName | String | The given name of the individual to verify. |
StaffMembers
Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription)
View-Specific Information
Select
The Sync App processes filters client-side within the Sync App.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| ShopId | String |
Shop.Id | A globally-unique ID. |
| Name | String | The staff member's full name. | |
| FirstName | String | The staff member's first name. | |
| LastName | String | The staff member's last name. | |
| Active | Bool | Whether the staff member is active. | |
| String | The staff member's email address. | ||
| Exists | Bool | Whether the staff member's account exists. | |
| Initials | String | The staff member's initials, if available. | |
| Locale | String | The staff member'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' | |
| Phone | String | The staff member's phone number. | |
| IsShopOwner | Bool | Whether the staff member is the shop owner. | |
| PrivateDataAccountSettingsUrl | String | The URL to the staff member's account settings page. | |
| PrivateDataCreatedAt | Datetime | The date and time when the staff member was created. |
TenderTransactions
Returns a list of TenderTransactions associated with the shop.
View-Specific Information
Select
The Sync App uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- Test supports the '=,!=' comparison operators.
- ProcessedAt supports the '=,!=,<,>,>=,=<' comparison operators.
The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TenderTransactions WHERE Id='VALUE'
SELECT * FROM TenderTransactions WHERE Test='true'
SELECT * FROM TenderTransactions WHERE ProcessedAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Test | Bool | Whether the transaction is a test transaction. | |
| PaymentMethod | String | Information about the payment method used for the transaction. | |
| ProcessedAt | Datetime | Date and time when the transaction was processed. | |
| RemoteReference | String | The remote gateway reference associated with the tender transaction. | |
| AmountAmount | Decimal | Decimal money amount. | |
| AmountCurrencyCode | String | Currency of the money. | |
| TenderTransactionCreditCardDetailsCreditCardCompany | String | The name of the company that issued the customer's credit card. Example: 'Visa'. | |
| TenderTransactionCreditCardDetailsCreditCardNumber | String | The customer's credit card number, with all digits except the last 4 redacted. Example: '???? ???? ???? 1234' |
接続文字列オプション
| プロパティ | 説明 |
| ShopURL | Shopify ショップの完全URL。 |
| AuthScheme | Shopify に接続する際に使用する認証の種類。 |
| AccessToken | カスタムアプリ用のAdmin API Access Token。 |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| Schema | 接続するShopify サーバーのバージョンを指定します。 |
| プロパティ | 説明 |
| UseBulkAPI | Specifies whether to use Shopify Bulk Operations for GraphQL schema. |
| BulkPageSize | The number of records to retrieve before returning results to the user when UseBulkAPI=true. |
| EnableShopifyPlus | If the app is installed on a Shopify Plus account, set to True. |
| IncludeCustomFields | Set whether to include custom fields in the query to the Products and ProductVariants table. When set to false , performance increases, but you cannot read and update (only in REST) Products and ProductVariants custom fields. |
| MaxPointsPerCall | Specifies how many points a call will cost. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | The maximum number of results to return per page from Shopify. Set Pagesize to -1 to use the default value, for REST it will be 250 and for GRAPHQL it will be calculated based on the points. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| ShowAggregate | This property determines if aggregated values will be appended to the result-set. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
Authentication
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| ShopURL | Shopify ショップの完全URL。 |
| AuthScheme | Shopify に接続する際に使用する認証の種類。 |
| AccessToken | カスタムアプリ用のAdmin API Access Token。 |
ShopURL
Shopify ショップの完全URL。
解説
Shopify ショップの完全URL。
AuthScheme
Shopify に接続する際に使用する認証の種類。
解説
- OAuth：OAuth 認証を実行する場合に設定。
- Access Token：アクセストークン認証を使用する場合に設定。
AccessToken
カスタムアプリ用のAdmin API Access Token。
解説
カスタムアプリ用のAdmin API Access Token。
OAuth
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthClientId
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
解説
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuthClientSecret
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
解説
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
SSL
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
SSLServerCert
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
解説
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint （hex 値はスペースおよびコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint （hex 値はスペースおよびコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
Firewall
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
FirewallType
プロキシベースのファイアウォールで使われるプロトコル。
解説
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はShopify への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
FirewallServer
プロキシベースのファイアウォールの名前もしくはIP アドレス。
解説
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
FirewallPort
プロキシベースのファイアウォールのTCP ポート。
解説
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
FirewallUser
プロキシベースのファイアウォールに認証するために使うユーザー名。
解説
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
FirewallPassword
プロキシベースのファイアウォールへの認証に使われるパスワード。
解説
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
Proxy
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
ProxyAutoDetect
これは、システムプロキシ設定を使用するかどうかを示します。
解説
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
ProxyServer
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
解説
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyPort
ProxyServer プロキシが起動しているTCP ポート。
解説
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyAuthScheme
ProxyServer プロキシへの認証で使われる認証タイプ。
解説
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
- BASIC： Sync App はHTTP BASIC 認証を行います。
- DIGEST： Sync App はHTTP DIGEST 認証を行います。
- NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
- PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyUser
ProxyServer プロキシへの認証に使われるユーザー名。
解説
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyPassword
ProxyServer プロキシへの認証に使われるパスワード。
解説
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxySSLType
ProxyServer プロキシへの接続時に使用するSSL タイプ。
解説
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyExceptions
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
解説
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
Logging
LogModules
ログファイルに含めるコアモジュール。
解説
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
Schema
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| Schema | 接続するShopify サーバーのバージョンを指定します。 |
Location
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
解説
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
Note： このSync App は複数のスキーマをサポートするため、Shopify カスタムスキーマファイルの構造は以下のようになります。
- 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
- これらのスキーマフォルダは親フォルダに含まれています。
- 親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Shopify Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
| Platform | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
BrowsableSchemas
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
解説
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
Tables
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
解説
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
Views
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
解説
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
Schema
接続するShopify サーバーのバージョンを指定します。
解説
- REST-2023-04 は、Shopify REST API、version 2023-04 を使用します。 - GRAPHQL-2023-04 は、Shopify GraphQL API、version 2023-04 を使用します。
Miscellaneous
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| UseBulkAPI | Specifies whether to use Shopify Bulk Operations for GraphQL schema. |
| BulkPageSize | The number of records to retrieve before returning results to the user when UseBulkAPI=true. |
| EnableShopifyPlus | If the app is installed on a Shopify Plus account, set to True. |
| IncludeCustomFields | Set whether to include custom fields in the query to the Products and ProductVariants table. When set to false , performance increases, but you cannot read and update (only in REST) Products and ProductVariants custom fields. |
| MaxPointsPerCall | Specifies how many points a call will cost. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | The maximum number of results to return per page from Shopify. Set Pagesize to -1 to use the default value, for REST it will be 250 and for GRAPHQL it will be calculated based on the points. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| ShowAggregate | This property determines if aggregated values will be appended to the result-set. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseBulkAPI
Specifies whether to use Shopify Bulk Operations for GraphQL schema.
解説
This property determines whether to use Shopify Bulk Operations for GraphQL schema. The driver automatically creates bulk query jobs and returns results as they become available.
BulkPageSize
The number of records to retrieve before returning results to the user when UseBulkAPI=true.
解説
The BulkPageSize indicates the number of records that are returned at a time when reading the data. In the background, the CData Sync App continues to read additional results from the data source. This connection property only has an impact when UseBulkAPI is set to true.
EnableShopifyPlus
If the app is installed on a Shopify Plus account, set to True.
解説
When this property is set to True, a few extra columns and tables will be pushed.
IncludeCustomFields
Set whether to include custom fields in the query to the Products and ProductVariants table. When set to false , performance increases, but you cannot read and update (only in REST) Products and ProductVariants custom fields.
解説
Set whether to include custom fields in the query to the Products and ProductVariants table. When set to false, performance increases, but you cannot read and update (only in REST) Products and ProductVariants custom fields.
MaxPointsPerCall
Specifies how many points a call will cost.
解説
The total cost of your queries cannot exceed 1,000 points at any given time, and that room is created in the app's bucket at a rate of 50 points per second.
MaxRows
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
解説
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other
これらの隠しプロパティは特定のユースケースでのみ使用されます。
解説
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
統合およびフォーマット
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Pagesize
The maximum number of results to return per page from Shopify. Set Pagesize to -1 to use the default value, for REST it will be 250 and for GRAPHQL it will be calculated based on the points.
解説
The Pagesize property affects the maximum number of results to return per page from Shopify. For the Rest schema Shopify allows a maximum of 250 records to be returned in each page.
PseudoColumns
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
解説
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
ShowAggregate
This property determines if aggregated values will be appended to the result-set.
解説
- None: No aggregate values will be appended to the result-set.
- PageSize: Each aggregated value will have the same amount of elements as the PageSize value.
Timeout
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
解説
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
UserDefinedViews
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
解説
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
- 各ルートエレメントはビューの名前を定義します。
- 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。