Etsy (独立系発行元)
このコネクタは、API キーを使用してさまざまな Etsy.com 機能にアクセスします。 在庫、受注、およびショップ管理のアクションをサポートします。 すべてのアクションは Etsy Open API v3 に基づいており、エンドポイントはまだベータ版です。 このようなアクションがベータ API を使用している場合、タイトルにベータが含まれているアクションは 501 応答コードを返します。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Troy Taylor |
| [URL] | https://www.hitachisolutions.com |
| メール | ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| 発行者 | Troy Taylor、Hitachi Solutions |
| Web サイト | https://www.etsy.com/ |
| プライバシー ポリシー | https://www.etsy.com/legal/privacy/ |
| カテゴリ | コマース |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名称 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | securestring | この API の API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ID で一覧を取得する |
一度に複数の一覧 ID をクエリできます。 クエリごとに最大 100 の ID を制限します。 |
| Ping |
アプリケーションとの Etsy API への接続を確認してください。 |
| すべての一覧ファイルを取得する |
指定されたデジタル リストに関連付けられたすべてのファイルを取得します。 物理的な一覧からファイルを要求すると、空の結果が返されます。 |
| アクティブ一覧の取得 |
作成日ごとにページ分割された Etsy のすべてのアクティブ一覧の一覧。 並べ替え順一覧がないと、既定で最新のリストが返されます。 |
| ショップ セクション ID でリストを取得 |
特定のショップのセクションからすべての一覧を取得します。 |
| ショップ セクションを作成する |
特定のショップに新しいセクションを作成します。 |
| ショップ セクションを取得する |
セクション ID とショップ ID で参照されるショップ セクションを取得します。 |
| ショップ セクションを取得する |
ショップ ID で識別される特定のショップでショップ セクションの一覧を取得します。 |
| ショップごとにおすすめ一覧を取得する |
おすすめされているショップに関連付けられている一覧を取得します。 |
| ショップごとにアクティブ一覧を取得する |
特定のショップで Etsy のすべてのアクティブ一覧の一覧を、一覧の作成日でページ分割して取得します。 |
| ショップごとに一覧を取得する |
ショップに属する一覧を返します。 一覧は、状態パラメーターを使用してフィルター処理できます。 |
| ショップのトランザクションを取得する |
ショップに関連付けられているトランザクションの一覧を取得します。 |
| ショップの更新 |
ショップを更新します。 すべての文字列パラメーターがショップのプライマリ言語で提供されていることを前提としています。 |
| ショップの検索 |
一致する名前のショップの一覧を返します。 |
| ショップ支払いアカウント元帳のエントリを取得する |
ショップの支払いアカウント元帳のエントリを取得します。 |
| ショップ領収書ごとに一覧を取得する |
領収書に関連付けられているすべての一覧を取得します。 |
| トランザクションを取得する |
トランザクション ID でトランザクションを取得します。 |
| ユーザーの住所を取得する |
ユーザーの住所を取得します。 このエンドポイントの開発は進行中です。 501 応答のみを返します。 |
| ユーザーを取得する |
ユーザー ID で識別されるユーザーのユーザー プロファイルを返します。 |
| ユーザー住所を取得する |
ユーザー アドレスの一覧を取得します。 |
| レビューの取得 |
ID を指定してショップからレビューを取得します。 |
| 一覧からファイルを削除する |
デジタル リストの最終ファイルを削除すると、一覧は物理的な一覧に変換されます。 削除要求への応答は、指定された一覧に関連付けられている残りのファイル レコードの一覧を返します。 |
| 一覧からファイルを取得する |
指定されたデジタル リストに関連付けられたファイルを 1 つ取得します。 物理的な一覧からファイルを要求すると、空の結果が返されます。 |
| 一覧のオファリングの取得 |
一覧のオファリングを取得します。 |
| 一覧のトランザクションを取得する |
一覧に関連付けられているトランザクションの一覧を取得します。 |
| 一覧のバリエーション画像の取得 |
一覧ですべてのバリエーション画像を取得します。 |
| 一覧のバリエーション画像の更新 |
一覧でバリエーション画像を作成します。 |
| 一覧のプロパティの取得 |
一覧の製品を返します。 |
| 一覧のプロパティの取得 (ベータ) |
一覧のプロパティを取得します。 このエンドポイントの開発は進行中です。 501 応答のみを返します。 |
| 一覧の削除 |
このアクションにより、ショップの一覧が削除されます。 状態が次のいずれかである場合にのみ、一覧を削除できます: SOLD_OUT、DRAFT、EXPIRED、INACTIVE、ACTIVE および is_available または ACTIVE で、販売者フラグがあります: SUPRESSED (frozen)、VACATION、CUSTOM_SHOPS (pattern)、SELL_ON_FACEBOOK |
| 一覧の在庫の取得 |
一覧の在庫レコードを取得します。 Etsy.com 在庫ツールを使用して編集しなかった一覧には、在庫レコードがありません。 フェッチされる在庫レコードの所有者である場合、このエンドポイントは SKU データを返します。 |
| 一覧の在庫を更新する |
一覧 ID で識別される一覧の在庫を更新します。 製品 SKU、オファリング数量、または価格に指定された値がプロパティ フィールドの値と互換性がない場合、更新は失敗します。 価格を設定するときは、金額リソースで指定されているように、金額を除数で割った値に等しいフロートを割り当てます。 |
| 一覧の更新 |
ショップ ID で識別される特定のショップの、一覧 ID で識別される一覧を更新します。 |
| 一覧の画像の取得 |
特定の一覧 ID を持つ一覧のすべての一覧画像リソースを取得します。 |
| 一覧の翻訳の取得 |
指定された言語の一覧の翻訳を返します。 |
| 一覧の翻訳を作成する |
一覧 ID と言語によって一覧翻訳を作成します。 |
| 一覧の翻訳を更新する |
一覧 ID と言語によって一覧翻訳を更新します。 |
| 一覧の製品の取得 |
ID で一覧製品を取得します。 |
| 一覧を取得する |
一覧 ID によって一覧レコードを取得します。 |
| 一覧ファイルのアップロード |
デジタル一覧用の新しいファイルをアップロードするか、既存のファイルを特定の一覧に関連付けます。 既存のファイルの一覧ァイル ID、またはアップロードするファイルの名前とバイナリ ファイル データのいずれかを指定する必要があります。 既存のファイルを物理的な一覧に関連付けると、物理的な一覧がデジタル一覧に変換され、すべての発送コストと製品および在庫の変動がなくなります。 |
| 一覧プロパティの削除 |
一覧からプロパティを削除します。 |
| 一覧プロパティの更新 |
一覧の製品オファリングを定義するプロパティ一覧を更新または入力します。 各オファリングには、一覧に割り当てられたスケール ID、またはこの要求で一覧に割り当てたスケール ID に有効な値と値 ID の両方が必要です。 |
| 一覧画像の削除 |
一覧画像を削除します。 ファイルのコピーはサーバーに残っているため、削除された画像は、元の画像を再アップロードせずに一覧に再関連付けされる場合があります。 |
| 一覧画像の取得 |
特定の画像 ID を持つ一覧画像の参照とメタデータを取得します。 |
| 一覧画像をアップロードする |
ショップ ID と一覧 ID で識別される一覧に画像をアップロードまたは割り当てます。 新しい画像をアップロードするには、画像パラメータの値として画像ファイルを設定します。 一覧画像 ID パラメーターで削除された画像の画像 ID を使用して、以前に削除された画像を一覧に割り当てることができます。 要求に画像と一覧画像 ID パラメーター値の両方が含まれている場合、エンドポイントは画像パラメーターの画像のみをアップロードします。 |
| 下書き一覧を作成する |
Etsy チャネルのショップで物理的な下書き一覧製品を作成します。 |
| 出荷受領書を作成する |
ショップ受領書の追跡情報を送信します。これにより、指定された受領書 ID のショップ受領書出荷エントリが作成されます。 追跡情報を正常に送信するたびに、Etsy は購入者ユーザーに通知メールを送信します。 送信 BCC が true の場合、Etsy は販売者にも発送通知を送信します。 追跡コードと配送業者名が送信されないとき、領収書は発送済みとしてのみマークされます。 |
| 分類 ID で製品プロパティを取得する |
特定の販売者分類 ID でサポートされている、適用できるスケールと値を含む製品プロパティの一覧を取得します。 |
| 所有者 ID でショップを取得する |
ショップ所有者のユーザー ID で識別されるショップを取得します。 |
| 支払いアカウント元帳エントリ ID から支払いを取得する |
支払いアカウント元帳エントリ ID から支払いを取得します (該当する場合)。 |
| 支払の一覧を取得する |
ショップ ID で識別されるショップから支払いの一覧を取得します。 支払い ID の一覧を使用して結果をフィルターすることもできます。 |
| 特定の領収書から支払いを取得する |
特定の領収書から、領収書 ID で識別された、特定のショップから、ショップ ID で識別された支払を取得します。 |
| 発送プロファイル アップグレードの作成 |
新しい発送プロファイルのアップグレードを作成します。これにより、代替の運送業者やより速い配送などの発送オプションの価格を確立できます。 |
| 発送プロファイル アップグレードの削除 |
発送プロファイル アップグレードを削除し、関連付けられた発送プロファイルを使用するすべての一覧からアップグレード オプションを削除します。 |
| 発送プロファイル アップグレードの更新 |
発送プロファイルのアップグレードを更新し、発送プロファイルを使用するすべての一覧を更新します。 |
| 発送プロファイル アップグレードを取得する |
特定の発送プロファイルに割り当てられた発送プロファイルのアップグレードの一覧を取得します。 |
| 発送プロファイルでプロファイルの宛先を取得する |
発送プロファイルに関連付けられている発送先オブジェクトの一覧を取得します。 |
| 発送プロファイルの作成 |
新しい発送プロファイルの作成。 発送プロファイルを作成するとき、国の ISO コードまたは地域を渡すことができますが、両方を渡すことはできません。 1 つだけ必要です。 運送業者 ID とメール クラスのいずれか、または最小配送日と最大配送日の両方を渡す必要があります。 |
| 発送プロファイルの削除 |
指定された ID で発送プロファイルを削除します。 |
| 発送プロファイルの更新 |
発送プロファイルの設定を変更します。 |
| 発送プロファイルを取得する |
発送プロファイル ID によって参照される発送プロファイルを取得します。 |
| 発送プロファイルを取得する |
ショップ ID で識別される特定の Etsy ショップで使用可能な発送プロファイルの一覧を取得します。 |
| 発送プロファイル宛先の作成 |
新しい発送先を作成します。これにより、発送プロファイルの宛先の発送コスト、運送業者、およびクラスが設定されます。 これにより、関連するショップの通貨を使用してコストが割り当てられます。 宛先国 ISO または宛先地域のいずれかを使用して宛先を設定します。宛先国 ISO と宛先地域は相互に排他的です — どちらか一方を設定します。 両方を設定すると、エラー 400 がトリガーされます。 要求で宛先国 ISO も宛先地域も設定されていない場合、既定の宛先はどこにでもあります。 また、運送業者 ID とメール クラスの両方を割り当てるか、最小配送日と最大配送日の両方を割り当てる必要があります。 |
| 発送プロファイル宛先の削除 |
発送先を削除し、関連付けられた発送プロファイルを使用するすべての一覧から宛先オプションを削除します。 発送プロファイルには少なくとも 1 つの宛先が必要であるため、このエンドポイントは発送プロファイルの最終的な発送先を削除できません。 発送プロファイルから最終的な発送先を削除するには、発送プロファイル全体を削除する必要があります。 |
| 発送プロファイル宛先の更新 |
既存の発送先を更新します。これにより、発送コスト、運送業者および宛先のクラスを設定または再割り当てできます。 |
| 販売者の分類ノードを取得する |
販売者の分類ノードの完全な階層ツリーを取得します。 |
| 運送業者を取得する |
特定の国で使用可能な運送業者とそれらに関連付けられているメール クラスの一覧を取得します。 |
| 領収書のトランザクションを取得する |
特定の領収書に関連付けられているトランザクションの一覧を取得します。 |
| 領収書を取得 |
領収書 ID の範囲またはオフセット、日付、支払い済みや発送済みの購入によってフィルター処理されていないか、フィルター処理されているか、特定のショップからのショップ領収書を要求します。 |
| 領収書を取得する |
領収書 ID で識別された、Etsy ショップからの領収書を取得します。 |
ID で一覧を取得する
一度に複数の一覧 ID をクエリできます。 クエリごとに最大 100 の ID を制限します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_ids | True | string |
特定の Etsy ショップの一覧の数値 ID の配列。 |
|
含める
|
includes | string |
有効な関連付けを添付する列挙文字列。 |
戻り値
関連付けのあるショップ一覧リソースのセット。
- ShopListingsWithAssociations
- ShopListingsWithAssociations
Ping
すべての一覧ファイルを取得する
指定されたデジタル リストに関連付けられたすべてのファイルを取得します。 物理的な一覧からファイルを要求すると、空の結果が返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
戻り値
いくつかの ShopListingFiles を表します。
- ShopListingFiles
- ShopListingFiles
アクティブ一覧の取得
作成日ごとにページ分割された Etsy のすべてのアクティブ一覧の一覧。 並べ替え順一覧がないと、既定で最新のリストが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
|
|
含める
|
keywords | string |
検索語句またはすべての結果に表示される必要のあるフレーズ。 |
|
|
並べ替え
|
sort_on | string |
一覧の検索結果を並べ替える値。 注: 並べ替えは、検索オプション (キーワード、地域など。) の 1 つと組み合わせた場合にのみ機能します。 |
|
|
並べ替え順序
|
sort_order | string |
一覧を並べ替える昇順 (上) または降順 (下)。 注: sort_order は、検索オプション (キーワード、地域など。) の 1 つと組み合わせた場合にのみ機能します。 |
|
|
最小価格
|
min_price | float |
検索結果によって返される一覧の最小価格。 |
|
|
最大価格
|
max_price | float |
検索結果によって返される一覧の最大価格。 |
|
|
分類 ID
|
taxonomy_id | integer |
一覧の数値の分類 ID。 販売者は、ショップの分類 ID の一覧表示を管理します。 |
|
|
ショップの場所
|
shop_location | string |
ショップの場所でフィルター処理します。 場所を解析できない場合、Etsy はエラーで応答します。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
ショップ セクション ID でリストを取得
特定のショップのセクションからすべての一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
ショップ セクション ID
|
shop_section_ids | True | string |
特定の Etsy ショップのすべてのセクションの数値 ID の配列。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
|
|
並べ替え
|
sort_on | string |
一覧の検索結果を並べ替える値。 |
|
|
並べ替え順序
|
sort_order | string |
一覧を並べ替える昇順 (上) または降順 (下)。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
ショップ セクションを作成する
特定のショップに新しいセクションを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
肩書き
|
title | True | string |
ショップ セクションのタイトル文字列。 |
戻り値
ユーザーが一覧を並べ替えることができるショップ内のセクション。
- ShopSection
- ShopSection
ショップ セクションを取得する
セクション ID とショップ ID で参照されるショップ セクションを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
ショップ セクション ID
|
shop_section_id | True | integer |
特定の Etsy ショップのセクションの数値 ID。 |
戻り値
ユーザーが一覧を並べ替えることができるショップ内のセクション。
- ShopSection
- ShopSection
ショップ セクションを取得する
ショップ ID で識別される特定のショップでショップ セクションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
戻り値
特定のショップのすべてのセクション。
- ShopSections
- ShopSections
ショップごとにおすすめ一覧を取得する
おすすめされているショップに関連付けられている一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
ショップごとにアクティブ一覧を取得する
特定のショップで Etsy のすべてのアクティブ一覧の一覧を、一覧の作成日でページ分割して取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
|
|
含める
|
keywords | string |
検索語句またはすべての結果に表示される必要のあるフレーズ。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
ショップごとに一覧を取得する
ショップに属する一覧を返します。 一覧は、状態パラメーターを使用してフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
状態
|
State | string |
アクティブまたは非アクティブのいずれかから列挙された文字列。 |
|
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
|
|
並べ替え
|
Sort On | string |
一覧の検索結果を並べ替える値。 |
|
|
並べ替え順序
|
Sort Order | string |
一覧を並べ替える昇順 (上) または降順 (下)。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
ショップのトランザクションを取得する
ショップに関連付けられているトランザクションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ショップ領収書トランザクション リソースのセット
- ShopReceiptTransactions
- ShopReceiptTransactions
ショップの更新
ショップを更新します。 すべての文字列パラメーターがショップのプライマリ言語で提供されていることを前提としています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
肩書き
|
title | string |
ショップのメイン ページの簡単な見出し文字列。 |
|
|
お知らせ
|
announcement | string |
ショップのホームページに表示される購買担当者へのお知らせ文字列。 |
|
|
販売メッセージ
|
sale_message | string |
このショップからの購入を完了したユーザーに送信されるメッセージ文字列。 |
|
|
デジタル販売メッセージ
|
digital_sale_message | string |
このショップからのデジタル品目を購入するユーザーに送信されるメッセージ文字列。 |
戻り値
Etsy ユーザーが作成したショップ。
- ショップ
- Shop
ショップの検索
一致する名前のショップの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ名
|
shop_name | True | string |
ショップの名前の文字列。 |
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ショップ レコードのセット。
- ショップ
- Shops
ショップ支払いアカウント元帳のエントリを取得する
ショップの支払いアカウント元帳のエントリを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
最小作成数
|
min_created | True | integer |
レコード作成時用の最も早い unix タイムスタンプ。 |
|
最大作成数
|
max_created | True | integer |
レコード作成時用の最も遅い unix タイムスタンプ。 |
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
支払アカウント元帳エントリ リソースのセット
- PaymentAccountLedgerEntries
- PaymentAccountLedgerEntries
ショップ領収書ごとに一覧を取得する
領収書に関連付けられているすべての一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
このトランザクションに関連する領収書の数値 ID。 |
|
受領書 ID
|
receipt_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ショップ一覧リソースのセット。
- ShopListings
- ShopListings
トランザクションを取得する
トランザクション ID でトランザクションを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Transaction ID
|
transaction_id | True | integer |
トランザクションの一意の数値 ID。 |
戻り値
ショップの領収書に関連付けられたトランザクション オブジェクト。 Etsy は、発注書の受け取りに記録されているように、購入した一覧ごとに 1 つのトランザクションを生成します。
- ShopReceiptTransaction
- ShopReceiptTransaction
ユーザーの住所を取得する
ユーザーの住所を取得します。 このエンドポイントの開発は進行中です。 501 応答のみを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー住所 ID
|
user_address_id | True | integer |
ユーザーの住所の数値 ID。 |
戻り値
ユーザーの住所を表します。
- UserAddress
- UserAddress
ユーザーを取得する
ユーザー ID で識別されるユーザーのユーザー プロファイルを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user_id | True | integer |
ユーザーの一意の正のゼロ以外の数値 ID。 |
戻り値
サイトの単一ユーザーを表す
- ユーザー
- User
ユーザー住所を取得する
ユーザー アドレスの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
いくつかの UserAddress レコードを表します。
- UserAddresses
- UserAddresses
レビューの取得
ID を指定してショップからレビューを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Limit
|
limit | integer |
返す結果の最大件数。 |
|
|
ページ
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ユーザーが残したトランザクション レビュー レコードのセット。
- TransactionReviews
- TransactionReviews
一覧からファイルを削除する
デジタル リストの最終ファイルを削除すると、一覧は物理的な一覧に変換されます。 削除要求への応答は、指定された一覧に関連付けられている残りのファイル レコードの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
ファイル ID の一覧
|
listing_file_id | True | integer |
デジタル リストに関連付けられたファイルの一意の数値 ID。 |
一覧からファイルを取得する
指定されたデジタル リストに関連付けられたファイルを 1 つ取得します。 物理的な一覧からファイルを要求すると、空の結果が返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
ファイル ID の一覧
|
listing_file_id | True | integer |
デジタル リストに関連付けられたファイルの一意の数値 ID。 |
戻り値
デジタル リストに関連付けられたファイル。
- ShopListingFile
- ShopListingFile
一覧のオファリングの取得
一覧のオファリングを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
製品 ID
|
product_id | True | integer |
このトランザクションに関連する製品の数値 ID。 |
|
製品のオファリング ID
|
product_offering_id | True | integer |
このトランザクションに関連する製品オファリングの数値 ID。 |
戻り値
一覧のオファリングの表現。
- ListingInventoryProductOffering
- ListingInventoryProductOffering
一覧のトランザクションを取得する
一覧に関連付けられているトランザクションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
ショップ領収書トランザクション リソースのセット
- ShopReceiptTransactions
- ShopReceiptTransactions
一覧のバリエーション画像の取得
一覧ですべてのバリエーション画像を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
戻り値
いくつかの一覧バリエーション画像を表します。
- ListingVariationImages
- ListingVariationImages
一覧のバリエーション画像の更新
一覧でバリエーション画像を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
バリエーション画像
|
variation_images | True | string |
バリエーション画像データの配列。 |
戻り値
いくつかの一覧バリエーション画像を表します。
- ListingVariationImages
- ListingVariationImages
一覧のプロパティの取得
一覧の製品を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
戻り値
いくつかの一覧プロパティ値を表します。
- ListingPropertyValues
- ListingPropertyValues
一覧のプロパティの取得 (ベータ)
一覧のプロパティを取得します。 このエンドポイントの開発は進行中です。 501 応答のみを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
プロパティ ID
|
property_id | True | integer |
Etsy 一覧プロパティの一意の ID。 |
戻り値
構造化データ値の表現。
- ListingPropertyValue
- ListingPropertyValue
一覧の削除
このアクションにより、ショップの一覧が削除されます。 状態が次のいずれかである場合にのみ、一覧を削除できます: SOLD_OUT、DRAFT、EXPIRED、INACTIVE、ACTIVE および is_available または ACTIVE で、販売者フラグがあります: SUPRESSED (frozen)、VACATION、CUSTOM_SHOPS (pattern)、SELL_ON_FACEBOOK
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
一覧の在庫の取得
一覧の在庫レコードを取得します。 Etsy.com 在庫ツールを使用して編集しなかった一覧には、在庫レコードがありません。 フェッチされる在庫レコードの所有者である場合、このエンドポイントは SKU データを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
含める
|
includes | string |
有効な関連付けを添付する列挙文字列。 |
戻り値
関連付けを使用した 1 つの一覧の在庫レコードの表現
- ListingInventoryWithAssociations
- ListingInventoryWithAssociations
一覧の在庫を更新する
一覧 ID で識別される一覧の在庫を更新します。 製品 SKU、オファリング数量、または価格に指定された値がプロパティ フィールドの値と互換性がない場合、更新は失敗します。 価格を設定するときは、金額リソースで指定されているように、金額を除数で割った値に等しいフロートを割り当てます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | string |
このトランザクションに関連する一覧の数値 ID。 |
|
製品
|
products | True | string |
製品が 1 つしかない場合でも、一覧で使用可能な製品の JSON 配列。 JSON BLOB のすべてのフィールド名は小文字です。 |
|
プロパティの価格
|
price_on_property | string |
製品の価格を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なるサイズの製品に特定の価格を請求する場合、この配列にはサイズのプロパティ ID が含まれます。 |
|
|
プロパティの数量
|
quantity_on_property | string |
製品の数量を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の数量をストックする場合、この配列には色のプロパティ ID が含まれます。 |
|
|
プロパティの SKU
|
sku_on_property | string |
製品の SKU を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の SKU を使用する場合、この配列には色のプロパティ ID が含まれます。 |
戻り値
1 つの一覧の在庫レコードの表現。
- ListingInventory
- ListingInventory
一覧の更新
ショップ ID で識別される特定のショップの、一覧 ID で識別される一覧を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
数量
|
quantity | integer |
一覧で購入可能な正のゼロ以外の製品数。 |
|
|
肩書き
|
title | string |
一覧のタイトル文字列。 有効なタイトル文字列には、文字、数字、句読点、数学記号、空白文字、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) %、:、&、+ 文字はそれぞれ 1 回だけ使用できます。 |
|
|
内容
|
description | string |
一覧で販売されている製品の説明文字列。 |
|
|
価格
|
price | float |
製品の正のゼロ以外の価格。 (販売された商品一覧は非公開です) 注意: 価格は可能な最低価格です。 |
|
|
作成した人
|
who_made | string |
製品を作った人を示す文字列。 購入者が手作りの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「when_made」が必要です。 |
|
|
作成されたとき
|
when_made | string |
作成者がこの一覧の製品を作成した時代の文字列。 購入者がビンテージの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「who_made」が必要です。 |
|
|
分類 ID
|
taxonomy_id | integer |
一覧の数値の分類 ID。 販売者は、ショップの分類 ID の一覧表示を管理します。 |
|
|
発送プロファイル ID
|
shipping_profile_id | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
|
材料
|
materials | string |
製品で使用される材料の材料文字列の配列。 有効な材料文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) |
|
|
ショップ セクション ID
|
shop_section_id | integer |
この一覧のショップ セクションの数値 ID。 |
|
|
最小処理
|
processing_min | integer |
この一覧を処理するために必要な最小日数。 |
|
|
最大処理
|
processing_max | integer |
この一覧を処理するために必要な最大日数。 |
|
|
タグ
|
tags | string |
一覧のタグ文字列の配列。 有効なタグ文字列には、文字、数字、空白文字、-、'、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u) |
|
|
受信者
|
recipient | string |
この商品が適切な贈り物をする人を示す文字列。 |
|
|
機会
|
occasion | string |
この商品が適切な贈り物をする機会を示す文字列。 |
|
|
スタイル
|
styles | string |
この一覧のスタイル文字列の配列。各文字列は、正式な、またはスチームパンクなどの自由形式のテキスト文字列です。 一覧には最大 2 つのスタイルがあります。 有効なスタイル文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) |
|
|
品目の重量
|
item_weight | float |
品目の重量単位で設定された単位で測定された製品の数値重量。 |
|
|
品目の長さ
|
item_length | integer |
品目のディメンション単位で設定された単位で測定された製品の数値の長さ。 |
|
|
品目の幅
|
item_width | float |
「品目のディメンション単位」で設定された単位で測定された製品の数値の幅。 |
|
|
品目の高さ
|
item_height | float |
「品目のディメンション単位」で設定された単位で測定された製品の数値の高さ。 |
|
|
品目の重量単位
|
item_weight_unit | string |
製品の重量を測定するために使用される単位を定義する文字列。 |
|
|
品目のディメンション単位
|
item_dimensions_unit | string |
製品のディメンションを測定するために使用される単位を定義する文字列。 |
|
|
パーソナライズ可能
|
is_personalizable | boolean |
true の場合、この一覧はパーソナライズ可能です。 |
|
|
画像 ID
|
image_ids | string |
一覧内の画像の数値画像 ID の配列。最大 10 個の画像を含めることができます。 |
|
|
供給
|
is_supply | boolean |
true の場合、一覧に供給製品のタグを付けます。それ以外の場合は、それが完成品であることを示します。 購入者が供給の見出しの下の一覧を検索するのに役立ちます。 「作成した人」と「作成したとき」が必要です。 |
|
|
カスタマイズ可能
|
is_customizable | boolean |
true の場合、購入者はカスタマイズされた受注について販売者に連絡できます。 ショップがカスタム受注を受け入れる場合、既定値は true です。 カスタム受注を受け入れないショップには適用されません。 |
|
|
課税対象
|
is_taxable | boolean |
true の場合、チェックアウト時に該当するショップ税率がこの一覧に適用されます。 |
|
|
おすすめランク
|
featured_ rank | integer |
ショップのホーム ページのおすすめリストの左端にランク 1 の一覧が表示されている、ショップのおすすめ一覧の正のゼロ以外の数値の位置。 |
|
|
自動更新する必要があります
|
should_auto_renew | boolean |
true の場合、有効期限が切れると 4 か月間一覧を更新します。 以前は false だったときに true に設定すると、etsy.com は有効期限が切れる前に一覧を更新しますが、更新期間は一覧の有効期限を延長するのではなく、すぐに開始されます。 一覧に残っている未使用の時間は失われます。 更新すると、ユーザーの請求が請求されます。 |
|
|
タイプ
|
type | string |
一覧が物理的ダウンロードかデジタル ダウンロードかを示します。 |
|
|
チャネル
|
channels | string |
列挙されたチャネル ID 文字列の配列。 チャネルは、販売者が売り上げを上げるために買い手に連絡するための場所です。 |
戻り値
製品の数量、タイトル、説明、価格などを含むショップの一覧。
- ShopListing
- ShopListing
一覧の画像の取得
特定の一覧 ID を持つ一覧のすべての一覧画像リソースを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
戻り値
一覧画像リソースの一覧を表します。各リソースには、画像の参照 URL とメタデータが含まれています。
- ListingImages
- ListingImages
一覧の翻訳の取得
指定された言語の一覧の翻訳を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
言語
|
language | True | string |
この翻訳の言語の IETF 言語タグ。 例: de、en、es、fr、it、ja、nl、pl、pt、ru。 |
戻り値
一覧の翻訳データを表します。
- ListingTranslation
- ListingTranslation
一覧の翻訳を作成する
一覧 ID と言語によって一覧翻訳を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
言語
|
language | True | string |
この翻訳の言語の IETF 言語タグ。 例: de、en、es、fr、it、ja、nl、pl、pt、ru。 |
|
肩書き
|
title | True | string |
このトランザクションの一覧のタイトル。 |
|
内容
|
description | True | string |
このトランザクションの一覧の説明。 |
|
タグ
|
tags | string |
このトランザクションの一覧のタグ。 |
戻り値
一覧の翻訳データを表します。
- ListingTranslation
- ListingTranslation
一覧の翻訳を更新する
一覧 ID と言語によって一覧翻訳を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
言語
|
language | True | string |
この翻訳の言語の IETF 言語タグ。 例: de、en、es、fr、it、ja、nl、pl、pt、ru。 |
|
肩書き
|
title | True | string |
このトランザクションの一覧のタイトル。 |
|
内容
|
description | True | string |
このトランザクションの一覧の説明。 |
|
タグ
|
tags | string |
このトランザクションの一覧のタグ。 |
戻り値
一覧の翻訳データを表します。
- ListingTranslation
- ListingTranslation
一覧の製品の取得
ID で一覧製品を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
一覧製品を返すための一覧。 |
|
製品 ID
|
product_id | True | integer |
一覧から購入した特定の製品の数値 ID。 |
戻り値
一覧の製品の表現。
- ListingInventoryProduct
- ListingInventoryProduct
一覧を取得する
一覧 ID によって一覧レコードを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
含める
|
includes | string |
有効な関連付けを添付する列挙文字列。 受け入れ可能な入力は、「ショップ」、「画像」、および「ユーザー」です。 |
一覧ファイルのアップロード
デジタル一覧用の新しいファイルをアップロードするか、既存のファイルを特定の一覧に関連付けます。 既存のファイルの一覧ァイル ID、またはアップロードするファイルの名前とバイナリ ファイル データのいずれかを指定する必要があります。 既存のファイルを物理的な一覧に関連付けると、物理的な一覧がデジタル一覧に変換され、すべての発送コストと製品および在庫の変動がなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
ファイル ID の一覧
|
listing_file_id | integer |
デジタル リストに関連付けられたファイルの一意の数値 ID。 |
|
|
ファイル
|
file | True | string |
アップロードするバイナリ ファイル。 |
|
名称
|
name | string |
アップロードするファイルのファイル名文字列 |
|
|
順位
|
rank | integer |
一覧に表示される画像のゼロ以外の正の数値の位置は、ランク 1 の画像と一緒に一覧の左端の位置に表示されます。 |
戻り値
デジタル リストに関連付けられたファイル。
- ShopListingFile
- ShopListingFile
一覧プロパティの削除
一覧からプロパティを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
プロパティ ID
|
property_id | True | integer |
Etsy 一覧プロパティの一意の ID。 |
一覧プロパティの更新
一覧の製品オファリングを定義するプロパティ一覧を更新または入力します。 各オファリングには、一覧に割り当てられたスケール ID、またはこの要求で一覧に割り当てたスケール ID に有効な値と値 ID の両方が必要です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
プロパティ ID
|
property_id | True | integer |
Etsy 一覧プロパティの一意の ID。 |
|
値 ID
|
value_ids | True | integer |
単一の Etsy.com 測定スケールの数値 ID。 |
|
Values
|
values | True | string |
複数の Etsy 一覧プロパティ値の値文字列の配列。 |
|
スケール ID
|
scale_id | integer |
単一の Etsy.com 測定スケールの数値 ID。 |
戻り値
構造化データ値の表現。
- ListingPropertyValue
- ListingPropertyValue
一覧画像の削除
一覧画像を削除します。 ファイルのコピーはサーバーに残っているため、削除された画像は、元の画像を再アップロードせずに一覧に再関連付けされる場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
一覧画像 ID
|
listing_image_id | True | integer |
このトランザクションの主要な一覧画像の数値 ID。 |
一覧画像の取得
特定の画像 ID を持つ一覧画像の参照とメタデータを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
一覧画像 ID
|
listing_image_id | True | integer |
このトランザクションの主要な一覧画像の数値 ID。 |
戻り値
特定の一覧に関連付けられている画像の参照 URL とメタデータ。 url_fullxfull パラメータには、フルサイズのバイナリ画像ファイルの URL が含まれます。
- ListingImage
- ListingImage
一覧画像をアップロードする
ショップ ID と一覧 ID で識別される一覧に画像をアップロードまたは割り当てます。 新しい画像をアップロードするには、画像パラメータの値として画像ファイルを設定します。 一覧画像 ID パラメーターで削除された画像の画像 ID を使用して、以前に削除された画像を一覧に割り当てることができます。 要求に画像と一覧画像 ID パラメーター値の両方が含まれている場合、エンドポイントは画像パラメーターの画像のみをアップロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
一覧 ID
|
listing_id | True | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
Image
|
image | string |
アップロードするファイルのファイル名文字列。 |
|
|
一覧画像 ID
|
listing_image_id | integer |
このトランザクションの主要な一覧画像の数値 ID。 |
|
|
順位
|
rank | integer |
一覧に表示される画像のゼロ以外の正の数値の位置は、ランク 1 の画像と一緒に一覧の左端の位置に表示されます。 |
|
|
上書き
|
overwrite | boolean |
true の場合、この要求は指定されたランクの既存の画像を置き換えます。 |
|
|
透かしが入っている
|
is_watermarked | boolean |
true の場合、アップロードされた画像に透かしがあることを示します。 |
戻り値
特定の一覧に関連付けられている画像の参照 URL とメタデータ。 url_fullxfull パラメータには、フルサイズのバイナリ画像ファイルの URL が含まれます。
- ListingImage
- ListingImage
下書き一覧を作成する
Etsy チャネルのショップで物理的な下書き一覧製品を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
品質
|
quantity | True | integer |
一覧で購入可能な正のゼロ以外の製品数。 |
|
肩書き
|
title | True | string |
一覧のタイトル文字列。 有効なタイトル文字列には、文字、数字、句読点、数学記号、空白文字、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) %、:、&、+ 文字はそれぞれ 1 回だけ使用できます。 |
|
内容
|
description | True | string |
一覧で販売されている製品の説明文字列。 |
|
価格
|
price | True | float |
製品の正のゼロ以外の価格。 (販売された商品一覧は非公開です) 注意: 価格は可能な最低価格です。 |
|
作成した人
|
who_made | True | string |
製品を作った人を示す文字列。 購入者が手作りの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「when_made」が必要です。 |
|
作成されたとき
|
when_made | string |
作成者がこの一覧の製品を作成した時代の文字列。 購入者がビンテージの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「who_made」が必要です。 |
|
|
分類 ID
|
taxonomy_id | True | integer |
一覧の数値の分類 ID。 販売者は、ショップの分類 ID の一覧表示を管理します。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
材料
|
materials | string |
製品で使用される材料の材料文字列の配列。 有効な材料文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) |
|
|
ショップ セクション ID
|
shop_section_id | integer |
この一覧のショップ セクションの数値 ID。 |
|
|
最小処理
|
processing_min | integer |
この一覧を処理するために必要な最小日数。 |
|
|
最大処理
|
processing_max | integer |
この一覧を処理するために必要な最大日数。 |
|
|
タグ
|
tags | string |
一覧のタグ文字列の配列。 有効なタグ文字列には、文字、数字、空白文字、-、'、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u) |
|
|
受信者
|
recipient | string |
この商品が適切な贈り物をする人を示す文字列。 |
|
|
機会
|
occasion | string |
この商品が適切な贈り物をする機会を示す文字列。 |
|
|
スタイル
|
styles | string |
この一覧のスタイル文字列の配列。各文字列は、正式な、またはスチームパンクなどの自由形式のテキスト文字列です。 一覧には最大 2 つのスタイルがあります。 有効なスタイル文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) |
|
|
品目の重量
|
item_weight | float |
品目の重量単位で設定された単位で測定された製品の数値重量。 |
|
|
品目の長さ
|
item_length | integer |
品目のディメンション単位で設定された単位で測定された製品の数値の長さ。 |
|
|
品目の幅
|
item_width | float |
「品目のディメンション単位」で設定された単位で測定された製品の数値の幅。 |
|
|
品目の高さ
|
item_height | float |
「品目のディメンション単位」で設定された単位で測定された製品の数値の高さ。 |
|
|
品目の重量単位
|
item_weight_unit | string |
製品の重量を測定するために使用される単位を定義する文字列。 |
|
|
品目のディメンション単位
|
item_dimensions_unit | string |
製品のディメンションを測定するために使用される単位を定義する文字列。 |
|
|
パーソナライズ可能
|
is_personalizable | boolean |
true の場合、この一覧はパーソナライズ可能です。 |
|
|
画像 ID
|
image_ids | string |
一覧内の画像の数値画像 ID の配列。最大 10 個の画像を含めることができます。 |
|
|
供給
|
is_supply | boolean |
true の場合、一覧に供給製品のタグを付けます。それ以外の場合は、それが完成品であることを示します。 購入者が供給の見出しの下の一覧を検索するのに役立ちます。 「作成した人」と「作成したとき」が必要です。 |
|
|
カスタマイズ可能
|
is_customizable | boolean |
true の場合、購入者はカスタマイズされた受注について販売者に連絡できます。 ショップがカスタム受注を受け入れる場合、既定値は true です。 カスタム受注を受け入れないショップには適用されません。 |
|
|
課税対象
|
is_taxable | boolean |
true の場合、チェックアウト時に該当するショップ税率がこの一覧に適用されます。 |
戻り値
製品の数量、タイトル、説明、価格などを含むショップの一覧。
- ShopListing
- ShopListing
出荷受領書を作成する
ショップ受領書の追跡情報を送信します。これにより、指定された受領書 ID のショップ受領書出荷エントリが作成されます。 追跡情報を正常に送信するたびに、Etsy は購入者ユーザーに通知メールを送信します。 送信 BCC が true の場合、Etsy は販売者にも発送通知を送信します。 追跡コードと配送業者名が送信されないとき、領収書は発送済みとしてのみマークされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
受領書 ID
|
receipt_id | True | integer |
追跡を送信するための領収書。 |
|
追跡コード
|
tracking_code | string |
この領収書の追跡コード。 |
|
|
配送業者名
|
carrier_name | string |
この領収書の配送業者の名前。 |
|
|
BCC を送信する
|
send_bcc | boolean |
true の場合、配送通知は販売者にも送信される |
戻り値
ショップからの購入のレコード。 ショップの領収書には、ショップの通貨を使用して金銭の値が表示されます。
- ShopReceipt
- ShopReceipt
分類 ID で製品プロパティを取得する
特定の販売者分類 ID でサポートされている、適用できるスケールと値を含む製品プロパティの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
分類 ID
|
taxonomy_id | True | string |
Etsy 分類ノードの ID を表す一意の数値。これは販売担当者の分類階層ツリーにまとめた目録のメタデータ カテゴリです。 |
戻り値
製品プロパティ定義の一覧。
- TaxonomyNodeProperties
- TaxonomyNodeProperties
所有者 ID でショップを取得する
ショップ所有者のユーザー ID で識別されるショップを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user_id | True | string |
このショップを所有するユーザーの数値ユーザー ID。 |
戻り値
Etsy ユーザーが作成したショップ。
- ショップ
- Shop
支払いアカウント元帳エントリ ID から支払いを取得する
支払いアカウント元帳エントリ ID から支払いを取得します (該当する場合)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
元帳エントリ ID
|
ledger_entry_ids | True | string |
整数の配列。 |
戻り値
Etsy 支払で行われたいくつかの支払いを表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
- Payments
- Payments
支払の一覧を取得する
ショップ ID で識別されるショップから支払いの一覧を取得します。 支払い ID の一覧を使用して結果をフィルターすることもできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
Payment ID
|
payment-ids | True | string |
支払い ID 番号のコンマ区切りの配列。 |
戻り値
Etsy 支払で行われたいくつかの支払いを表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
- Payments
- Payments
特定の領収書から支払いを取得する
特定の領収書から、領収書 ID で識別された、特定のショップから、ショップ ID で識別された支払を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
受領書 ID
|
receipt_id | True | string |
このトランザクションに関連する領収書の数値 ID。 |
戻り値
Etsy 支払で行われたいくつかの支払いを表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
- Payments
- Payments
発送プロファイル アップグレードの作成
新しい発送プロファイルのアップグレードを作成します。これにより、代替の運送業者やより速い配送などの発送オプションの価格を確立できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
タイプ
|
type | True | string |
発送アップグレードのタイプ。 国内 (0) または国際 (1)。 |
|
アップグレード名
|
upgrade_name | True | string |
チェックアウト時に買い物客に表示される発送アップグレードの名前 (例: USPS 優先度など)。 |
|
価格
|
price | True | float |
発送アップグレードを追加するための追加コスト。 |
|
副次価格
|
secondary_price | True | float |
追加品目ごとに発送アップグレードを追加するための追加コスト。 |
|
運送業者 ID
|
shipping_carrier_id | integer |
配送予定日を計算するために使用される、サポートされている配送業者の一意の ID。 |
|
|
メール クラス
|
mail_class | string |
配送予定日を計算するために使用される、配送業者のメール クラスの一意の ID 文字列。 |
|
|
最小配送日数
|
min_delivery_days | integer |
min_delivery_days |
|
|
最大配送日数
|
max_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最大営業日数。 |
戻り値
発送プロファイル アップグレード オプションの表現。
- ShopShippingProfileUpgrade
- ShopShippingProfileUpgrade
発送プロファイル アップグレードの削除
発送プロファイル アップグレードを削除し、関連付けられた発送プロファイルを使用するすべての一覧からアップグレード オプションを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
発送プロファイルの数値 ID。 |
|
アップグレード ID
|
upgrade_id | True | integer |
発送アップグレードに関連付けられている数値 ID |
発送プロファイル アップグレードの更新
発送プロファイルのアップグレードを更新し、発送プロファイルを使用するすべての一覧を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
アップグレード ID
|
upgrade_id | True | integer |
発送アップグレードに関連付けられている数値 ID |
|
タイプ
|
type | string |
発送アップグレードのタイプ。 国内 (0) または国際 (1)。 |
|
|
アップグレード名
|
upgrade_name | string |
チェックアウト時に買い物客に表示される発送アップグレードの名前 (例: USPS 優先度など)。 |
|
|
価格
|
price | float |
発送アップグレードを追加するための追加コスト。 |
|
|
副次価格
|
secondary_price | float |
追加品目ごとに発送アップグレードを追加するための追加コスト。 |
|
|
運送業者 ID
|
shipping_carrier_id | integer |
配送予定日を計算するために使用される、サポートされている配送業者の一意の ID。 |
|
|
メール クラス
|
mail_class | string |
配送予定日を計算するために使用される、配送業者のメール クラスの一意の ID 文字列。 |
|
|
最小配送日数
|
min_delivery_days | integer |
min_delivery_days |
|
|
最大配送日数
|
max_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最大営業日数。 |
戻り値
発送プロファイル アップグレード オプションの表現。
- ShopShippingProfileUpgrade
- ShopShippingProfileUpgrade
発送プロファイル アップグレードを取得する
特定の発送プロファイルに割り当てられた発送プロファイルのアップグレードの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
戻り値
発送アップグレード オプションの一覧。
- ShopShippingProfileUpgrades
- ShopShippingProfileUpgrades
発送プロファイルでプロファイルの宛先を取得する
発送プロファイルに関連付けられている発送先オブジェクトの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
戻り値
発送先オブジェクトの一覧を表します。
- ShopShippingProfileDestinations
- ShopShippingProfileDestinations
発送プロファイルの作成
新しい発送プロファイルの作成。 発送プロファイルを作成するとき、国の ISO コードまたは地域を渡すことができますが、両方を渡すことはできません。 1 つだけ必要です。 運送業者 ID とメール クラスのいずれか、または最小配送日と最大配送日の両方を渡す必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
肩書き
|
title | True | string |
この配送プロファイルの名前文字列。 |
|
発送元の国 ISO
|
origin_country_iso | True | string |
一覧の発送元の国の ISO コード。 |
|
基本原価
|
primary_cost | True | float |
ストアの既定の通貨で測定された、この国/地域のみへの送料。 |
|
副次原価
|
secondary_cost | True | float |
ストアの既定の通貨で測定された、別のアイテムを含むこの国/地域への送料。 |
|
最小処理時間
|
min_processing_time | True | integer |
この配送プロファイルで一覧を配送するために処理するのに必要な最小時間。 |
|
最大処理時間
|
max_processing_time | True | integer |
一覧の発送に必要な最大処理時間。 |
|
処理時間単位
|
processing_time_unit | string |
処理時間の長さを表すために使用される単位。 1 週間は 5 営業日と同じです。 |
|
|
配送先の国 ISO
|
destination_country_iso | string |
一覧の発送先の国の ISO コード。 null 値の場合、要求は宛先を宛先地域に設定します。 |
|
|
宛先地域
|
destination_region | string |
一覧の発送先の地域のコード。 地域は一連の国を表します。 サポートされている地域は、欧州連合と非欧州連合 (EU 以外のヨーロッパの国) です。 ない場合、要求は宛先を宛先国 ISO に設定し、宛先国 ISO も null 値の場合はどこにでも設定します。 |
|
|
発送元郵便番号
|
origin_postal_code | string |
一覧の発送元の郵便番号文字列 (必ずしも番号である必要はありません)。 |
|
|
運送業者 ID
|
shipping_carrier_id | integer |
配送予定日を計算するために使用される、サポートされている配送業者の一意の ID。 |
|
|
メール クラス
|
mail_class | string |
配送予定日を計算するために使用される、配送業者のメール クラスの一意の ID 文字列。 |
|
|
最小配送日数
|
min_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最小営業日数。 |
|
|
最大配送日数
|
max_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最大営業日数。 |
戻り値
一覧の発送情報を設定するために使用されるプロファイルを表します。 API を介して計算された発送テンプレートを作成することはできないことに注意してください。 ただし、API を使用して、ショップ マネージャーから作成された計算された発送プロファイルを関連付けることができます。
- ShopShippingProfile
- ShopShippingProfile
発送プロファイルの削除
指定された ID で発送プロファイルを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
戻り値
一覧の発送情報を設定するために使用されるプロファイルを表します。 API を介して計算された発送テンプレートを作成することはできないことに注意してください。 ただし、API を使用して、ショップ マネージャーから作成された計算された発送プロファイルを関連付けることができます。
- ShopShippingProfile
- ShopShippingProfile
発送プロファイルの更新
発送プロファイルの設定を変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
肩書き
|
title | string |
この配送プロファイルの名前文字列。 |
|
|
発送元の国 ISO
|
origin_country_iso | string |
一覧の発送元の国の ISO コード。 |
|
|
最小処理時間
|
min_processing_time | integer |
この配送プロファイルで一覧を配送するために処理するのに必要な最小時間。 |
|
|
最大処理時間
|
max_processing_time | integer |
一覧の発送に必要な最大処理時間。 |
|
|
処理時間単位
|
processing_time_unit | string |
処理時間の長さを表すために使用される単位。 1 週間は 5 営業日と同じです。 何も指定されていない場合、単位は business_days に設定されます。 |
|
|
発送元郵便番号
|
origin_postal_code | string |
一覧の発送元の郵便番号文字列 (必ずしも番号である必要はありません)。 |
戻り値
一覧の発送情報を設定するために使用されるプロファイルを表します。 API を介して計算された発送テンプレートを作成することはできないことに注意してください。 ただし、API を使用して、ショップ マネージャーから作成された計算された発送プロファイルを関連付けることができます。
- ShopShippingProfile
- ShopShippingProfile
発送プロファイルを取得する
発送プロファイル ID によって参照される発送プロファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
発送プロファイルを取得する
ショップ ID で識別される特定の Etsy ショップで使用可能な発送プロファイルの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
戻り値
一覧の発送情報を設定するために使用されるプロファイルを表します。 API を介して計算された発送テンプレートを作成することはできないことに注意してください。 ただし、API を使用して、ショップ マネージャーから作成された計算された発送プロファイルを関連付けることができます。
- ShopShippingProfile
- ShopShippingProfile
発送プロファイル宛先の作成
新しい発送先を作成します。これにより、発送プロファイルの宛先の発送コスト、運送業者、およびクラスが設定されます。 これにより、関連するショップの通貨を使用してコストが割り当てられます。 宛先国 ISO または宛先地域のいずれかを使用して宛先を設定します。宛先国 ISO と宛先地域は相互に排他的です — どちらか一方を設定します。 両方を設定すると、エラー 400 がトリガーされます。 要求で宛先国 ISO も宛先地域も設定されていない場合、既定の宛先はどこにでもあります。 また、運送業者 ID とメール クラスの両方を割り当てるか、最小配送日と最大配送日の両方を割り当てる必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
基本原価
|
primary_cost | True | float |
ストアの既定の通貨で測定された、この国/地域のみへの送料。 |
|
副次原価
|
secondary_cost | True | string |
ストアの既定の通貨で測定された、別のアイテムを含むこの国/地域への送料。 |
|
destination_country_iso
|
destination_country_iso | string |
destination_country_iso |
|
|
destination_region
|
destination_region | string |
destination_region |
|
|
shipping_carrier_id
|
shipping_carrier_id | integer |
shipping_carrier_id |
|
|
mail_class
|
mail_class | string |
mail_class |
|
|
min_delivery_days
|
min_delivery_days | integer |
min_delivery_days |
|
|
max_delivery_days
|
max_delivery_days | integer |
max_delivery_days |
戻り値
発送プロファイルに割り当てられた発送先を表します。
- ShopShippingProfileDestination
- ShopShippingProfileDestination
発送プロファイル宛先の削除
発送先を削除し、関連付けられた発送プロファイルを使用するすべての一覧から宛先オプションを削除します。 発送プロファイルには少なくとも 1 つの宛先が必要であるため、このエンドポイントは発送プロファイルの最終的な発送先を削除できません。 発送プロファイルから最終的な発送先を削除するには、発送プロファイル全体を削除する必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
発送プロファイル宛先 ID
|
shipping_profile_destination_id | True | integer |
一覧に関連付けられた発送プロファイルの発送プロファイル宛先の数値 ID。 |
発送プロファイル宛先の更新
既存の発送先を更新します。これにより、発送コスト、運送業者および宛先のクラスを設定または再割り当てできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | True | string |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
発送プロファイル宛先 ID
|
shipping_profile_destination_id | True | string |
一覧内の発送プロファイル destinationassociated の数値 ID。 |
|
primary_cost
|
primary_cost | string |
primary_cost |
|
|
secondary_cost
|
secondary_cost | string |
secondary_cost |
|
|
destination_country_iso
|
destination_country_iso | string |
destination_country_iso |
|
|
destination_region
|
destination_region | string |
destination_region |
|
|
shipping_carrier_id
|
shipping_carrier_id | integer |
shipping_carrier_id |
|
|
mail_class
|
mail_class | string |
mail_class |
|
|
min_delivery_days
|
min_delivery_days | integer |
min_delivery_days |
|
|
max_delivery_days
|
max_delivery_days | integer |
max_delivery_days |
戻り値
発送プロファイルに割り当てられた発送先を表します。
- ShopShippingProfileDestination
- ShopShippingProfileDestination
販売者の分類ノードを取得する
運送業者を取得する
特定の国で使用可能な運送業者とそれらに関連付けられているメール クラスの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
発送元の国 ISO
|
origin_country_iso | True | string |
一覧の発送元の国の ISO コード。 |
戻り値
いくつかの ShippingCarriers を表します。
- ShippingCarriers
- ShippingCarriers
領収書のトランザクションを取得する
特定の領収書に関連付けられているトランザクションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
受領書 ID
|
receipt_id | True | integer |
このトランザクションに関連する領収書の数値 ID。 |
戻り値
ショップ領収書トランザクション リソースのセット
- ShopReceiptTransactions
- ShopReceiptTransactions
領収書を取得
領収書 ID の範囲またはオフセット、日付、支払い済みや発送済みの購入によってフィルター処理されていないか、フィルター処理されているか、特定のショップからのショップ領収書を要求します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
最小作成数
|
min_created | integer |
レコード作成時用の最も早い unix タイムスタンプ。 |
|
|
最大作成数
|
max_created | integer |
レコード作成時用の最も遅い unix タイムスタンプ。 |
|
|
最も早い最終変更
|
min_last_modified | integer |
最後に変更されたレコード作成時用の最も早い unix タイムスタンプ。 |
|
|
最も遅い最終変更
|
max_last_modified | integer |
最後に変更されたレコード作成時用の最も遅い unix タイムスタンプ。 |
|
|
限度
|
limit | integer |
返す結果の最大件数。 |
|
|
オフセット
|
offset | integer |
最初の結果を選択する前にスキップするレコードの数。 |
|
|
支払われた
|
was_paid | boolean |
true の場合、販売者はこの領収書にある製品の支払いを受け取りました。 |
|
|
発送された
|
was_shipped | boolean |
true の場合、販売者はこの領収書にある製品を発送しました。 |
戻り値
特定のショップの領収書。
- ShopReceipts
- ShopReceipts
領収書を取得する
領収書 ID で識別された、Etsy ショップからの領収書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ショップ ID
|
shop_id | True | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
受領書 ID
|
receipt_id | True | integer |
このトランザクションに関連する領収書の数値 ID。 |
戻り値
ショップからの購入のレコード。 ショップの領収書には、ショップの通貨を使用して金銭の値が表示されます。
- ShopReceipt
- ShopReceipt
定義
ShopListing
製品の数量、タイトル、説明、価格などを含むショップの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
一覧 ID
|
listing_id | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
ユーザー ID
|
user_id | integer |
一覧を投稿するユーザーの数値 ID。 |
|
ショップ ID
|
shop_id | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
肩書き
|
title | string |
一覧のタイトル文字列。 有効なタイトル文字列には、文字、数字、句読点、数学記号、空白文字、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) %、:、&、+ 文字はそれぞれ 1 回だけ使用できます。 |
|
内容
|
description | string |
一覧で販売されている製品の説明文字列。 |
|
州
|
state | State |
アクティブまたは非アクティブのいずれかから列挙された文字列。 注: 下書き一覧をアクティブに設定すると、リスト一覧は etsy.com にも公開されます。 |
|
タイムスタンプの作成
|
creation_timestamp | integer |
一覧の作成時間 (エポック秒単位)。 |
|
終了タイムスタンプ
|
ending_timestamp | integer |
一覧の有効期限 (エポック秒単位)。 |
|
元の作成タイムスタンプ
|
original_creation_timestamp | integer |
一覧の作成時間 (エポック秒単位)。 |
|
最終変更のタイムスタンプ
|
last_modified_timestamp | integer |
一覧の最後の更新時刻 (エポック秒単位)。 |
|
最終状態変更タイムスタンプ
|
state_timestamp | integer |
この一覧の最後の状態変化の日時。 |
|
数量
|
quantity | integer |
一覧で購入可能な正のゼロ以外の製品数。 注: 一覧数量は、使用可能なオファリング数量の合計です。 一覧在庫の取得エンドポイントを使用して、ListingInventory リソースから個々のオファリングの数量をリクエストできます。 |
|
ショップ セクション ID
|
shop_section_id | integer |
特定の Etsy ショップのセクションの数値 ID。 |
|
おすすめランク
|
featured_rank | integer |
ショップのホーム ページのおすすめリストの左端にランク 1 の一覧が表示されている、ショップのおすすめ一覧の正のゼロ以外の数値の位置。 |
|
[URL]
|
url | string |
Etsy の一覧ページへの完全な URL。 |
|
お気に入りの数
|
num_favorers | integer |
この一覧をお気に入りとしてマークしたユーザーの数。 |
|
非課税
|
non_taxable | boolean |
true の場合、チェックアウト時に該当するショップ税率がこの一覧に適用されません。 |
|
カスタマイズ可能
|
is_customizable | boolean |
true の場合、購入者はカスタマイズされた受注について販売者に連絡できます。 ショップがカスタム受注を受け入れる場合、既定値は true です。 カスタム受注を受け入れないショップには適用されません。 |
|
パーソナライズ可能
|
is_personalizable | boolean |
true の場合、この一覧はパーソナライズ可能です。 既定値は null 値です。 |
|
パーソナライズが必要
|
personalization_is_required | boolean |
true の場合、この一覧はパーソナライズが必要です。 既定値は null 値です。 |
|
最大パーソナライズ文字数
|
personalization_char_count_max | integer |
これは、購入者が入力したパーソナライズ メッセージの最大長を表す整数値です。 |
|
パーソナライズ手順
|
personalization_instructions | string |
true の場合、この一覧はパーソナライズが必要です。 既定値は null 値です。 |
|
一覧の種類
|
listing_type | boolean |
一覧が物理的ダウンロードであるかデジタル ダウンロードであるかを示す列挙タイプ文字列。 |
|
タグ
|
tags | array of string |
一覧のタグ文字列の一覧。 有効なタグ文字列には、文字、数字、空白文字、-、'、™、©、および ® のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) 既定値は null 値です。 |
|
材料
|
materials | array of string |
製品で使用される材料の材料文字列の一覧。 有効な材料文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) 既定値は null 値です。 |
|
発送プロファイル ID
|
shipping_profile_id | integer |
一覧に関連付けられた発送プロファイルの数値 ID。 |
|
最小処理日数
|
processing_min | integer |
この一覧を処理するために必要な最小日数。 既定値は null 値です。 |
|
最大処理日数
|
processing_max | integer |
この一覧を処理するために必要な最大日数。 既定値は null 値です。 |
|
WhoMade
|
who_made | WhoMade |
製品を作った人を示す列挙文字列。 購入者が手作りの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「when_made」が必要です。 |
|
WhenMade
|
when_made | WhenMade |
作成者がこの一覧の製品を作成した時代の列挙文字列。 購入者がビンテージの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「who_made」が必要です。 |
|
製品の供給
|
is_supply | boolean |
true の場合、一覧に供給製品のタグを付けます。それ以外の場合は、それが完成品であることを示します。 購入者が供給の見出しの下の一覧を検索するのに役立ちます。 「who_made」と「when_made」が必要です。 |
|
品目の重量
|
item_weight | double |
品目の重量単位で設定された単位で測定された製品の数値重量。 既定値は null 値です。 設定されている場合、0 より大きい値を指定してください。 |
|
ItemWeightUnit
|
item_weight_unit | ItemWeightUnit |
製品の重量を測定するために使用される単位を定義する文字列。 既定値は null 値です。 |
|
品目の長さ
|
item_length | double |
品目のディメンション単位で設定された単位で測定された製品の数値の長さ。 既定値は null 値です。 設定されている場合、0 より大きい値を指定してください。 |
|
品目の幅
|
item_width | double |
品目のディメンション単位で設定された単位で測定された製品の数値の幅。 既定値は null 値です。 設定されている場合、0 より大きい値を指定してください。 |
|
品目の高さ
|
item_height | double |
品目のディメンション単位で設定された単位で測定された製品の数値の長さ。 既定値は null 値です。 設定されている場合、0 より大きい値を指定してください。 |
|
ItemDimensionsUnit
|
item_dimensions_unit | ItemDimensionsUnit |
製品のディメンションを測定するために使用される単位を定義する文字列。 既定値は null 値です。 |
|
非公開
|
is_private | boolean |
true の場合、これは特定の購入者を対象とした非公開の一覧であり、ショップ ビューからは非表示になっています。 |
|
受信者
|
recipient | Recipient |
この製品が適切な贈り物をする人を示す列挙文字列。 既定値は null 値です。 |
|
機会
|
occasion | Occasion |
この製品が適切な贈り物をする機会を示す列挙文字列。 既定値は null 値です。 |
|
スタイル
|
style | array of string |
この一覧のスタイル文字列の配列。各文字列は、正式な、またはスチームパンクなどの自由形式のテキスト文字列です。 一覧には最大 2 つのスタイルがあります。 有効なスタイル文字列には、文字、数字、および空白文字のみが含まれます。 (正規表現: /[^\p{L}\p{Nd}\p{Zs}]/u) 既定値は null 値です。 |
|
ファイル データ
|
file_data | string |
デジタル一覧に添付されたファイルを説明する文字列。 |
|
バリエーションがある
|
has_variations | boolean |
true の場合、一覧にはバリエーションがあります。 |
|
自動更新する必要があります
|
should_auto_renew | boolean |
true の場合、有効期限が切れると 4 か月間一覧を更新します。 以前は false だったときに true に設定すると、etsy.com は有効期限が切れる前に一覧を更新しますが、更新期間は一覧の有効期限を延長するのではなく、すぐに開始されます。 一覧に残っている未使用の時間は失われます。 更新すると、ユーザーの請求が請求されます。 |
|
言語
|
language | string |
一覧の既定の言語の IETF 言語タグ。 例: |
|
Money
|
price | Money |
金額の表現。 |
|
分類 ID
|
taxonomy_id | integer |
一覧の数値の分類 ID。 販売者は、ショップの分類 ID の一覧表示を管理します。 詳しくは、販売者の分類を参照してください。 |
Money
金額の表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
量
|
amount | integer |
このデータによって表される量。 |
|
除数
|
divisor | integer |
金額をレンダリングする除数。 |
|
通貨コード
|
currency_code | string |
このデータの ISO 通貨コード。 |
ShopListingFile
デジタル リストに関連付けられたファイル。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ファイル ID の一覧
|
listing_file_id | integer |
デジタル リストに関連付けられたファイルの一意の数値 ID。 |
|
一覧 ID
|
listing_id | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
順位
|
rank | integer |
一覧のこのファイルの表示順序位置の数値インデックスは、1 から始まります。 |
|
ファイル名
|
filename | string |
デジタル一覧に関連付けられているファイルのファイル名文字列。 |
|
ファイルサイズ
|
filesize | string |
ファイル サイズの人間が読み取り可能な形式のサイズ文字列。 |
|
サイズ (バイト数)
|
size_bytes | integer |
ファイルのサイズを示す数値で、バイト単位で測定されます。 |
|
Filetype
|
filetype | string |
ファイルの MIME タイプを示すタイプ文字列。 |
|
タイムスタンプの作成
|
create_timestamp | integer |
デジタル リストに関連付けられたファイルの一意の数値タイムスタンプ。 |
ShopListingFiles
いくつかの ShopListingFiles を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
返された ShopListingFiles の数です。 |
|
結果
|
results | array of ShopListingFile |
ShopListingFile リソースの配列。 |
ShopListings
ショップ一覧リソースのセット。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップ一覧リソースの数が見つかりました。 |
|
結果
|
results | array of ShopListing |
ショップ一覧リソースが見つかりました。 |
ユーザー
サイトの単一ユーザーを表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー ID
|
user_id | integer |
ユーザーの数値 ID。 この番号は、ユーザーのショップの有効なショップ ID でもあります。 |
|
ログイン名
|
login_name | string |
ユーザーのログイン名文字列。 |
|
既定メール
|
primary_email | string |
ユーザーのプライマリ メール アドレスのメール アドレス文字列。 |
|
名
|
first_name | string |
ユーザーの名。 |
|
姓
|
last_name | string |
ユーザーの姓。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
ユーザーがアカウントを作成した日時 (エポック秒単位)。 |
|
参照元ユーザーの ID
|
referred_by_user_id | integer |
このユーザーを参照するユーザーの数値ユーザー ID。 |
|
新しい在庫エンドポイントを使用する
|
use_new_inventory_endpoints | boolean |
廃止されました。 常に信頼します。 |
|
販売者である
|
is_seller | boolean |
ユーザーが販売者の場合は true。 |
|
略歴
|
bio | string |
ユーザーの略歴。 |
|
ジェンダー
|
gender | string |
ユーザーの性別。 |
|
生年月日 (月)
|
birth_month | string |
ユーザーの生年月。 |
|
誕生日
|
birth_day | string |
ユーザーの生年日。 |
|
トランザクション回数を購入
|
transaction_buy_count | integer |
ユーザーが購入したトランザクションの数。 |
|
トランザクション回数を販売済み
|
transaction_sold_count | integer |
ユーザーが販売したトランザクションの数。 |
ショップ
Etsy ユーザーが作成したショップ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ショップ ID
|
shop_id | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
User ID
|
user_id | integer |
このショップを所有するユーザーの数値ユーザー ID。 |
|
ショップ名
|
shop_name | string |
ショップの名前の文字列。 |
|
作成日
|
create_date | integer |
このショップが作成された日時 (エポック秒単位)。 |
|
肩書き
|
title | string |
ショップのメイン ページの簡単な見出し文字列。 |
|
お知らせ
|
announcement | string |
ショップのホームページに表示される購買担当者へのお知らせ文字列。 |
|
通貨コード
|
currency_code | string |
ショップの通貨の ISO (アルファベット) コード。 ショップでは、既定ですべての価格がこの通貨で表示されます。 |
|
休暇中
|
is_vacation | boolean |
true の場合、このショップは購入を受け入れていません。 |
|
休暇メッセージ
|
vacation_message | string |
is_vacation が true の場合に表示されるショップのメッセージ文字列。 |
|
販売メッセージ
|
sale_message | string |
このショップからの購入を完了したユーザーに送信されるメッセージ文字列。 |
|
デジタル販売メッセージ
|
digital_sale_message | string |
このショップからのデジタル品目を購入するユーザーに送信されるメッセージ文字列。 |
|
更新日
|
update_date | integer |
ショップの最後の更新日時 (エポック秒単位)。 |
|
アクティブな一覧数
|
listing_active_count | integer |
ショップ内のアクティブ一覧の数。 |
|
デジタル一覧数
|
digital_listing_count | integer |
ショップ内のデジタル一覧の数。 |
|
ログイン名
|
login_name | string |
ショップ所有者のログイン名文字列。 |
|
カスタム要求を受け入れる
|
accepts_custom_requests | boolean |
true の場合、ショップはカスタマイズ要求を受け入れます。 |
|
ウェルカム ポリシー
|
policy_welcome | string |
ショップのポリシー ウェルカム文字列 (空白の場合があります)。 |
|
支払ポリシー
|
policy_payment | string |
ショップの支払いポリシー文字列 (空白の場合があります)。 |
|
発送ポリシー
|
policy_shipping | string |
ショップの発送ポリシー文字列 (空白の場合があります)。 |
|
払戻ポリシー
|
policy_refunds | string |
ショップの払戻ポリシー文字列 (空白の場合があります)。 |
|
追加のポリシー
|
policy_additional | string |
ショップの追加のポリシー文字列 (空白の場合があります)。 |
|
販売者情報
|
policy_seller_info | string |
ショップの販売者情報の文字列 (空白の場合があります)。 |
|
ポリシーの更新日
|
policy_update_date | integer |
ショップのポリシーの更新日時 (エポック秒単位)。 |
|
非公開領収書ポリシーがある
|
policy_has_private_receipt_info | boolean |
true の場合、EU の領収書には非公開情報が表示されます。 |
|
非構造化ポリシーがある
|
has_unstructured_policies | boolean |
true の場合、ショップは追加の非構造化ポリシー フィールドを表示します。 |
|
プライバシー ポリシー
|
policy_privacy | string |
ショップのプライバシーポリシー文字列 (空白の場合があります)。 |
|
休暇の自動応答
|
vacation_autoreply | string |
is_vacation が true の場合、新しい会話に表示されるショップの自動応答文字列。 |
|
URL
|
url | string |
このショップの URL 文字列。 |
|
バナー画像 URL
|
image_url_760x100 | string |
このショップのバナー画像の URL 文字列。 |
|
お気に入りの数
|
num_favorers | integer |
このショップをお気に入りとしてマークしたユーザーの数。 |
|
言語
|
languages | array of string |
ショップに登録されている言語の言語文字列の一覧。 |
|
アイコン画像 URL
|
icon_url_fullxfull | string |
このショップのアイコン画像の URL 文字列。 |
|
構造化ポリシーを使用している
|
is_using_structured_policies | boolean |
true の場合、ショップは構造化ポリシーを使用して承諾しました。 |
|
オンボードされた構造化ポリシーがある
|
has_onboarded_structured_policies | boolean |
true の場合、ショップは構造化ポリシーのオンボードを確認した後、承諾または拒否しました。 |
|
リンクからの争議を含める
|
include_dispute_form_link | boolean |
true の場合、このショップのポリシーには EU オンライン争議フォームへのリンクが含まれています。 |
|
ダイレクト チェックアウトはオンボードされているか
|
is_direct_checkout_onboarded | boolean |
true の場合、ショップは Etsy 支払がオンボードされています。 |
|
計算された発送利用資格か
|
is_calculated_eligible | boolean |
true の場合、ショップは計算された発送プロファイルの利用資格です。 (米国およびカナダでのみ使用可能) |
|
購入者の在庫にオプトインされているか
|
is_opted_in_to_buyer_promise | boolean |
true の場合、ショップは購入者の在庫をオプトインしました。 |
|
米国を拠点としている
|
is_shop_us_based | boolean |
true の場合、ショップは米国に拠点があります。 |
|
営業トランザクション回数
|
transaction_sold_count | integer |
このショップの営業トランザクションの合計数 |
|
国 ISO から発送
|
shipping_from_country_iso | string |
ショップの発送元の国 ISO。 |
|
ショップの場所 ISO
|
shop_location_country_iso | string |
ショップの場所がある国 ISO。 |
|
レビュー数
|
review_count | integer |
過去 1 年間のショップ一覧のレビューの数。 |
|
レビューの平均
|
review_average | double |
過去 1 年間のショップ一覧のレビューに基づく平均評価。 |
ListingImage
特定の一覧に関連付けられている画像の参照 URL とメタデータ。 url_fullxfull パラメータには、フルサイズのバイナリ画像ファイルの URL が含まれます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
一覧 ID
|
listing_id | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
一覧画像 ID
|
listing_image_id | integer |
このトランザクションの主要な一覧画像の数値 ID。 |
|
16 進コード
|
hex_code | string |
画像の平均色の webhex 文字列 (webhex 表記)。 |
|
赤の値
|
red | integer |
0 から 255 (RGB 色) から、画像の平均の赤の値に等しい赤の数値。 |
|
緑の値
|
green | integer |
0 から 255 (RGB 色) から、画像の平均の赤の値に等しい赤の数値。 |
|
青の値
|
blue | integer |
0 から 255 (RGB 色) から、画像の平均の赤の値に等しい赤の数値。 |
|
色合いの値
|
hue | integer |
0 から 360 (HSV 色) から、画像の平均の色合いに等しい色合いの数値。 |
|
彩度の値
|
saturation | integer |
0 から 100 (HSV 色) から、画像の平均の彩度の値に等しい彩度の数値。 |
|
明るさの値
|
brightness | integer |
0 から 100 (HSV 色) から、画像の平均の明るさの値に等しい明るさの数値。 |
|
黒と白です
|
is_black_and_white | boolean |
true の場合、画像は白黒になりますです。 |
|
作成時刻
|
creation_tsz | integer |
一覧の画像の作成時間 (エポック秒単位)。 |
|
順位
|
rank | integer |
一覧に表示される画像のゼロ以外の正の数値の位置は、ランク 1 の画像と一緒に一覧の左端の位置に表示されます。 |
|
75x75 画像 URL
|
url_75x75 | string |
画像の 75x75 ピクセルのサムネイルの URL 文字列。 |
|
170x135 画像 URL
|
url_170x135 | string |
画像の 170x135 ピクセルのサムネイルの URL 文字列。 |
|
570xN 画像 URL
|
url_570xN | string |
画像のサムネイルの URL 文字列は、幅が 570 ピクセル以下で、高さが変数。 |
|
フルサイズ画像 URL
|
url_fullxfull | string |
フルサイズ画像の URL 文字列は、各分析コードで最大 3000 ピクセル。 |
|
フルサイズ画像の高さ
|
full_height | integer |
url_fullxfull で参照されるフルサイズの画像のピクセル単位で測定された数値の高さ。 |
|
フルサイズ画像の幅
|
full_width | integer |
url_fullxfull で参照されるフルサイズの画像のピクセル単位で測定された数値の幅。 |
ListingImages
一覧画像リソースの一覧を表します。各リソースには、画像の参照 URL とメタデータが含まれています。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of ListingImage |
要求されたリソースの一覧。 |
ListingInventoryWithAssociations
関連付けを使用した 1 つの一覧の在庫レコードの表現
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
製品
|
products | array of ListingInventoryProduct |
製品が 1 つしかない場合でも、一覧で使用可能な製品の JSON 配列。 JSON BLOB のすべてのフィールド名は小文字です。 |
|
プロパティの価格
|
price_on_property | array of integer |
製品の価格を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なるサイズの製品に特定の価格を請求する場合、この配列にはサイズのプロパティ ID が含まれます。 |
|
プロパティの数量
|
quantity_on_property | array of integer |
製品の数量を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の数量をストックする場合、この配列には色のプロパティ ID が含まれます。 |
|
プロパティの SKU
|
sku_on_property | array of integer |
製品の SKU を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の SKU を使用する場合、この配列には色のプロパティ ID が含まれます。 |
|
ShopListing
|
listing | ShopListing |
製品の数量、タイトル、説明、価格などを含むショップの一覧。 |
ListingInventoryProduct
一覧の製品の表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
製品 ID
|
product_id | integer |
一覧から購入した特定の製品の数値 ID。 |
|
SKU
|
sku | string |
製品の SKU 文字列 |
|
削除済みである
|
is_deleted | boolean |
true の場合、誰かがこの製品を削除しました。 |
|
オファリング
|
offerings | array of ListingInventoryProductOffering |
この製品の製品オファリング エントリの一覧。 |
|
プロパティ値
|
property_values | array of ListingPropertyValue |
この製品のプロパティ値エントリの一覧。 |
ListingInventoryProductOffering
一覧のオファリングの表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
オファリング ID
|
offering_id | integer |
製品オファリングの ID |
|
数量
|
quantity | integer |
製品オファリングの数量 |
|
有効である
|
is_enabled | boolean |
オファリングを購買担当者に表示できるかどうか。 |
|
削除済みである
|
is_deleted | boolean |
オファリングが削除されているかどうか。 |
|
Money
|
price | Money |
金額の表現。 |
ListingPropertyValue
構造化データ値の表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロパティ ID
|
property_id | integer |
プロパティの数値 ID。 |
|
名称
|
property_name | string |
プロパティの名前。 |
|
スケール ID
|
scale_id | integer |
スケールの数値 ID (存在する場合)。 |
|
スケール名
|
scale_name | string |
選択したスケール (存在する場合) を説明するために使用されるラベル。 |
|
値 ID
|
value_ids | array of integer |
プロパティ値の数値 ID |
|
値
|
values | array of string |
プロパティ値 |
ListingInventory
1 つの一覧の在庫レコードの表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
製品
|
products | array of ListingInventoryProduct |
製品が 1 つしかない場合でも、一覧で使用可能な製品の JSON 配列。 JSON BLOB のすべてのフィールド名は小文字です。 |
|
プロパティの価格
|
price_on_property | array of integer |
製品の価格を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なるサイズの製品に特定の価格を請求する場合、この配列にはサイズのプロパティ ID が含まれます。 |
|
プロパティの数量
|
quantity_on_property | array of integer |
製品の数量を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の数量をストックする場合、この配列には色のプロパティ ID が含まれます。 |
|
プロパティの SKU
|
sku_on_property | array of integer |
製品の SKU を変更するプロパティの一意の一覧プロパティ ID 整数の配列 (存在する場合)。 たとえば、同じ一覧内の異なる色の製品に特定の SKU を使用する場合、この配列には色のプロパティ ID が含まれます。 |
ShopListingsWithAssociations
関連付けのあるショップ一覧リソースのセット。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップ一覧リソースの数が見つかりました。 |
|
結果
|
results | array of ShopListing |
ショップ一覧リソースが見つかりました。 |
ListingPropertyValues
いくつかの一覧プロパティ値を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップ一覧リソースの数が見つかりました。 |
|
結果
|
results | array of ListingPropertyValue |
ショップ一覧リソースが見つかりました。 |
ShopReceiptTransactions
ショップ領収書トランザクション リソースのセット
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップ領収書トランザクション リソースの数が見つかりました。 |
|
結果
|
results | array of ShopReceiptTransaction |
ショップ領収書トランザクション リソースが見つかりました。 |
ShopReceiptTransaction
ショップの領収書に関連付けられたトランザクション オブジェクト。 Etsy は、発注書の受け取りに記録されているように、購入した一覧ごとに 1 つのトランザクションを生成します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
トランザクション ID
|
transaction_id | integer |
トランザクションの一意の数値 ID。 |
|
肩書き
|
title | string |
このトランザクションで購入した一覧のタイトル文字列。 |
|
内容
|
description | string |
このトランザクションで購入した一覧の説明文字列。 |
|
販売者ユーザー ID
|
seller_user_id | integer |
このトランザクションの販売者の数値ユーザー ID。 |
|
購入者ユーザー ID
|
buyer_user_id | integer |
このトランザクションの購入者の数値ユーザー ID。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
トランザクションの作成日時 (エポック秒単位)。 |
|
支払済みタイムスタンプ
|
paid_timestamp | integer |
トランザクションの支払済み日時 (エポック秒単位)。 |
|
発送済みタイムスタンプ
|
shipped_timestamp | integer |
トランザクションの発送日時 (エポック秒単位)。 |
|
数量
|
quantity | integer |
このトランザクションで購入された製品の数値数量。 |
|
一覧画像 ID
|
listing_image_id | integer |
このトランザクションの主要な一覧画像の数値 ID。 |
|
受領書 ID
|
receipt_id | integer |
このトランザクションに関連する領収書の数値 ID。 |
|
デジタルです
|
is_digital | boolean |
true の場合、トランザクションはデジタル一覧の購入を記録しました。 |
|
ファイル データ
|
file_data | string |
このトランザクションで購入したファイルを説明する文字列。 |
|
一覧 ID
|
listing_id | integer |
このトランザクションに関連する一覧の数値 ID。 |
|
トランザクションの種類
|
transaction_type | string |
トランザクションのタイプ文字列は、通常は一覧される |
|
製品 ID
|
product_id | integer |
一覧から購入した特定の製品の数値 ID。 |
|
Money
|
price | Money |
金額の表現。 |
|
Money
|
shipping_cost | Money |
金額の表現。 |
ListingTranslation
一覧の翻訳データを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
一覧 ID
|
listing_id | integer |
一覧の数値 ID。 |
|
言語
|
language | string |
この翻訳の言語の IETF 言語タグ (例: 「fr」)。 |
|
肩書き
|
title | string |
このトランザクションの一覧のタイトル。 |
|
内容
|
description | string |
このトランザクションの一覧の説明。 |
|
タグ
|
tags | array of string |
このトランザクションの一覧のタグ。 |
ListingVariationImages
いくつかの一覧バリエーション画像を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
バリエーション画像の数。 |
|
結果
|
results | array of ListingVariationImage |
バリエーション画像の結果。 |
ListingVariationImage
一覧のバリエーションと画像の関連付けの表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロパティ ID
|
property_id | integer |
プロパティの数値 ID。 |
|
値 ID
|
value_id | integer |
値の数値 ID。 |
|
画像 ID
|
image_id | integer |
画像の数値 ID。 |
PaymentAccountLedgerEntries
支払アカウント元帳エントリ リソースのセット
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
支払アカウント元帳エントリ リソースの数が見つかりました。 |
|
結果
|
results | array of PaymentAccountLedgerEntry |
支払アカウント元帳エントリ リソースの支払が見つかりました。 |
PaymentAccountLedgerEntry
ショップの元帳のエントリを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エントリ ID
|
entry_id | integer |
元帳エントリの数値 ID。 |
|
元帳 ID
|
ledger_id | integer |
元帳の数値 ID。 |
|
シーケンス番号
|
sequence_number | integer |
このシーケンスにより、元帳エントリを時系列で並べ替えることができます。 シーケンスが高いほど、エントリは最近のものになります。 |
|
量
|
amount | integer |
元帳に貸方転記された金額。 |
|
通貨
|
currency | string |
元帳のエントリの通貨。 |
|
内容
|
description | string |
これがどのような種類の元帳エントリかの詳細: 支払、払戻、失敗した払戻の取り消し、出金、返済された出金、回収、その他のクレジット、その他の借方、または請求書の支払。 |
|
残高
|
balance | integer |
このエントリが適用された直後のショップの元帳の金額。 |
|
作成日
|
create_date | integer |
エポック秒単位で作成された元帳エントリの日時。 |
Payments
Etsy 支払で行われたいくつかの支払いを表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
応答に含まれる支払の数です。 |
|
Results
|
results | array of Payment |
支払の一覧。 |
支払い
Etsy 支払で行われた支払いを表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Payment ID
|
payment_id | integer |
特定の Etsy ショップへの支払の一意の数値 ID。 |
|
購入者ユーザー ID
|
buyer_user_id | integer |
購入を支払ったユーザーの数値 ID。 |
|
ショップ ID
|
shop_id | integer |
Etsy ショップの一意の正のゼロ以外の数値 ID。 |
|
受領書 ID
|
receipt_id | integer |
このトランザクションに関連する領収書の数値 ID。 |
|
Money
|
amount_gross | Money |
金額の表現。 |
|
Money
|
amount_fees | Money |
金額の表現。 |
|
Money
|
amount_net | Money |
金額の表現。 |
|
Money
|
posted_gross | Money |
金額の表現。 |
|
Money
|
posted_fees | Money |
金額の表現。 |
|
Money
|
posted_net | Money |
金額の表現。 |
|
Money
|
adjusted_gross | Money |
金額の表現。 |
|
Money
|
adjusted_fees | Money |
金額の表現。 |
|
Money
|
adjusted_net | Money |
金額の表現。 |
|
通貨
|
currency | string |
支払の通貨の ISO (アルファベット) コード文字列。 |
|
ショップ通貨
|
shop_currency | string |
ショップの通貨の ISO (アルファベット) コード。 ショップでは、既定ですべての価格がこの通貨で表示されます。 |
|
購入者の通貨
|
buyer_currency | string |
購入者の通貨文字列。 |
|
ユーザー発送 ID
|
shipping_user_id | integer |
販売者が受注を発送するユーザーの数値 ID。 |
|
送付先住所 ID
|
shipping_address_id | integer |
発送先住所を識別する数値 ID。 |
|
請求先住所 ID
|
billing_address_id | integer |
購入者の請求先住所を識別する数値 ID。 |
|
Status
|
status | string |
支払の現在の状態を示す文字列は、最も一般的には決済または認証済みです。 |
|
発送済みタイムスタンプ
|
shipped_timestamp | integer |
トランザクションの発送日時 (エポック秒単位)。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
トランザクションの作成日時 (エポック秒単位)。 |
|
更新のタイムスタンプ
|
update_timestamp | integer |
エポック秒単位で、支払調整への最後の変更の日時。 |
|
支払の調整
|
payment_adjustments | array of PaymentAdjustment |
Etsy 支払トランザクションの返金オブジェクトの一覧。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。 |
PaymentAdjustment
前の Etsy 支払に適用される、払戻を表します。 特に指定がない限り、すべての金額は USD 1 セント硬貨です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
支払の調整 ID
|
payment_adjustment_id | integer |
支払の調整の数値 ID。 |
|
Payment ID
|
payment_id | integer |
特定の Etsy ショップへの支払の一意の数値 ID。 |
|
Status
|
status | string |
支払調整の状態文字列。 |
|
成功
|
is_success | boolean |
true の場合、支払い調整は正常に完了する可能性があります。 |
|
ユーザー ID
|
user_id | integer |
購入を実行するユーザー (販売者) の数値 ID。 |
|
理由コード
|
reason_code | string |
返金の理由を説明する人間が読み取り可能な文字列。 |
|
合計調整金額
|
total_adjustment_amount | integer |
支払通貨での返金の合計数値額。 |
|
ショップ合計調整金額
|
shop_total_adjustment_amount | integer |
ショップ通貨での返金の数値額。 |
|
合計調整金額
|
buyer_total_adjustment_amount | integer |
購入者通貨での返金の数値額。 |
|
合計手数料調整金額
|
total_fee_adjustment_amount | integer |
支払い調整に関連するカード処理手数料の数値額。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
トランザクションの作成日時 (エポック秒単位)。 |
|
更新のタイムスタンプ
|
update_timestamp | integer |
エポック秒単位で、支払調整への最後の変更の日時。 |
ポン
現在のアプリケーションが Open API にアクセスできることの確認
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アプリケーション ID
|
application_id | integer |
認証済みアプリケーションの ID |
ShopReceipt
ショップからの購入のレコード。 ショップの領収書には、ショップの通貨を使用して金銭の値が表示されます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受領書 ID
|
receipt_id | integer |
このトランザクションに関連する領収書の数値 ID。 |
|
受領書タイプ
|
receipt_type | integer |
購入にサービスを提供した Etsy チャネルの数値: Etsy.com の場合は 0、パターン ショップの場合は 1。 |
|
販売者ユーザー ID
|
seller_user_id | integer |
購入を実行するユーザー (販売者) の数値 ID。 |
|
送信者のメール アドレス
|
seller_email | string |
一覧の販売者のメール アドレス文字列。 |
|
購入者ユーザー ID
|
buyer_user_id | integer |
購入を作成するユーザーの数値 ID。 |
|
購入者のメール アドレス
|
buyer_email | string |
一覧の購入者のメール アドレス文字列。 |
|
名称
|
name | string |
発送先住所にある受取人の名前の文字列。 |
|
住所の 1 行目
|
first_line | string |
発送先住所にある受取人の住所の 1 行目文字列。 |
|
住所の 2 行目
|
second_line | string |
発送先住所にある受取人のオプションの住所の 2 行目文字列。 |
|
市
|
city | string |
発送先住所にある受取人の市の文字列。 |
|
州
|
state | string |
発送先住所にある受取人の州の文字列。 |
|
郵便番号
|
zip | string |
発送先住所の受取人の郵便番号文字列 (必ずしも番号である必要はありません)。 |
|
書式設定された住所
|
formatted_address | string |
発送先住所にある受取人の住所の書式設定された住所の文字列。 |
|
国 コード ISO
|
country_iso | string |
発送先住所にある受取人の住所の ISO-3166 alpha-2 国コードの文字列。 |
|
支払方法
|
payment_method | string |
購入者の支払方法を識別する支払方法の文字列は、次のいずれか: 「cc」 (クレジット カード)、「paypal」、「チェック」、「mo」 (金額オーダー)、「bt」 (銀行振替)、「その他」、「理想」、「sofort」、「apple_pay」、「Google」、「android_pay」、「google_pay」、「klarna」、「k_pay_in_4」 (klarna)、または「k_financing」 (klarna)。 |
|
支払のメール アドレス
|
payment_email | string |
支払確認の送信先のメール アドレスのメール アドレス文字列 |
|
販売者からのメッセージ
|
message_from_seller | string |
販売者からのオプションのメッセージ文字列。 |
|
購入者からのメッセージ
|
message_from_buyer | string |
購入者からのオプションのメッセージ文字列。 |
|
支払システムからのメッセージ
|
message_from_payment | string |
支払システムからの機械が生成した確認文字列。 |
|
支払済みかどうか
|
is_paid | boolean |
true の場合、購入者はこの購入に対して支払いをしました。 |
|
発送された
|
is_shipped | boolean |
true の場合、販売者は製品を発送しました。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
領収書の作成時間 (エポック秒単位)。 |
|
更新のタイムスタンプ
|
update_timestamp | integer |
領収書の最後の更新時刻 (エポック秒単位)。 |
|
ギフト メッセージ
|
gift_message | string |
購入者が商品と一緒に配送するように要求するギフト メッセージ文字列。 |
|
Money
|
grandtotal | Money |
金額の表現。 |
|
Money
|
subtotal | Money |
金額の表現。 |
|
Money
|
total_price | Money |
金額の表現。 |
|
Money
|
total_shipping_cost | Money |
金額の表現。 |
|
Money
|
total_tax_cost | Money |
金額の表現。 |
|
Money
|
total_vat_cost | Money |
金額の表現。 |
|
Money
|
discount_amt | Money |
金額の表現。 |
|
Money
|
gift_wrap_price | Money |
金額の表現。 |
|
出荷
|
shipments | array of ShopReceiptShipment |
この領収書の発送明細書の一覧。 |
ShopReceiptShipment
ShopReceipt の 1 つの発送イベントの記録。 領収書には多くの ShopReceiptShipment レコードが含まれている場合があります。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受領書発送 ID
|
receipt_shipping_id | integer |
ショップ領収書発送レコードの一意の数値 ID。 |
|
発送通知のタイムスタンプ
|
shipment_notification_timestamp | integer |
Etsy が購入者に発送イベントを通知した時刻 (エポック秒単位)。 |
|
配送業者名
|
carrier_name | string |
発送の配送責任の配送業者/会社の名前文字列。 |
|
追跡コード
|
tracking_code | string |
発送の配送業者/会社から提供された追跡コード文字列。 |
ShopReceipts
特定のショップの領収書。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップ領収書の数が見つかりました。 |
|
結果
|
results | array of ShopReceipt |
ショップ領収書リソースの一覧が、各リソースのショップ領収書フィールドと一緒に見つかりました。 |
TransactionReviews
ユーザーが残したトランザクション レビュー レコードのセット。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
TransactionReview リソースの数が見つかりました。 |
|
結果
|
results | array of TransactionReview |
TransactionReview リソースが見つかりました。 |
TransactionReview
ユーザーが残したトランザクション レビュー レコード。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ショップ ID
|
shop_id | integer |
ショップの数値 ID。 |
|
一覧 ID
|
listing_id | integer |
TransactionReview が属するショップ一覧の ID。 |
|
購入者ユーザー ID
|
buyer_user_id | integer |
このトランザクションで購入者だったユーザーの数値 ID。 注: 購入者のプライバシー設定によっては、このフィールドが表示されない場合があります。 |
|
Rating
|
rating | integer |
1 から 5 までのスケールでの評価値 |
|
レビュー メッセージ
|
review | string |
フィードバックを説明する、作成者が残したメッセージ。 |
|
言語
|
language | string |
TransactionReview の言語 |
|
フルサイズ画像 URL
|
image_url_fullxfull | string |
フィードバックとともに提供された写真への URL、完全なディメンション。 注: 購入者のプライバシー設定によっては、このフィールドが表示されない場合があります。 |
|
作成タイムスタンプ
|
create_timestamp | integer |
エポック秒単位で作成された TransactionReview の日時。 |
|
更新のタイムスタンプ
|
update_timestamp | integer |
エポック秒単位で更新された TransactionReview の日時。 |
SellerTaxonomyNodes
販売者の分類ツリーから分類ノードの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of SellerTaxonomyNode |
要求されたリソースの一覧。 |
SellerTaxonomyNode
販売者の分類ツリーの分類ノード。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
Etsy 分類ノードの ID を表す一意の数値。これは販売担当者の分類階層ツリーにまとめた目録のメタデータ カテゴリです。 たとえば、靴の分類ノード (ID: 1429、レベル: 1) は、女の子の靴 (ID: 1440、レベル: 2) よりも階層の上位にあります。 一覧に割り当てられた分類ノードは、特定の標準化された製品スケールおよびプロパティへのアクセスをサポートします。 たとえば、分類ノードの靴または女の子の靴が割り当てられた一覧は、関連するプロパティ名とプロパティ |
|
レベル
|
level | integer |
販売者分類ツリー内のこの分類ノードの整数の深さは、レベル 0 のルートと一緒です。 |
|
名称
|
name | string |
この分類ノードの名前文字列。 |
|
親 ID
|
parent_id | integer |
このノードの親の数値分類 ID。 |
|
子
|
children | array of SellerTaxonomyNode |
販売者分類ツリー内のこの分類ノードのすべての直接の子の分類ノードの配列。 |
|
分類パス ID
|
full_path_taxonomy_ids | array of integer |
このノードと、ルート ノードまでの販売者分類ツリー内のすべての直接の親を含む分類 ID の配列。 それらはルートから葉の順序に一覧されています。 |
TaxonomyNodeProperties
製品プロパティ定義の一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of TaxonomyNodeProperty |
要求されたリソースの一覧。 |
TaxonomyNodeProperty
製品プロパティ定義。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロパティ ID
|
property_id | integer |
この製品プロパティの一意の数値 ID。 |
|
名称
|
name | string |
この分類ノードの名前文字列。 |
|
表示名
|
display_name | string |
人間が読み取り可能な製品プロパティ名文字列。 |
|
スケール
|
scales | array of TaxonomyPropertyScale |
使用可能なスケールの一覧。 |
|
必要に応じて
|
is_required | boolean |
true の場合、適格な分類 ID が割り当てられた一覧にはこのプロパティが必要です。 |
|
属性のサポート
|
supports_attributes | boolean |
true の場合、属性の一覧でこのプロパティを使用できます。 |
|
バリエーションをサポートする
|
supports_variations | boolean |
true の場合、バリエーションの一覧でこのプロパティを使用できます。 |
|
複数の値です
|
is_multivalued | boolean |
true の場合、このプロパティに複数のプロパティ値を割り当てることができる |
|
指定できる値
|
possible_values | array of TaxonomyPropertyValue |
このプロパティのサポートされた値の文字列の一覧。 |
|
選択された値
|
selected_values | array of TaxonomyPropertyValue |
指定されたプロパティに対して自動的かつ常に選択されるプロパティ値文字列の一覧。 |
TaxonomyPropertyScale
特定の製品プロパティで使用可能なプロパティ値に割り当て可能な増加を定義するスケール。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
スケール ID
|
scale_id | integer |
スケールの一意の数値 ID。 |
|
表示名
|
display_name | string |
スケールの名前文字列。 |
|
内容
|
description | string |
スケールの説明文字列。 |
TaxonomyPropertyValue
特定のスケールを使用する場合もある、特定の製品プロパティのプロパティ値。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
値 ID
|
value_id | integer |
このプロパティ値の数値 ID。 |
|
名称
|
name | string |
このプロパティ値の名前文字列。 |
|
スケール ID
|
scale_id | integer |
このプロパティ値が属するスケールの数値スケール ID。 |
|
と等しい
|
equal_to | array of integer |
このプロパティ値が等しい数値プロパティ値 ID の一覧 (存在する場合)。 |
ShippingCarriers
いくつかの ShippingCarriers を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer | |
|
結果
|
results | array of ShippingCarrier |
ShippingCarrier
配送予定日を計算するために使用される、サポートされている配送業者。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
運送業者 ID
|
shipping_carrier_id | integer |
この配送業者の数値 ID。 |
|
名称
|
name | string |
この配送業者の名前。 |
|
国内クラス
|
domestic_classes | array of ShippingCarrierMailClass |
この配送業者の国内メール クラスのセット。 |
|
国際クラス
|
international_classes | array of ShippingCarrierMailClass |
この配送業者の国際メール クラスのセット。 |
ShippingCarrierMailClass
配送予定日を計算するために使用される、配送業者のメール クラス。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール クラス ID
|
mail_class_key | string |
このメール クラスの一意識別子。 |
|
名称
|
name | string |
このメール クラスの名前。 |
ショップ
ショップ レコードのセット。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
ショップの合計数 |
|
結果
|
results | array of Shop |
ショップ リソース。 |
ShopSection
ユーザーが一覧を並べ替えることができるショップ内のセクション。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ショップ セクション ID
|
shop_section_id | integer |
特定の Etsy ショップのセクションの数値 ID。 |
|
肩書き
|
title | string |
ショップ セクションのタイトル文字列。 |
|
Rank
|
rank | integer |
ショップのセクション表示順序におけるこのセクションの正のゼロ以外の数値位置は、ランク 1 のセクションと最初に表示されます。 |
|
ユーザー ID
|
user_id | integer |
このショップ セクションを所有するユーザーの数値 ID。 |
|
アクティブな一覧数
|
active_listing_count | integer |
特定の Etsy ショップの 1 つのセクションにあるアクティブな一覧の数。 |
ShopSections
特定のショップのすべてのセクション。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of ShopSection |
要求されたリソースの一覧。 |
ShopShippingProfile
一覧の発送情報を設定するために使用されるプロファイルを表します。 API を介して計算された発送テンプレートを作成することはできないことに注意してください。 ただし、API を使用して、ショップ マネージャーから作成された計算された発送プロファイルを関連付けることができます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
発送プロファイル ID
|
shipping_profile_id | integer |
発送プロファイルの数値 ID。 |
|
肩書き
|
title | string |
この配送プロファイルの名前文字列。 |
|
ユーザー ID
|
user_id | integer |
発送プロファイスを所有するユーザーの数値 ID。 |
|
最小処理日数
|
min_processing_days | integer |
一覧を処理するための最小日数。 |
|
最大処理日数
|
max_processing_days | integer |
一覧を処理するための最大日数。 |
|
処理日ラベル
|
processing_days_display_label | string |
処理日の翻訳された表示ラベル文字列。 |
|
発送元の国 ISO
|
origin_country_iso | string |
一覧の発送元の国の ISO コード。 |
|
削除済みである
|
is_deleted | boolean |
true の場合、誰かがこの発送プロファイルを削除しました。 |
|
発送プロファイル宛先
|
shipping_profile_destinations | array of ShopShippingProfileDestination |
この発送プロファイルで使用可能な発送プロファイルの宛先の一覧。 |
|
発送プロファイル アップグレード
|
shipping_profile_upgrades | array of ShopShippingProfileUpgrade |
この発送プロファイルで使用可能な発送プロファイル アップグレードの一覧。 |
|
発送元郵便番号
|
origin_postal_code | string |
一覧の発送元の郵便番号文字列 (必ずしも番号である必要はありません)。 |
|
ProfileType
|
profile_type | ProfileType |
ShopShippingProfileDestination
発送プロファイルに割り当てられた発送先を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
発送プロファイル宛先 ID
|
shipping_profile_destination_id | integer |
一覧に関連付けられた発送プロファイルの発送プロファイル宛先の数値 ID。 |
|
発送プロファイル ID
|
shipping_profile_id | integer |
発送プロファイルの数値 ID。 |
|
発送元の国 ISO
|
origin_country_iso | string |
一覧の発送元の国の ISO コード。 |
|
配送先の国 ISO
|
destination_country_iso | string |
一覧の発送先の国の ISO コード。 null 値の場合、要求は宛先を destination_region に設定 |
|
DestinationRegion
|
destination_region | DestinationRegion |
一覧の発送先の地域のコード。 地域は一連の国を表します。 サポートされている地域は、欧州連合と非欧州連合 (EU 以外のヨーロッパの国) です。 ない場合、要求は宛先を destination_country_iso に設定するか、destination_country_iso も null 値の場合はどこにでも設定する |
|
Money
|
primary_cost | Money |
金額の表現。 |
|
Money
|
secondary_cost | Money |
金額の表現。 |
|
運送業者 ID
|
shipping_carrier_id | integer |
配送予定日を計算するために使用される、サポートされている配送業者の一意の ID。 |
|
メール クラス
|
mail_class | string |
配送予定日を計算するために使用される、配送業者のメール クラスの一意の ID 文字列。 |
|
最小配送日数
|
min_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最小営業日数。 |
|
最大配送日数
|
max_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最大営業日数。 |
ShopShippingProfileUpgrade
発送プロファイル アップグレード オプションの表現。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
発送プロファイル ID
|
shipping_profile_id | integer |
基本発送プロファイルの数値 ID。 |
|
アップグレード ID
|
upgrade_id | integer |
発送アップグレードに関連付けられている数値 ID |
|
アップグレード名
|
upgrade_name | string |
チェックアウト時に買い物客に表示される発送アップグレードの名前 (例: USPS 優先度など)。 |
|
タイプ
|
type | Type |
発送アップグレードのタイプ。 国内 (0) または国際 (1)。 |
|
順位
|
rank | integer |
一覧に表示される画像のゼロ以外の正の数値の位置は、ランク 1 の画像と一緒に一覧の左端の位置に表示されます。 |
|
言語
|
language | string |
発送プロファイルの言語の IETF 言語タグ。 例: de、en、es、fr、it、ja、nl、pl、pt、ru。 |
|
Money
|
price | Money |
金額の表現。 |
|
Money
|
secondary_price | Money |
金額の表現。 |
|
運送業者 ID
|
shipping_carrier_id | integer |
配送予定日を計算するために使用される、サポートされている配送業者の一意の ID。 |
|
メール クラス
|
mail_class | string |
配送予定日を計算するために使用される、配送業者のメール クラスの一意の ID 文字列。 |
|
最小配送日数
|
min_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最小営業日数。 |
|
最大配送日数
|
max_delivery_days | integer |
発送された購入品目を購入者が受け取るのを待つことができる最大営業日数。 |
ShopShippingProfileDestinations
発送先オブジェクトの一覧を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of ShopShippingProfileDestination |
要求されたリソースの一覧。 |
ShopShippingProfileUpgrades
発送アップグレード オプションの一覧。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
結果の件数。 |
|
結果
|
results | array of ShopShippingProfileUpgrade |
要求されたリソースの一覧。 |
UserAddress
ユーザーの住所を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー住所 ID
|
user_address_id | integer |
ユーザーの住所の数値 ID。 |
|
ユーザー ID
|
user_id | integer |
ユーザーの数値 ID。 |
|
名称
|
name | string |
このアドレスのユーザー名。 |
|
住所の 1 行目
|
first_line | string |
ユーザーの住所の 1 行目。 |
|
住所の 2 行目
|
second_line | string |
ユーザーの住所の 2 行目。 |
|
市
|
city | string |
ユーザーの住所の市フィールド。 |
|
州
|
state | string |
ユーザーの住所の州フィールド。 |
|
郵便番号
|
zip | string |
ユーザーの住所の郵便番号フィールド。 |
|
国 コード ISO
|
iso_country_code | string |
この住所にある国の ISO コード。 |
|
国
|
country_name | string |
ユーザーの国の名前。 |
|
既定の配送先住所です
|
is_default_shipping_address | boolean |
これはユーザーの既定の発送先住所ですか。 |
UserAddresses
いくつかの UserAddress レコードを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
返される UserAddress レコードの数。 |
|
結果
|
results | array of UserAddress |
UserAddress リソースの配列。 |
DestinationRegion
一覧の発送先の地域のコード。 地域は一連の国を表します。 サポートされている地域は、欧州連合と非欧州連合 (EU 以外のヨーロッパの国) です。 ない場合、要求は宛先を destination_country_iso に設定するか、destination_country_iso も null 値の場合はどこにでも設定する
一覧の発送先の地域のコード。 地域は一連の国を表します。 サポートされている地域は、欧州連合と非欧州連合 (EU 以外のヨーロッパの国) です。 ない場合、要求は宛先を destination_country_iso に設定するか、destination_country_iso も null 値の場合はどこにでも設定する
- DestinationRegion
- string
ItemDimensionsUnit
製品のディメンションを測定するために使用される単位を定義する文字列。 既定値は null 値です。
製品のディメンションを測定するために使用される単位を定義する文字列。 既定値は null 値です。
- ItemDimensionsUnit
- string
ItemWeightUnit
製品の重量を測定するために使用される単位を定義する文字列。 既定値は null 値です。
製品の重量を測定するために使用される単位を定義する文字列。 既定値は null 値です。
- ItemWeightUnit
- string
機会
ProfileType
- ProfileType
- string
受信者
州
アクティブまたは非アクティブのいずれかから列挙された文字列。 注: 下書き一覧をアクティブに設定すると、リスト一覧は etsy.com にも公開されます。
アクティブまたは非アクティブのいずれかから列挙された文字列。 注: 下書き一覧をアクティブに設定すると、リスト一覧は etsy.com にも公開されます。
- 州
- integer
タイプ
WhenMade
作成者がこの一覧の製品を作成した時代の列挙文字列。 購入者がビンテージの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「who_made」が必要です。
作成者がこの一覧の製品を作成した時代の列挙文字列。 購入者がビンテージの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「who_made」が必要です。
- WhenMade
- string
WhoMade
製品を作った人を示す列挙文字列。 購入者が手作りの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「when_made」が必要です。
製品を作った人を示す列挙文字列。 購入者が手作りの見出しの下の一覧を検索するのに役立ちます。 「is_supply」と「when_made」が必要です。
- WhoMade
- string