
こんにちは。プロダクトチームの周です。
Shopify REST Admin API は2024年10月1日をもってレガシーとなったことに伴い、Shopify 連携のCData 製品でご利用のデータモデルについて、「REST Data Model」から「GRAPHQL Data Model」への移行を強くお勧めいたします。REST とGRAPHQL データモデルでは、利用可能なテーブル、ビュー、ストアドプロシージャに仕様上の違いが数多くありますため、GRAPHQL への移行に際しては、これらの違いを十分にご確認いただいた上で、計画的な移行を実施していただく必要があります。本記事ではGRAPHQL への移行による主な変更点(Fulfillment,Inventory,Customers関連)を案内いたします。
※Productsに関連する主な変更点はこちらのブログ記事をご参照ください。
※Ordersに関連する主な変更点はこちらのブログ記事をご参照ください。
◆ Fulfillments (REST) → (GRAPHQL) Fulfillments
REST-2024-10. Fulfillments |
GRAPHQL-2024-10. Fulfillments |
GRAPHQLに関する注記 |
FulfillmentOrderId |
FulfillmentOrders.Id |
FulfillmentOrders.OrderId = Fulfillments.OrderId |
Id |
Id , LegacyResourceId |
GRAPHQLの「Id」はRESTと異なるフォーマットを持つグローバルID。 |
LocationId |
Locations.LegacyResourceId |
Locations.Id = Fulfillments.LocationId |
NotifyCustomer |
NotifyCustomer |
※最新ビルドにて対応 |
OrderId |
Orders.LegacyResourceId |
Orders.Id = Fulfillments.OrderId |
TrackingCompany |
TrackingInfoCompany |
※最新ビルドにて対応 |
TrackingNumbers |
TrackingInfoNumber |
|
TrackingUrls |
TrackingInfoUrl |
|
◆ FulfillmentOrders (REST) → (GRAPHQL) FulfillmentOrders
REST-2024-10. FulfillmentOrders |
GRAPHQL-2024-10. FulfillmentOrders |
GRAPHQLに関する注記 |
AssignedLocationId |
AssignedLocationLocationLegacyResourceId |
|
Id |
Id |
GRAPHQLの「Id」はRESTと異なるフォーマットを持つグローバルID。 |
OrderId |
Orders.LegacyResourceId |
Orders.Id = FulfillmentOrders.OrderId |
◆ InventoryLevels (REST-2024-04より削除) → (GRAPHQL) InventoryItemInventoryLevels
REST-2024-01. InventoryLevels |
GRAPHQL-2024-10. InventoryItemInventoryLevels |
GRAPHQLに関する注記 |
LocationId |
Locations.LegacyResourceId |
Locations.Id = InventoryItemInventoryLevels.LocationId |
InventoryItemId |
InventoryItems.LegacyResourceId |
InventoryItems.Id = InventoryItemInventoryLevels.InventoryItemId |
Available |
InventoryItemInventoryLevelQuantities.Quantity |
WHERE InventoryItemInventoryLevelQuantities.Name = 'available' |
UpdatedAt |
InventoryItemInventoryLevelQuantities.UpdatedAt |
WHERE InventoryItemInventoryLevelQuantities.Name = 'available' |
Operation |
→ ストアドプロシージャ InventorySetQuantities InventoryAdjustQuantities |
※最新ビルドにて対応 |
◆ Customers (REST) → (GRAPHQL) Customers
REST-2024-10. Customers |
GRAPHQL-2024-10. Customers |
GRAPHQLに関する注記 |
EmailMarketingLevel |
EmailMarketingConsentMarketingOptInLevel |
|
EmailMarketingState |
EmailMarketingConsentMarketingState |
|
EmailMarketingUpdatedAt |
EmailMarketingConsentConsentUpdatedAt |
|
Id |
Id |
GRAPHQLの「Id」はRESTと異なるフォーマットを持つグローバルID。 |
LastOrderName |
Orders.Name |
Customers.LastOrderId = Orders.Id |
OrdersCount |
NumberOfOrders |
|
State |
State |
GRAPHQLの場合は値が大文字表記。RESTは小文字 |
Tags |
Tags |
GRAPHQLの場合は値の形式が[Tag1, Tag2]、RESTはTag1,Tag2 |
TotalSpent |
AmountSpentAmount |
|
◆ CustomerAddresses (REST) → (GRAPHQL) CustomerAddresses
REST-2024-10. CustomerAddresses |
GRAPHQL-2024-10. CustomerAddresses |
GRAPHQLに関する注記 |
Id |
Id |
GRAPHQLの「Id」はRESTと異なるフォーマットを持つグローバルID。 |
CustomerUpdatedAt |
Customers.UpdatedAt |
Customers.Id = CustomerAddresses.CustomerId |
Name |
CustomerName |
|
FirstName |
Customers.FirstName |
Customers.Id = CustomerAddresses.CustomerId |
LastName |
Customers.LastName |
Customers.Id = CustomerAddresses.CustomerId |
CountryName |
Country |
|
Default |
✕ (GRAPHQL未対応) |
|
おわりに
本記事ではShopify API とデータモデルのREST からGRAPHQL への移行による主な変更点(Fulfillment,Inventory,Customers関連)を紹介しました。全ての変更点を網羅したリストではありませんが、ご不明な点がございましたら、お気軽に弊社サポートデスクにお問い合わせください。引き続きCData 製品をShopify へのデータ連携でご活用ください。
CData Shopify Drivers は30日間の無償トライアルが可能です。ぜひお試しくださいませ。
https://www.cdata.com/jp/drivers/shopify
関連コンテンツ