Shopify (独立した発行元) (プレビュー)
Shopifyのマーチャントが注文を受け取り、処理し、管理するための REST インターフェイス。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Ray Bennett (MSFT) |
| Website | https://www.shopify.com/ |
| プライバシー ポリシー | https://www.shopify.com/legal/privacy |
| カテゴリ | 生産性 |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | securestring | この API のアクセス トークン。 | 正しい |
| ストア URL | 文字列 | Shopify ストアの URL | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 注文の一覧を取得します。 |
指定した条件を満たす注文の一覧を取得します。 |
| 注文をキャンセルする |
ID で注文を取り消します。 |
| 注文を更新します |
指定された情報を使用して注文を更新します。 |
| 顧客の一覧を取得します |
指定した条件を満たす顧客の一覧を取得します。 |
注文の一覧を取得します。
指定した条件を満たす注文の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
注文 ID
|
ids | string |
注文 ID のコンマ区切りリストで指定された注文のみを取得します。 |
|
|
極限
|
limit | string |
ページに表示する結果の最大数。 |
|
|
Since ID
|
since_id | string |
指定した ID の後に注文を表示します。 |
|
|
最小で作成
|
created_at_min | string |
日付以降に作成された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最大で作成
|
created_at_max | string |
日付以前に作成された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最小で更新
|
updated_at_min | string |
最終更新日以降の注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最大で更新
|
updated_at_max | string |
最終更新日以前の注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最小で処理
|
processed_at_min | string |
日付以降にインポートされた注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最大で処理
|
processed_at_max | string |
日付以前にインポートされた注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
属性アプリ ID
|
attribution_app_id | string |
アプリ ID で指定された、特定のアプリに属性付けされた注文を表示します。 |
|
|
注文の状態
|
status | string |
注文を状態でフィルター処理します。 |
|
|
財務状況
|
financial_status | string |
財務状態で注文をフィルター処理します。 |
|
|
フルフィルメントの状態
|
fulfillment_status | string |
注文をフルフィルメント状態でフィルター処理します。 |
|
|
Fields
|
fields | string |
フィールドのコンマ区切りのリストで指定された特定のフィールドのみを取得します。 |
|
|
レコードのシーケンス順序
|
order | string |
並べ替え順序のフィールドと方向。 方向を指定するには、クエリ パラメーターの末尾に 'asc' または ' desc' を追加します。 例: 'order=updated_at asc'。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
orders
|
orders | array of order |
注文をキャンセルする
ID で注文を取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
注文 ID
|
order_id | True | string |
キャンセルされる注文の ID。 |
|
払い戻し 実際の金額
|
amount | string |
払い戻しする金額。 設定されている場合、Shopifyはステータスに応じて支払いを無効または払い戻そうとします。 Shopifyで元の取引が行われなかった場合、Shopifyは手動ゲートウェイを通じて払い戻しを行います。 手動ゲートウェイを介した払い戻しは Shopify の払い戻しとして記録されますが、顧客は払い戻されません。 |
|
|
払い戻し通貨
|
currency | string |
注文がキャンセルされたときに発行される払い戻しの通貨。 金額プロパティが指定されるたびに、複数通貨の注文に必要です。 |
|
|
払い戻しされたアイテムを再在庫する
|
restock | string |
払い戻されたアイテムをストアの在庫に戻すかどうか。 |
|
|
注文の取り消し理由
|
reason | string |
注文の取り消しの理由。 有効な値: 顧客、在庫、不正行為、拒否、その他。 |
|
|
キャンセルメール
|
string |
キャンセルを通知する電子メールを顧客に送信するかどうか。 |
||
|
払い戻し
|
refund | string |
実行する払い戻しトランザクション。 |
|
|
|
object |
戻り値
注文
- Body
- order
注文を更新します
指定された情報を使用して注文を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
注文 ID
|
order_id | True | string |
更新される注文の ID。 |
|
|
object |
戻り値
注文
- Body
- order
顧客の一覧を取得します
指定した条件を満たす顧客の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
顧客 ID
|
ids | string |
ID のコンマ区切りリストで指定された顧客に結果を制限します。 |
|
|
Since ID
|
since_id | string |
指定した ID の後の結果を制限します。 |
|
|
最小で作成
|
created_at_min | string |
指定した日付より後に作成された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最大で作成
|
created_at_max | string |
指定した日付より前に作成された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
最小で更新
|
updated_at_min | string |
指定した日付 (形式: 2014-04-25T16:15:47-04:00) の後に最後に更新された顧客を表示します。 |
|
|
最大で更新
|
updated_at_max | string |
指定した日付より前に最後に更新された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
極限
|
limit | string |
表示する結果の最大数。 (既定値: 50)(最大: 250)。 |
|
|
Fields
|
fields | string |
フィールドのコンマ区切りのリストで指定された特定のフィールドのみを表示します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
customers
|
customers | array of customer |
定義
順序
注文
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
注文を作成したアプリの ID。 |
|
メール
|
string |
顧客のメール アドレス。 |
|
|
closed_at
|
closed_at | string |
注文が閉じられた日時 (ISO 8601 形式)。 注文が閉じていない場合は null を返します。 |
|
作成日時
|
created_at | string |
店舗通貨の 3 文字コード (ISO 4217 形式)。 |
|
updated_at
|
updated_at | string |
注文が最後に変更された日時 (ISO 8601 形式)。 |
|
数値
|
number | integer |
店舗の注文数における注文の位置。 数値はシーケンシャルで、1 から始まります。 |
|
手記
|
note | string |
ショップの所有者が注文に添付できる省略可能なメモ。 |
|
トークン
|
token | string |
順序を参照するときの一意の値。 |
|
ゲートウェイ
|
gateway | string |
使用された支払いゲートウェイ。 |
|
テスト
|
test | boolean |
これがテスト順序かどうか。 |
|
total_price
|
total_price | string |
すべての品目価格、割引、出荷、税金、およびショップ通貨のヒントの合計。 正である必要があります。 |
|
subtotal_price
|
subtotal_price | string |
割引後、出荷前の店舗通貨での注文の価格、職務、税金、およびヒント。 |
|
total_weight
|
total_weight | integer |
すべての行項目の重みの合計 (グラム単位)。 アイテムが注文から削除されるため、合計は調整されません。 |
|
total_tax
|
total_tax | string |
店舗通貨での注文に適用されるすべての税金の合計。 正である必要があります。 |
|
taxes_included
|
taxes_included | boolean |
税が注文小計に含まれるかどうか。 |
|
通貨
|
currency | string |
店舗通貨の 3 文字コード (ISO 4217 形式)。 |
|
financial_status
|
financial_status | string |
注文に関連付けられている支払の状態。 注文の作成時にのみ設定できます。 |
|
確認
|
confirmed | boolean |
注文が確定しました。 |
|
total_discounts
|
total_discounts | string |
店舗通貨での注文の価格に適用される割引の合計。 |
|
total_line_items_price
|
total_line_items_price | string |
店舗通貨でのすべての品目価格の合計。 |
|
cart_token
|
cart_token | string |
注文に関連付けられているカートを参照するときの一意の値。 |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
顧客がショップから電子メールの更新を受信することを同意したかどうか。 |
|
名前
|
name | string |
注文名。order_number プロパティと、マーチャントの全般設定で設定されている注文プレフィックスとサフィックスを組み合わせて生成されます。 |
|
referring_site
|
referring_site | string |
顧客がショップへのリンクをクリックした Web サイト。 |
|
landing_site
|
landing_site | string |
購入者がショップに入ったときに着陸したページの URL。 |
|
cancelled_at
|
cancelled_at | string |
注文が取り消された日時。 注文が取り消されない場合は null を返します。 |
|
cancel_reason
|
cancel_reason | string |
注文が取り消された理由。 |
|
total_price_usd
|
total_price_usd | string |
合計価格 usd。 |
|
checkout_token
|
checkout_token | string |
注文に関連付けられているチェックアウトを参照するときの一意の値。 |
|
参照
|
reference | string |
注文の参照。 |
|
user_id
|
user_id | integer |
注文を処理した Shopify POS にログインしたユーザーの ID (該当する場合)。 |
|
location_id
|
location_id | integer |
注文が処理された物理的な場所の ID。 注文に対して場所を参照する必要がある場合は、FulfillmentOrder リソースを使用します。 |
|
source_identifier
|
source_identifier | string |
ソース識別子。 |
|
source_url
|
source_url | string |
ソース URL。 |
|
processed_at
|
processed_at | string |
注文が処理された日時 (ISO 8601 形式)。 |
|
device_id
|
device_id | string |
デバイスの ID。 |
|
phone
|
phone | string |
SMS 通知を受信するための顧客の電話番号。 |
|
customer_locale
|
customer_locale | string |
2 文字または 3 文字の言語コード。必要に応じて、領域修飾子が続きます。 |
|
app_id
|
app_id | integer |
注文を作成したアプリの ID。 |
|
browser_ip
|
browser_ip | string |
注文時に顧客が使用するブラウザーの IP アドレス。 |
|
landing_site_ref
|
landing_site_ref | string |
ランディング サイトの参照。 |
|
order_number
|
order_number | integer |
1001 から始まる店舗の注文数における注文の位置。 |
|
discount_applications
|
discount_applications | discount_applications |
マーチャントまたはShopifyスクリプトによって定義された割引アプリケーションの説明。 |
|
discount_codes
|
discount_codes | discount_codes |
注文に適用される割引の一覧。 |
|
note_attributes
|
note_attributes | note_attributes |
注文に追加される追加情報。 |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
注文に使用される支払いゲートウェイの一覧。 |
|
processing_method
|
processing_method | string |
支払い方法。 |
|
checkout_id
|
checkout_id | integer |
チェックアウト ID。 |
|
source_name
|
source_name | string |
注文が発生した場所。 |
|
fulfillment_status
|
fulfillment_status | string |
フルフィルメントされた品目の観点から見た注文の状態。 |
|
tax_lines
|
tax_lines | tax_lines |
品目に適用される税の詳細を示す税明細行オブジェクトの一覧。 |
|
tags
|
tags | string |
順序に添付されたタグ。コンマ区切りの値の文字列として書式設定されます。 タグは、フィルター処理と検索に一般的に使用される追加の短い記述子です。 |
|
contact_email
|
contact_email | string |
連絡先の電子メール。 |
|
order_status_url
|
order_status_url | string |
注文状態 Web ページを指す URL (該当する場合)。 |
|
presentment_currency
|
presentment_currency | string |
顧客に価格を表示するために使用された表示通貨。 |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
|
shipping_lines
|
shipping_lines | shipping_lines |
使用した配送方法の詳細。 |
|
billing_address
|
billing_address | billing_address |
支払い方法に関連付けられている郵送先住所。 この住所は、支払い方法を必要としない注文では使用できない省略可能なフィールドです。 |
|
shipping_address
|
shipping_address | shipping_address |
注文が出荷される宛先の住所。 この住所は省略可能であり、配送を必要としない注文では使用できません。 |
|
client_details
|
client_details | client_detail |
顧客が注文したときに使用したブラウザーに関する情報。 |
|
payment_details
|
payment_details | payment_detail |
支払に関する情報を格納しているオブジェクト。 |
|
顧客
|
customer | customer |
顧客に関する情報。 |
|
line_items
|
line_items | line_items | |
|
fulfillments
|
fulfillments | fulfillments |
注文に関連付けられているフルフィルメントの配列。 |
|
払い戻し
|
refunds | refunds |
払い戻し |
顧客
顧客に関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
顧客の一意識別子。 |
|
メール
|
string |
顧客の一意の電子メール アドレス。 複数の顧客に同じメール アドレスを割り当てようとすると、エラーが返されます。 |
|
|
accepts_marketing
|
accepts_marketing | boolean |
顧客が電子メールでマーケティング資料を受信することを同意したかどうか。 |
|
作成日時
|
created_at | string |
顧客が作成された日時 (ISO 8601 形式)。 |
|
updated_at
|
updated_at | string |
顧客情報が最後に更新された日時 (ISO 8601 形式)。 |
|
first_name
|
first_name | string |
顧客の名。 |
|
last_name
|
last_name | string |
顧客の姓。 |
|
orders_count
|
orders_count | integer |
この顧客に関連付けられている注文の数。 |
|
状態
|
state | string |
店舗を持つ顧客のアカウントの状態。 既定値: 無効。 |
|
total_spent
|
total_spent | string |
顧客が注文履歴全体に費やした金額の合計。 |
|
last_order_id
|
last_order_id | integer |
顧客の最後の注文の ID。 |
|
手記
|
note | string |
顧客に関するメモ。 |
|
verified_email
|
verified_email | boolean |
顧客が自分のメール アドレスを確認したかどうか。 |
|
multipass_identifier
|
multipass_identifier | string |
Multipass ログインで使用される顧客の一意識別子。 |
|
tax_exempt
|
tax_exempt | boolean |
顧客が注文に対する税金の支払いを免除されているかどうか。 true の場合、チェックアウト時の注文には税金は適用されません。 false の場合、チェックアウト時に税金が適用されます。 |
|
phone
|
phone | string |
この顧客の一意の電話番号 (E.164 形式)。 複数の顧客に同じ電話番号を割り当てようとすると、エラーが返されます。 |
|
tags
|
tags | string |
店の所有者が顧客に添付したタグ。コンマ区切りの値の文字列として書式設定されます。 顧客は最大 250 個のタグを持つことができます。 各タグの文字数は最大 255 文字です。 |
|
last_order_name
|
last_order_name | string |
顧客の最後の注文の名前。 これは、Order リソースの名前フィールドに直接関連しています。 |
|
通貨
|
currency | string |
顧客が最後の注文に支払ったときに使用した通貨の 3 文字コード (ISO 4217 形式)。 |
|
住所
|
addresses | addresses |
顧客の最近更新された 10 個のアドレスの一覧。 |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
顧客が電子メールでマーケティング資料を受信することに同意または反対した日時 (ISO 8601 形式)。 |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
顧客が電子メールでマーケティング資料を受け取ることを同意したときに指定したマーケティング サブスクリプションオプトイン レベル。 |
|
tax_exemptions
|
tax_exemptions | array of |
顧客が注文に対する特定の税金の支払いを免除されているかどうか。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
|
default_address
|
default_address | default_address |
default_address
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
アドレスの一意識別子。 |
|
customer_id
|
customer_id | integer |
顧客の一意識別子。 |
|
first_name
|
first_name | string |
顧客の名。 |
|
last_name
|
last_name | string |
顧客の姓。 |
|
会社
|
company | string |
顧客の会社。 |
|
住所1
|
address1 | string |
顧客の郵送先住所の最初の行。 |
|
住所2
|
address2 | string |
顧客の郵送先住所の追加フィールド。 |
|
city
|
city | string |
顧客の都市、町、または村。 |
|
州
|
province | string |
顧客のリージョン名。 通常は、都道府県、都道府県、または都道府県です。 |
|
country
|
country | string |
顧客の国。 |
|
ジップ
|
zip | string |
顧客の郵便番号 (郵便番号、Eircode などとも呼ばれます)。 |
|
phone
|
phone | string |
この住所にある顧客の電話番号。 |
|
名前
|
name | string |
顧客の姓と名。 |
|
province_code
|
province_code | string |
顧客の地域の 2 文字のコード。 |
|
country_code
|
country_code | string |
顧客の国に対応する 2 文字の国コード。 |
|
country_name
|
country_name | string |
顧客の正規化された国名。 |
|
デフォルト
|
default | boolean |
既定のアドレスごとに true を返します。 |
shipping_address
注文が出荷される宛先の住所。 この住所は省略可能であり、配送を必要としない注文では使用できません。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
first_name
|
first_name | string |
配送先住所に関連付けられているユーザーの名。 |
|
住所1
|
address1 | string |
配送先住所の番地。 |
|
phone
|
phone | string |
配送先住所の電話番号。 |
|
city
|
city | string |
配送先住所の市区町村または村。 |
|
ジップ
|
zip | string |
配送先住所の郵便番号 (郵便番号、Eircode など)。 |
|
州
|
province | string |
配送先住所の地域 (都道府県、都道府県、都道府県など) の名前。 |
|
country
|
country | string |
配送先住所の国の名前。 |
|
last_name
|
last_name | string |
配送先住所に関連付けられているユーザーの姓。 |
|
住所2
|
address2 | string |
配送先住所の住所の追加フィールド (省略可能)。 |
|
会社
|
company | string |
配送先住所に関連付けられているユーザーの会社。 |
|
緯度 (latitude)
|
latitude | float |
配送先住所の緯度。 |
|
経度 (longitude)
|
longitude | float |
配送先住所の経度。 |
|
名前
|
name | string |
支払い方法に関連付けられているユーザーの完全な名前。 |
|
country_code
|
country_code | string |
配送先住所の国の 2 文字コード (ISO 3166-1 形式)。 |
|
province_code
|
province_code | string |
配送先住所の地域の 2 文字の省略形。 |
billing_address
支払い方法に関連付けられている郵送先住所。 この住所は、支払い方法を必要としない注文では使用できない省略可能なフィールドです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
first_name
|
first_name | string |
支払い方法に関連付けられているユーザーの名。 |
|
住所1
|
address1 | string |
請求先住所の番地。 |
|
phone
|
phone | string |
請求先住所の電話番号。 |
|
city
|
city | string |
請求先住所の市区町村または村。 |
|
ジップ
|
zip | string |
請求先住所の郵便番号 (郵便番号、Eircode など)。 |
|
州
|
province | string |
請求先住所のリージョン (都道府県、都道府県、都道府県など) の名前。 |
|
country
|
country | string |
請求先住所の国の名前。 |
|
last_name
|
last_name | string |
支払い方法に関連付けられているユーザーの姓。 |
|
住所2
|
address2 | string |
請求先住所の番地のオプションの追加フィールド。 |
|
会社
|
company | string |
請求先住所に関連付けられているユーザーの会社。 |
|
緯度 (latitude)
|
latitude | float |
請求先住所の緯度。 |
|
経度 (longitude)
|
longitude | float |
請求先住所の経度。 |
|
名前
|
name | string |
支払い方法に関連付けられているユーザーの完全な名前。 |
|
country_code
|
country_code | string |
請求先住所の国の 2 文字コード (ISO 3166-1 形式)。 |
|
province_code
|
province_code | string |
請求先住所のリージョンの 2 文字の省略形。 |
住所
顧客の最近更新された 10 個のアドレスの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
default_address |
shipping_line
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
グローバルに一意の識別子。 |
|
title
|
title | string |
配送方法のタイトル。 |
|
価格
|
price | string |
この配送方法の価格 (店舗通貨)。 |
|
コード
|
code | string |
配送方法への参照。 |
|
ソース
|
source | string |
配送方法のソース。 |
|
phone
|
phone | string |
配送先住所の電話番号。 |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
配送方法に対して要求されているフルフィルメント サービスへの参照。 配送方法がサードパーティのフルフィルメントサービスによる処理を必要とする場合に提示する。それ以外の場合は null。 |
|
delivery_category
|
delivery_category | string |
配信カテゴリ。 |
|
carrier_identifier
|
carrier_identifier | string |
料金を提供した運送業者サービスへの参照。 サード パーティの運送業者サービスによってレートが計算された場合に表示されます。 |
|
discounted_price
|
discounted_price | string |
ラインレベルの割引が適用された後の配送方法の価格。 カート レベルまたは注文レベルの割引は反映されません。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
割引アプリケーションによって割り当てられた金額の順序付きリスト。 |
|
tax_lines
|
tax_lines | tax_lines |
品目に適用される税の詳細を示す税明細行オブジェクトの一覧。 |
client_detail
顧客が注文したときに使用したブラウザーに関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
ブラウザーの IP アドレス。 |
|
accept_language
|
accept_language | string |
ブラウザーで認識される言語とロケール。 |
|
user_agent
|
user_agent | string |
ソフトウェアとオペレーティング バージョンを含む、閲覧クライアントの詳細。 |
|
session_hash
|
session_hash | string |
セッションのハッシュ。 |
|
browser_width
|
browser_width | integer |
ブラウザー画面の幅 (使用可能な場合) (ピクセル単位)。 |
|
browser_height
|
browser_height | integer |
ブラウザーの画面の高さ (使用可能な場合) (ピクセル単位)。 |
payment_detail
支払に関する情報を格納しているオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
顧客のクレジット カードの発行者識別番号 (以前は銀行 ID 番号 (BIN) と呼ばれる IIN)。 |
|
avs_result_code
|
avs_result_code | string |
アドレス確認システム (AVS) からの応答コード。 コードは 1 文字です。 |
|
cvv_result_code
|
cvv_result_code | string |
顧客がカード セキュリティ コード (カード検証値) を正しく入力したかどうかを示すクレジット カード会社からの応答コード。 コードは 1 文字または空の文字列です。 |
|
credit_card_number
|
credit_card_number | string |
顧客のクレジット カード番号。先頭の数字の大部分が編集されています。 |
|
credit_card_company
|
credit_card_company | string |
顧客のクレジット カードを発行した会社の名前。 |
subtotal_tax_discount_price_set
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
量
|
shop_money.amount | string |
実際の金額。 |
|
currency_code
|
shop_money.currency_code | string |
ISO 4217 形式。 |
|
量
|
presentment_money.amount | string |
実際の金額。 |
|
currency_code
|
presentment_money.currency_code | string |
ISO 4217 形式。 |
line_item_property
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
製品名。 |
|
value
|
value | string |
製品の値。 |
line_item_properties
プロパティ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
line_item_property |
履行
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
フルフィルメントの ID。 |
|
order_id
|
order_id | integer |
注文の一意の数値識別子。 |
|
状態
|
status | string |
フルフィルメントの状態。 |
|
作成日時
|
created_at | string |
フルフィルメントが作成された日時。 |
|
サービス
|
service | string |
使用されるサービスの種類。 |
|
updated_at
|
updated_at | string |
フルフィルメントが最後に変更された日時 (ISO 8601 形式)。 |
|
tracking_company
|
tracking_company | string |
追跡会社の名前。 |
|
shipment_status
|
shipment_status | string |
フルフィルメントの現在の出荷状態。 |
|
location_id
|
location_id | integer |
フルフィルメントを処理する必要がある場所の一意識別子。 |
|
tracking_number
|
tracking_number | string |
配送会社によって提供される追跡番号。 |
|
tracking_numbers
|
tracking_numbers | array of string |
配送会社によって提供される追跡番号の一覧。 |
|
tracking_url
|
tracking_url | string |
フルフィルメントの追跡ページの URL。 |
|
tracking_urls
|
tracking_urls | array of string |
フルフィルメントの追跡ページの URL。 |
|
領収書
|
receipt | receipt |
レシートに関する情報を提供するテキスト フィールド。 |
|
名前
|
name | string |
一意に識別されるフルフィルメント名。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
|
line_items
|
line_items | line_items |
fulfillments
注文に関連付けられているフルフィルメントの配列。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
fulfillment |
トランザクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
トランザクションの ID。 |
|
order_id
|
order_id | integer |
トランザクションが関連付けられている注文の ID。 |
|
kind
|
kind | string |
トランザクションの種類。 |
|
ゲートウェイ
|
gateway | string |
トランザクションが発行されたゲートウェイの名前。 |
|
状態
|
status | string |
トランザクションの状態。 |
|
メッセージ
|
message | string |
トランザクションが成功または失敗した理由に関する追加情報を含む、支払いプロバイダーによって生成された文字列。 |
|
作成日時
|
created_at | string |
トランザクションが作成された日時 (ISO 8601 形式)。 |
|
テスト
|
test | boolean |
トランザクションがテスト トランザクションかどうか。 |
|
承認
|
authorization | string |
トランザクションに関連付けられている承認コード。 |
|
location_id
|
location_id | string |
トランザクションが処理された物理的な場所の ID。 |
|
user_id
|
user_id | string |
注文の処理時に Shopify POS デバイスにログインしたユーザーの ID (該当する場合)。 |
|
parent_id
|
parent_id | integer |
関連付けられているトランザクションの ID。 |
|
processed_at
|
processed_at | string |
トランザクションが処理された日時 (ISO 8601 形式)。 |
|
device_id
|
device_id | string |
デバイスの ID。 |
|
error_code
|
error_code | string |
支払いプロバイダーに依存しない標準化されたエラー コード。 |
|
source_name
|
source_name | string |
トランザクションの発生元。 これは Shopify によって設定され、オーバーライドすることはできません。 |
|
量
|
amount | string |
トランザクションに含まれる金額。 |
|
通貨
|
currency | string |
支払いに使用される通貨の 3 文字コード (ISO 4217 形式)。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
トランザクション
払い戻しに関係するトランザクションの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
transaction |
tax_line
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価格
|
price | string |
店舗通貨で請求される税金の金額。 |
|
率
|
rate | float |
適用される税率。 |
|
title
|
title | string |
税金の名前。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
品目に適用される税の詳細を示す税明細行オブジェクトの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
tax_line |
払い戻し
払い戻し
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
refund |
払い戻す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
払い戻しの一意識別子。 |
|
order_id
|
order_id | integer |
API の目的で使用される注文の ID。 |
|
作成日時
|
created_at | string |
払い戻しが作成された日時 (ISO 8601 形式)。 |
|
手記
|
note | string |
払い戻しに添付されている省略可能なメモ。 |
|
user_id
|
user_id | integer |
払い戻しを実行したユーザーの一意の識別子。 |
|
processed_at
|
processed_at | string |
払い戻しがインポートされた日時 (ISO 8601 形式)。 |
|
補充
|
restock | boolean |
品目を店舗の在庫に戻すかどうかを指定します。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
|
トランザクション
|
transactions | transactions |
払い戻しに関係するトランザクションの一覧。 |
|
order_adjustments
|
order_adjustments | array of |
払い戻しに関連付けられている注文調整の一覧。 |
line_item
アイテムに関する情報を順番に含む行項目オブジェクトの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
明細の ID。 |
|
variant_id
|
variant_id | integer |
製品バリアントの ID。 |
|
title
|
title | string |
製品のタイトル。 |
|
量
|
quantity | integer |
購入されたアイテムの数。 |
|
sku
|
sku | string |
品目の SKU (在庫保管単位)。 |
|
variant_title
|
variant_title | string |
製品バリアントのタイトル。 |
|
ベンダー
|
vendor | string |
アイテムの仕入先の名前。 |
|
fulfillment_service
|
fulfillment_service | string |
アイテムを満たすサービス プロバイダー。 |
|
product_id
|
product_id | integer |
品目が属する製品の ID。 |
|
requires_shipping
|
requires_shipping | boolean |
商品に配送が必要かどうか。 |
|
有税
|
taxable | boolean |
品目が課税対象かどうか。 |
|
gift_card
|
gift_card | boolean |
明細項目がギフト カードかどうか。 |
|
名前
|
name | string |
製品バリアントの名前。 |
|
variant_inventory_management
|
variant_inventory_management | string |
在庫管理サービスの名前。 |
|
プロパティ
|
properties | line_item_properties |
プロパティ。 |
|
product_exists
|
product_exists | boolean |
製品が存在するかどうか。 |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
フルフィルメントに使用できる量。 |
|
グラム
|
grams | integer |
グラム単位の項目の重み。 |
|
価格
|
price | string |
割引がショップ通貨で適用される前の品目の価格。 |
|
total_discount
|
total_discount | string |
店舗通貨で明細に割り当てられた割引の合計金額。 |
|
fulfillment_status
|
fulfillment_status | string |
フルフィルメント対象の品目に関する注文の状態。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
割引アプリケーションによって割り当てられた金額の順序付きリスト。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者 graphql API ID。 |
|
tax_lines
|
tax_lines | tax_lines |
品目に適用される税の詳細を示す税明細行オブジェクトの一覧。 |
line_items
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
line_item |
アイテムに関する情報を順番に含む行項目オブジェクトの一覧。 |
shipping_lines
使用した配送方法の詳細。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
shipping_line |
payment_gateway_names
注文に使用される支払いゲートウェイの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
string |
note_attribute
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
属性名をメモします。 |
|
value
|
value | string |
属性値をメモします。 |
note_attributes
注文に追加される追加情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
note_attribute |
discount_code
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
関連付けられている割引アプリケーションが種類コードの場合、このプロパティはチェックアウト時に入力された割引コードを返します。 |
|
量
|
amount | string |
注文の合計から差し引かれた金額。 注文を作成する場合、この値は差し引く割合または金額です。 |
|
型
|
type | string |
割引の種類。 |
discount_codes
注文に適用される割引の一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
discount_code |
discount_application
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
type | string |
割引アプリケーションの種類。 |
|
value
|
value | string |
割引アプリケーションの 10 進数としての値。 これは、割引アプリケーションの意図を表します。 |
|
value_type
|
value_type | string |
値の型。 |
|
allocation_method
|
allocation_method | string |
割引アプリケーションの値が資格のある行に割り当てられている方法。 |
|
target_selection
|
target_selection | string |
割引が割り当てられるtarget_typeによって定義された種類の注文の行。 |
|
target_type
|
target_type | string |
割引が適用される注文の行の種類。 |
|
コード
|
code | string |
割引の適用に使用された割引コード。 割引コード アプリケーションでのみ使用できます。 |
discount_applications
マーチャントまたはShopifyスクリプトによって定義された割引アプリケーションの説明。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
discount_application |
領収書
レシートに関する情報を提供するテキスト フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
testcase
|
testcase | boolean |
フルフィルメントがテストケースであったかどうか。 |
|
承認
|
authorization | string |
承認コード。 |