認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/reseller/currencies \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Every currency we can charge in, with `offered` saying whether your clients may be quoted in it. `offers_all: true` means you have made no choice and your clients get the full set — which is the state every programme starts in. `sell_in_currency` is what **you** are priced and settled in, which is a different question from what your customers browse in, and it is served only here and never to your clients. `switcher: false` removes the currency control from their panel entirely, so every one of your clients is quoted in `default_currency`. Requires `reseller.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
currencies | ResellerCurrency[] | はい | — |
offers_all | boolean | はい | You have made no choice, so your clients get every currency. |
offered_count | integer | はい | — |
total_count | integer | はい | — |
default_currency | string | はい | What a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD. |
sell_in_currency | string | はい | What **you** are priced and settled in, resolved — never empty, and never disclosed to your clients. |
switcher | boolean | はい | Whether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429