Custom API Action
Shopify APIに対してカスタムの認証済みHTTP呼び出しを行います。
Shopify開発者向けドキュメントを参照してください。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request Type(リクエストタイプ) |
カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン |
TRUE |
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Relative URL(相対URL) |
呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。 たとえば、Shopify APIエンドポイントがhttps://domain-name.myshopify.com/admin/customers.jsonであれば、相対URLは/admin/customers.jsonとなります。 [Relative URL(相対URL)]にAPIバージョンを指定する場合、Shopifyが過去12か月以内にリリースしたバージョンである必要があります。エラーが返されるときは、[Relative URL(相対URL)]のバージョンを更新して廃止ペイロードを除去する必要があります。 明示的なAPIバージョンなしの場合、常にShopify APIの有効な最も古いバージョンを扱うことになります。 |
テキスト |
TRUE |
Query(クエリ) |
オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリパラメーターを指定します。 |
オブジェクト |
FALSE |
Headers(ヘッダー) |
承認またはコンテンツタイプ(この2つはすでにコネクターが対応しています)以外に必要な任意のヘッダーを指定します。 |
オブジェクト |
FALSE |
Body(本文) |
リクエストボディーをJSON形式で指定します。POST、PUT、PATCHリクエストでのみ使用できます。 リクエストの本文で次の任意の廃止属性を使用すると、Custom APIアクションカードはエラーを返します。
|
オブジェクト |
FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) |
||
Status Code(ステータスコード) |
操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
Headers(ヘッダー) |
出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 |
オブジェクト |
Body(本文) |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |