Shopify (独立発行者) (プレビュー)
Shopify の販売者が注文を受信、処理、管理に使用する REST インターフェイスです。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Microsoft Dynamics |
| [URL] | https://dynamics.microsoft.com/en-us/support/ |
| メール | bennettray@microsoft.com |
| Connector Metadata | |
|---|---|
| 発行者 | Ray Bennett (MSFT) |
| Web サイト | https://www.shopify.com/ |
| プライバシー ポリシー | https://www.shopify.com/legal/privacy |
| カテゴリー | 生産性 |
接続を作成する
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | Description | Required |
|---|---|---|---|
| API Key | securestring | この API のアクセス トークンです。 | True |
| 店舗 URL | string | Shopify の店舗 URL | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 受注の更新 |
提供された情報で注文を更新します。 |
| 注文のキャンセル |
ID で注文をキャンセルする |
| 注文の一覧を取得します |
指定された基準を満たす注文のリストを取得します |
| 顧客のリストを取得する |
指定された基準を満たす顧客のリストを取得します |
受注の更新
提供された情報で注文を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Order ID
|
order_id | True | string |
更新される注文の ID です。 |
|
|
object |
戻り値
Order
- Body
- order
注文のキャンセル
ID で注文をキャンセルする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Order ID
|
order_id | True | string |
キャンセルされる注文の ID です。 |
|
返金額
|
amount | string |
払い戻す金額です。 設定されている場合、Shopify はステータスに応じて支払いを無効にするか返金しようとします。 Shopify は、元の取引が Shopify で行われなかった場合、手動ゲートウェイを使用して払い戻しを行います。 手動ゲートウェイを介した払い戻しは、Shopify に払い戻しとして記録されますが、顧客には払い戻されません。 |
|
|
返金通貨
|
currency | string |
注文がキャンセルされたときに発行される返金の通貨です。 金額プロパティが指定される場合は常に、複数通貨注文の場合に必要です。 |
|
|
返金された商品を再入荷する
|
restock | string |
返金された商品をストアの在庫に再入荷するかどうか。 |
|
|
注文キャンセルの理由
|
reason | string |
注文キャンセルの理由です。 有効な値: 顧客、在庫、詐欺、拒否など。 |
|
|
キャンセル メール
|
string |
顧客にキャンセルを通知する電子メールを送信するかどうか。 |
||
|
払い戻し
|
refund | string |
実行する返金トランザクションです。 |
|
|
|
object |
戻り値
Order
- Body
- order
注文の一覧を取得します
指定された基準を満たす注文のリストを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Order IDs
|
ids | string |
注文 ID のカンマ区切りリストで指定された注文のみを取得します。 |
|
|
Limit
|
limit | string |
ページごとに表示する結果の最大数です。 |
|
|
以降 ID
|
since_id | string |
指定した ID 以降の注文を表示します。 |
|
|
min で作成され
|
created_at_min | string |
日付以降に作成された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
max で作成され
|
created_at_max | string |
日付以前に作成された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
min で更新
|
updated_at_min | string |
最終更新日以降に更新された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
max で更新
|
updated_at_max | string |
最終更新日以前に更新された注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
min で処理
|
processed_at_min | string |
日付以降にインポートされた注文を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
max で処理
|
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」を追加します。 E.g. 「order=updated_at asc」。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
順序
|
orders | array of order |
顧客のリストを取得する
指定された基準を満たす顧客のリストを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Customer IDs
|
ids | string |
カンマ区切りの ID リストで指定された顧客に結果を制限します。 |
|
|
以降 ID
|
since_id | string |
指定された ID 以降の結果を制限します。 |
|
|
min で作成され
|
created_at_min | string |
指定した日付以降に作成された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
max で作成され
|
created_at_max | string |
指定した日付以前に作成された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
min で更新
|
updated_at_min | string |
指定日以降に最終更新された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
max で更新
|
updated_at_max | string |
指定日以前に最終更新された顧客を表示します (形式: 2014-04-25T16:15:47-04:00)。 |
|
|
Limit
|
limit | string |
表示する結果の最大件数 (既定値は 50。最大値は 250 です。) |
|
|
Fields
|
fields | string |
カンマ区切りのフィールドのリストで指定された特定のフィールドのみを表示します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
顧客
|
customers | array of customer |
定義
注文
Order
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
受注を作成したアプリの ID です。 |
|
メールアドレス
|
string |
顧客のメール アドレス。 |
|
|
closed_at
|
closed_at | string |
注文が終了した日時 (ISO 8601形式) です。 注文がクローズされていない場合は null を返します。 |
|
created_at
|
created_at | string |
ショップの通貨を表す 3 文字のコード (ISO4217 形式) です。 |
|
updated_at
|
updated_at | string |
注文が最後に変更された日付と時刻 (ISO 8601形式) です。 |
|
number
|
number | integer |
ショップの注文数における注文の位置です。 番号は連続しており、1 から始まります。 |
|
note
|
note | string |
店主が注文に添付できるオプションのメモです。 |
|
token
|
token | string |
注文を参照する場合の一意の値です。 |
|
ゲートウェイ
|
gateway | string |
使用された支払ゲートウェイです。 |
|
test
|
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 文字のコード (ISO4217 形式) です。 |
|
financial_status
|
financial_status | string |
注文に関連する支払いの状況です。 オーダー作成時にのみ設定可能です。 |
|
confirmed
|
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 |
合計金額 (米国ドル) です。 |
|
checkout_token
|
checkout_token | string |
注文に関連するチェックアウトを参照する際の一意の値です。 |
|
reference
|
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 | 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 |
管理者のグラフィカル 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 |
注文に関連付けられたフルフィルメントの配列です。 |
|
返金
|
refunds | refunds |
Refunds |
顧客
顧客に関する情報です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
顧客を識別するための一意の識別子です。 |
|
メールアドレス
|
string |
顧客固有の電子メールアドレスです。 同じ電子メール アドレスを複数の顧客に割り当てようとすると、エラーが返されます。 |
|
|
accepts_marketing
|
accepts_marketing | boolean |
顧客がマーケティング資料を電子メールで受信することに同意したかどうか。 |
|
created_at
|
created_at | string |
顧客が作成された日時 (ISO 8601形式) です。 |
|
updated_at
|
updated_at | string |
顧客情報が最後に更新された日時 (ISO 8601形式) です。 |
|
first_name
|
first_name | string |
顧客の名です。 |
|
姓
|
last_name | string |
顧客の姓です。 |
|
orders_count
|
orders_count | integer |
この顧客に関連付けられた注文の数です。 |
|
州
|
state | string |
ショップに対する顧客のアカウントの状態です。 既定では無効です。 |
|
total_spent
|
total_spent | string |
顧客が注文履歴全体で費やした合計金額です。 |
|
last_order_id
|
last_order_id | integer |
顧客の最終注文の ID です。 |
|
note
|
note | string |
顧客に関するメモです。 |
|
verified_email
|
verified_email | boolean |
顧客がメールアドレスの認証を行ったかどうかを示します。 |
|
multipass_identifier
|
multipass_identifier | string |
マルチパス ログインで使用される顧客の一意の識別子です。 |
|
tax_exempt
|
tax_exempt | boolean |
顧客が注文に対する税金の支払いを免除されているかどうかを示します。 true の場合、チェックアウト時に注文に税金は適用されません。 false の場合、チェックアウト時に税金が適用されます。 |
|
電話番号
|
phone | string |
この顧客の一意の電話番号 (E.164形式) です。 同じ電話番号を複数の顧客に割り当てようとすると、エラーが返されます。 |
|
tags
|
tags | string |
ショップ オーナーが顧客に付けたタグで、カンマ区切りの文字列としてフォーマットされています。 各顧客が持てるタグは最大 250 個です。 各タグは最大 255 文字まで使用できます。 |
|
last_order_name
|
last_order_name | string |
顧客の最終注文の名前です。 これは、Order リソースの名前フィールドに直接関連しています。 |
|
通過
|
currency | string |
顧客が最後の注文の支払時に使用した通貨の 3 文字コード (ISO 4217 形式) です。 |
|
addresses
|
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 |
管理者のグラフィカル 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 | string |
顧客の姓です。 |
|
会社名
|
company | string |
顧客の会社です。 |
|
address1
|
address1 | string |
顧客の郵送先住所の 1 行目です。 |
|
address2
|
address2 | string |
顧客のメールアドレスの追加フィールドです。 |
|
市
|
city | string |
顧客の市区町村です。 |
|
都道府県
|
province | string |
顧客の地域名です。 通常は、都道府県です。 |
|
国
|
country | string |
顧客の国です。 |
|
郵便番号
|
zip | string |
顧客の郵便番号 (zip、postcode、Eircodeなどとも呼ばれる) です。 |
|
電話番号
|
phone | string |
この住所の顧客の電話番号です。 |
|
名称
|
name | string |
顧客の姓と名です。 |
|
province_code
|
province_code | string |
顧客の地域の 2 文字のコードです。 |
|
country_code
|
country_code | string |
顧客の国に対応する 2 文字の国コードです。 |
|
country_name
|
country_name | string |
顧客の正規化された国名です。 |
|
default
|
default | boolean |
既定の住所アドレスごとに true を返します。 |
shipping_address
ご注文商品の発送先住所です。 この住所は任意であり、発送を必要としない注文では利用できません。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
first_name
|
first_name | string |
配送先住所に関連する人物のファーストネームです。 |
|
address1
|
address1 | string |
配送先住所の番地です。 |
|
電話番号
|
phone | string |
配送先住所の電話番号です。 |
|
市
|
city | string |
配送先住所の市区町村です。 |
|
郵便番号
|
zip | string |
配送先住所の郵便番号 (郵便番号、Eircodeなど) です。 |
|
都道府県
|
province | string |
配送先住所の地域名 (都道府県、都道府県など) です。 |
|
国
|
country | string |
配送先の国名です。 |
|
姓
|
last_name | string |
配送先住所に関連する人物のラスト ネームです。 |
|
address2
|
address2 | string |
配送先住所の住所のオプションの追加フィールドです。 |
|
会社名
|
company | string |
配送先住所に関連する人物の会社です。 |
|
緯度
|
latitude | float |
出荷先住所の緯度です。 |
|
緯度
|
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 |
支払い方法に関連する人物のファーストネームです。 |
|
address1
|
address1 | string |
請求先住所の番地です。 |
|
電話番号
|
phone | string |
請求先住所の電話番号です。 |
|
市
|
city | string |
請求先住所の市区町村です。 |
|
郵便番号
|
zip | string |
請求先住所の郵便番号 (郵便番号、Eircodeなど) です。 |
|
都道府県
|
province | string |
請求先住所の地域名 (都道府県、都道府県など) です。 |
|
国
|
country | string |
請求先住所の国名です。 |
|
姓
|
last_name | string |
支払い方法に関連する人物のラストネームです。 |
|
address2
|
address2 | string |
請求先住所の住所のオプションの追加フィールドです。 |
|
会社名
|
company | string |
請求先住所に関連する人物の会社です。 |
|
緯度
|
latitude | float |
請求先住所の緯度です。 |
|
緯度
|
longitude | float |
請求先住所の経度です。 |
|
名称
|
name | string |
支払い方法に関連する人物のフルネームです。 |
|
country_code
|
country_code | string |
請求先住所の国を表す 2 文字コード (ISO 3166-1 形式) です。 |
|
province_code
|
province_code | string |
請求先住所の地域の 2 文字の省略形です。 |
addresses
顧客の最近更新された 10 件の住所のリストです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
default_address |
shipping_line
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
グローバル一意識別子です。 |
|
肩書き
|
title | string |
出荷方法のタイトルです。 |
|
price
|
price | string |
この配送方法のショップ通貨での価格です。 |
|
code
|
code | string |
配送方法に関する参照です。 |
|
source
|
source | string |
出荷方法のソースです。 |
|
電話番号
|
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 |
顧客のクレジット カードの発行者識別番号 (IIN) (以前は銀行識別番号 (BIN) と呼ばれていました) です。 |
|
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
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
amount
|
shop_money.amount | string |
実際の金額です。 |
|
currency_code
|
shop_money.currency_code | string |
ISO 4217 形式です。 |
|
amount
|
presentment_money.amount | string |
実際の金額です。 |
|
currency_code
|
presentment_money.currency_code | string |
ISO 4217 形式です。 |
line_item_property
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名称
|
name | string |
製品名。 |
|
価値
|
value | string |
製品の価値です。 |
line_item_properties
プロパティ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
line_item_property |
フルフィルメント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
フルフィルメントの ID です。 |
|
order_id
|
order_id | integer |
注文の一意の数値識別子です。 |
|
ステータス
|
status | string |
フルフィルメントの状態です。 |
|
created_at
|
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 |
管理者のグラフィカル api の id です。 |
|
line_items
|
line_items | line_items |
フルフィルメント
注文に関連付けられたフルフィルメントの配列です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
fulfillment |
取引
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
トランザクションの ID です。 |
|
order_id
|
order_id | integer |
トランザクションが関連する注文の ID です。 |
|
kind
|
kind | string |
トランザクションのタイプです。 |
|
ゲートウェイ
|
gateway | string |
トランザクションが発行されたゲートウェイの名前です。 |
|
ステータス
|
status | string |
トランザクションの状態です。 |
|
message
|
message | string |
決済プロバイダーによって生成された、トランザクションが成功または失敗した理由に関する追加情報を含む文字列です。 |
|
created_at
|
created_at | string |
トランザクションが作成された日時 (ISO 8601形式) です。 |
|
test
|
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
|
amount | string |
取引に含まれる金額です。 |
|
通過
|
currency | string |
支払いに使用される通貨の 3 文字コード (ISO 4217形式) です。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理者のグラフィカル api の id です。 |
transactions
払い戻しに関連するトランザクションの一覧です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
transaction |
tax_line
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
price
|
price | string |
ショップ通貨で課金される税額です。 |
|
rate
|
rate | float |
適用される税率です。 |
|
肩書き
|
title | string |
税の名前です。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
税目オブジェクトのリストで、各オブジェクトはには品目に適用される税金の詳細が含まれます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
tax_line |
返金
Refunds
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
refund |
払戻
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
払い戻しのための一意の識別子です。 |
|
order_id
|
order_id | integer |
API の目的で使用される、注文の ID です。 |
|
created_at
|
created_at | string |
払い戻しが作成された日時 (ISO 8601形式) です。 |
|
note
|
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 |
管理者のグラフィカル api の id です。 |
|
transactions
|
transactions | transactions |
払い戻しに関連するトランザクションの一覧です。 |
|
order_adjustments
|
order_adjustments | array of |
返金に添付された注文調整のリストです。 |
line_item
各オブジェクトは、注文内のアイテムに関する情報を含む、明細品目オブジェクトのリストです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
品目の ID です。 |
|
variant_id
|
variant_id | integer |
製品バリアントの ID です。 |
|
肩書き
|
title | string |
商品のタイトルです。 |
|
quantity
|
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
|
taxable | boolean |
アイテムが課税されるかどうか |
|
gift_card
|
gift_card | boolean |
明細品目がギフトカードかどうかを示します。 |
|
名称
|
name | string |
製品バリアントの名称です。 |
|
variant_inventory_management
|
variant_inventory_management | string |
在庫管理サービスの名称です。 |
|
properties
|
properties | line_item_properties |
プロパティ。 |
|
product_exists
|
product_exists | boolean |
商品が存在するかどうかを示します。 |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
履行可能な金額を示します。 |
|
グラム
|
grams | integer |
商品の重量をグラム単位で表示します。 |
|
price
|
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 |
管理者のグラフィカル 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 | string |
ノート属性の値です。 |
note_attributes
注文に追加される追加情報です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
note_attribute |
discount_code
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
code
|
code | string |
関連する割引アプリケーションがコード型である場合、このプロパティはチェックアウト時に入力された割引コードを返します。 |
|
amount
|
amount | string |
注文合計から差し引かれる金額です。 注文を作成する際、この値は差し引かれる割合または金額です。 |
|
タイプ
|
type | string |
割引の種類です。 |
discount_codes
注文に適用される割引のリストです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
discount_code |
discount_application
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイプ
|
type | string |
割引の適用タイプです。 |
|
価値
|
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
|
code | string |
割引を適用するために使用された割引コードです。 割引コードの申請のみに利用可能です。 |
discount_applications
加盟店または Shopify スクリプトが定義する、割引適用に関する記述です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
discount_application |
入庫
領収書に関する情報を提供するテキスト フィールドです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
testcase
|
testcase | boolean |
フルフィルメントがテストケースであったかどうかを示します。 |
|
認可
|
authorization | string |
認証コードです。 |