このページでは、CData Cloud でのShopify への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Shopify への接続

接続の確立 は、CData Cloud にデータベースを作成するためのShopify への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してShopify からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Shopify に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Shopify への接続

アクセストークン認証

アクセストークン経由の接続には、2つのステップが必要です。

1. Shopify の管理画面でアクセストークンを作成
2. アクセストークンを使用して認証

アクセストークンの作成

1. 管理画面からShopify にログインしApps -> Apps and sales channels に進みます。
2. Develop apps をクリックしてCreate an app を選択します。
3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択します。プロバイダーが必要とするAdmin API 権限は以下のとおりです：
   • read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
   • read_content, write_content
   • read_customer_merge
   • read_customers, write_customers
   • read_discounts, write_discounts
   • read_draft_orders, write_draft_orders
   • read_files, write_files
   • read_fulfillments, write_fulfillments
   • read_gift_card_transactions, write_gift_card_transactions
   • read_gift_cards, write_gift_cards
   • read_inventory, write_inventory
   • read_locations, write_locations
   • read_marketing_events, write_marketing_events
   • read_markets
   • read_metaobject_definitions
   • read_metaobjects
   • read_online_store_navigation, write_online_store_navigation
   • read_orders, write_orders
   • read_payment_terms
   • read_price_rules, write_price_rules
   • read_product_listings, write_product_listings
   • read_products, write_products
   • read_publications
   • read_reports, write_reports
   • read_resource_feedbacks, write_resource_feedbacks
   • read_returns, write_returns
   • read_script_tags, write_script_tags
   • read_shipping, write_shipping
   • read_shopify_payments_accounts
   • read_shopify_payments_bank_accounts
   • read_shopify_payments_payouts
   • read_store_credit_account_transactions, write_store_credit_account_transactions
   • read_store_credit_accounts
   • read_themes, write_themes
4. Save をクリックします。
5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。プロバイダーが必要とするStorefront API 権限は以下のとおりです：
   • unauthenticated_read_content
6. Save をクリックします。
7. API Credentials を選択します。
8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます。
9. Admin API Access token のアクセストークンをコピーします。NOTE：トークンの公開およびコピーは1回のみ可能です。

アクセストークンによる認証

• AuthScheme：AccessToken に設定。
• AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定。

OAuth 認証

OAuth クライアント認証

Shopify は、クライアントクレデンシャル付与フローを使用したOAuth 認証をサポートしています。カスタムOAuth アプリケーションを作成し、必要なスコープを定義し、データを取得するストアにアプリケーションをインストールする必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。

Note： クライアントクレデンシャルフローは、自組織が開発し、所有するストアにインストールされたアプリにのみ利用可能です。

接続するには次のプロパティを設定します。

• AuthScheme：クライアントクレデンシャルグラントタイプで認証を行う場合は、OAuthClient に設定。
• OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。

カスタムOAuth アプリケーションの作成

Cloud はShopify に登録されていないため、Web、デスクトップ、ヘッドレスサーバー経由で接続するには、カスタムOAuth クレデンシャルを使用する必要があります。 アプリを登録し、OAuthClientId およびOAuthClientSecret などのクライアントクレデンシャルを取得するには、以下の手順に従います。

1. Shopify の開発者ダッシュボードにログインします。
2. Apps -> Create app を選択します。
3. アプリケーションの名前を入力してCreate をクリックします。
4. Access セクションで、必要なスコープ（接続の確立 を参照）とリダイレクトURL を指定します。
   • デスクトップでの認証の場合、リダイレクトURL をローカルホスト（例えばプロバイダーのデフォルトであるhttp://localhost:33333）に設定できます。
   • Web の認証では、任意の別のポートを選択してCallbackURL を定義した正確なリプライURL に設定します。
5. Release をクリックします。
6. 必要に応じてバージョンの名前とメッセージを入力し、再度Release をクリックします。
7. Settings タブを選択して、クライアントID とシークレットを表示し、記録します。
8. Home タブを選択します。ここから、必要に応じて特定のストアにアプリをインストールしたり、配布方法を選択したりできます。

これで、クライアントID とシークレットの認証情報を使用してストアのデータにアクセスできます。

GraphQL API のレートリミット

ポイントベースのレート制限

GraphQL は、REST API が対処するように設計されていなかった欠点を克服するために作成されました。GraphQL には多くの利点がありますが、その1つはREST API で利用可能なデータをすべて取得するために必要なHTTP コール数を減らすことができることです。

ただし、GraphQL Admin API の呼び出しは推定クエリコストに基づいて制限されるため、リクエストの量よりも、時間の経過に伴うクエリのコストを考慮する必要があります。

ポイントは非常に単純な方法で機能します。アプリとストアの組み合わせごとに1000コストポイントのバケットが与えられ、1秒あたり50コストポイントのリークレートが設定されています。つまり、クエリの総コストは常に1,000ポイントを超えることはできず、アプリのバケットのスペースは毎秒50ポイントのレートで作成されます。平たく言えば、一般的なプランでは1秒ごとに50ポイントが与えられます。データの編集、作成、削除を必要とするミューテーションは10ポイント消費します。一方、単一のオブジェクトを取得するコストは1ポイントにすぎません。 たとえば、1つの注文データが必要で、その注文の各ラインアイテムも必要だとしましょう。これは1ポイントでは済みません。注文に10のラインアイテムが含まれている場合、それぞれの項目に1ポイント、注文自体に1ポイント、合計11ポイントがかかります。

要求されたコストと実際のクエリコストが組み合わされて制限が設定されます。クエリを実行する前に、アプリのバケットには、要求されたコストに対して十分な容量が必要です。クエリが完了すると、要求されたクエリコストと実際のクエリコストの差額がバケットに返済されます。

要求コストとスロットルの状態は応答に含まれます。extensions キーの下には次の情報が返されます：

"extensions": {
    "cost": {
      "requestedQueryCost": 101,
      "actualQueryCost": 46,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 954,
        "restoreRate": 50
      }
    }
  }
  

これらを考慮して、ドライバーは、スロットリングを避けるために要求ごとに取得できる適切なデータ量を計算する必要があります。テーブルのページサイズは、GraphQL API の制限に適合するように、テーブル内のフィールド数とデータ数に基づいて自動的に計算されます。計算されるページサイズが小さいために、GraphQL の大きなテーブルに対するパフォーマンスが不足する可能性があります。別の方法として、MaxPointsPerCall を増やし、ページサイズを強制的に増加させることもできますが、 スロットリングが起こる可能性が高いため、お勧めしません。

GraphQL Bulk API

データレプリケーションタスクでは、単一のクエリではなく、一括操作を使用することをお勧めします。

一括操作は大量のデータを扱うことを目的としており、単一のクエリと同じコストやレートの制約はありません。バルククエリを利用しない場合は、データセットをページ分割する必要があります。たとえばREST の場合、応答に含めることができる要素は250までです。GraphQL はコストベースですが、それでも要求ごとに特定の数に制限されます。

Bulk Operation API では、これは該当しません。そのため、GraphQL スキーマを使用する場合は、接続文字列でUseBulkAPI をTRUE に設定し、ページネーションやスロットリングを心配することなく大量のデータを取得することをお勧めします。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud は、Shopify API のエンティティを、テーブル、ビュー、ストアドプロシージャを使用した使いやすいSQL データベースとしてモデル化します。これらは、スキーマファイルで定義されます。スキーマファイルは、データの構造と構成を定義する、シンプルで読みやすいテキストファイルです。

ドライバーは2つのスキーマを公開しており、Schema で選択します。

• REST API Version 2025-04 で利用可能なエンティティについては、REST Data Model を参照してください。
  • Note： 2024年10月1日より、Shopify はREST API をlegacy として指定しました。
• GraphQL API Version 2025-04 で利用可能なエンティティについては、GRAPHQL Data Model を参照してください。

Note： Shopify は通常、四半期ごとに新しいAPI バージョンをリリースします。安定版のAPI バージョンがサポートされなくなった場合、Shopify はAPI リクエストに応答するために、サポートされている最も古い安定版に自動的にデフォルト設定します。Shopify のAPI バージョニングの詳細については、このリンクをクリックしてください。

柔軟なスキーマ

CData Cloud は準動的ドライバーです。つまり、静的スキーマを公開しますが、カスタムフィールド（例：Products テーブルやProductVariants テーブル）から動的なカラムを取得することもできます。いずれかのAPI スキーマ（REST またはGraphQL）でこの機能を有効にするには、IncludeCustomFields の手順に従ってください。カスタムフィールドの検索は250行に制限されていることに注意してください。

The CData Cloud models entities in the Shopify API as an easy-to-use SQL database, using tables, views, and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data.

Note: Shopify typically releases new API versions quarterly. If a stable API version is no longer supported, Shopify automatically defaults to the oldest supported stable version to respond to your API request. For more information on Shopify's API versioning, click this link.

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.

The CData Cloud models the Shopify API as relational tables, views, and stored procedures.

To use the REST Data Model, simply set Schema to REST.

Note: As of October 1, 2024, Shopify has designated the REST API as legacy.

Tables

The テーブル section, which details standard SQL tables, and the ビュー section, which lists read-only SQL tables, contain samples of what you might have access to in your Shopify account.

Common tables include:

Stored Procedures

ストアドプロシージャ are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing order cancellations and fulfillments, sending invoices, and handling authentication flows.

Cloud はShopify のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Shopify テーブル

Create or view Application Charges for Billing.

Table-Specific Information

Select

SELECT * FROM ApplicationCharges WHERE Id = '123'

Insert

INSERT INTO ApplicationCharges ( Test ) VALUES ( 'true' )

Columns

Create or view Application Credit for Billing.

Table-Specific Information

Select

SELECT * FROM ApplicationCredit WHERE Id = '123'

Insert

INSERT INTO ApplicationCredit (Amount, Description, Test) VALUES ('100', 'success or failure', 'true')

Columns

Create, read, update or delete articles

Table-Specific Information

Select

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

Create, read, update or delete assets. CUD support is no longer accessible for public apps.

Table-Specific Information

Select

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', '', '282977') 

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

Create, read, update or delete blogs

Table-Specific Information

Select

• 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

Returns a list of resource feedback objects..

Table-Specific Information

Select

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

Query and delete information regarding different collects.

Table-Specific Information

Select

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

Query, insert, or delete information regarding different collects.

Table-Specific Information

Select

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

Create, read, update and delete the comments.

Table-Specific Information

Select

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

Create, select, update, and delete information regarding countries.

Table-Specific Information

Select

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

Query, insert, update, or delete information regarding different custom collections.

Table-Specific Information

Select

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

Create, update, delete, and query customer addresses.

Table-Specific Information

Select

• 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

Create, update, delete, and query customers.

Table-Specific Information

Select

• 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

Pseudo-Columns

疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。

Create, select, update, and delete information regarding discount codes.

Table-Specific Information

Select

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

Create, update, delete, and query draft orders.

Table-Specific Information

Select

The Cloud 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 Cloud processes other filters client-side within the Cloud.

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

Pseudo-Columns

疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。

Create, delete, and query information regarding fulfillment events.

Table-Specific Information

Select

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

Create, update, and query fulfillments.

Table-Specific Information

Select

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 = '5729988903171'
  
  SELECT * FROM Fulfillments WHERE OrderId = '5729988903171' AND Id = '5165361791235'
  
  SELECT * FROM Fulfillments WHERE FulfillmentOrderId = '6817622622467'

• 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 all line items.
  

  INSERT INTO Fulfillments (FulfillmentOrderId) VALUES ('6817622622467')

• Fulfill one line item using aggregates.

  You must specify the fulfillment order line item id and the quantity to be fulfilled in the aggregate.

  Note: To obtain the fulfillment order line item id, you can query the Id column in the FulfillmentOrderLineItems table.
  

  INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('6817622622467','[{\"id\":14179445244163,\"quantity\":5}]')

• 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, ItemQuantity) Values ('14179445244163', '5')

  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 LineAggregate the name of the temporary table. For instance:
  

  Insert INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('6817622622467', '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, LineAggregate) VALUES ('6817622622467', '1448280087', 'OrdersItems#TEMP')

• Fulfill many line items using aggregates.
  

  INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('6817622622467', '[{\"id\":14179445244163,\"quantity\":5},{\"id\":14179445276931,\"quantity\":2}]')

• Fulfill many line items using temporary table.
  

  INSERT INTO OrdersItems#Temp (ItemId, ItemQuantity) Values ('14179445244163', '5')
  INSERT INTO OrdersItems#Temp (ItemId, ItemQuantity) Values ('14179445276931', '2')
  INSERT INTO Fulfillments (FulfillmentOrderId, LineAggregate) VALUES ('6817622622467', 'OrdersItems#TEMP')

• Fulfill all line items, notify the customer, and set a tracking number.
  

  INSERT INTO Fulfillments (FulfillmentOrderId, TrackingNumbers, NotifyCustomer) VALUES ('6817622622467', 'FEDEX1', true)

• Complete a fulfillment (you must specify the Id of the fulfillment as well).
  

  INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('6817622622467', '5165361791235', '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 ('6817622622467', '5165361791235', 'Open')

• Cancel a fulfillment (you must specify Id of the fulfillment as well).
  

  INSERT INTO Fulfillments (FulfillmentOrderId, Id, Status) VALUES ('6817622622467', '5165361791235', 'Cancel')

Update

You must specify the OrderId and Id of the fulfillment to fulfill an order.

UPDATE Fulfillments SET TrackingNumbers = 'FedEx123,UPS123' WHERE OrderId = '5729988903171' AND Id = '5165361791235'

Columns

Query, create, update, and delete information regarding different fulfillment services.

Table-Specific Information

Select

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

Create, update, delete, and query gift cards.

Table-Specific Information

Select

The Cloud uses the Shopify API to process WHERE clause conditions built with the following column and operator. The Cloud processes other filters client-side within the Cloud.

• Id supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM GiftCards
  SELECT * FROM GiftCards WHERE Id = 123

Columns

Create, update, delete, and query marketing events.

Table-Specific Information

Select

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

Retrieves a list of metafields that belong to a resource.

View-Specific Information

OwnerResource or the metafield Id is required for any query against Metafields.

OwnerResource must be one of the following values:

• shop
• draft_order
• page
• article
• order
• customer
• collection
• blog

Any other value will run the query against "shop" instead.

Select

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 = 'order'

SELECT * FROM Metafields WHERE OwnerId = 64146833431 AND OwnerResource IN ('order', 'customer')

SELECT * FROM Metafields WHERE OwnerId IN (64146833430, 64146833431) AND OwnerResource = 'order'

SELECT * FROM Metafields WHERE OwnerResource = 'customer' AND OwnerId IN (SELECT Id FROM Customers);

SELECT * FROM Metafields WHERE OwnerResource = 'order' AND OwnerId = '64146735127' AND UpdatedAt >= '2021-10-13T05:55:08-04:00';

SELECT * FROM Metafields WHERE OwnerResource = 'order' 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