注文

権限: orders:read。

GET /api/v1/orders

パラメータ: offset、limit、family、status、client_reference (完全一致)。

family または status の不明な値は「フィルターなし」として扱われます。並び順は固定で 変更できません: 新しい順です。

フィールド	意味
product, kind, family	購入したもの。kind: resident または ipv4
quantity	購入した単位の数: ipv4 ではアドレスの数。トラフィックの注文では常に 1 - 購入したのは 1 つのパッケージで、容量は packages[].traffic.purchased_gb にあります
price_per_proxy, total	単価 (total / quantity) と注文金額。トラフィックの注文では等しい
status	下記参照
applied_to_package_id	値がある場合、注文は既存のパッケージに適用されています: トラフィックの追加またはアドレスの延長
client_reference	購入の本文で指定した独自ラベル
packages	注文で発行されたトラフィックパッケージ。容量の追加と固定アドレスの注文では空です - それらのパッケージは GET /api/v1/packages?family=dedicated で取得してください。詳細に order_id があります

GET /api/v1/orders/{id}

形式は一覧と同じです。別のアカウントの注文には、code キーなしの 404 が返ります。

発行ステータス

購入はリクエスト内で完了するため、POST /api/v1/packages のレスポンスでは注文はすでに completed です。その他のステータスは注文を取得したときに現れます。

ステータス	対応
pending, provisioning	5-10 秒ごとにポーリングする
completed	完了: トラフィックパッケージは packages[0]、アドレスのパッケージは購入レスポンスの package_id
failed	引き落とされていない、または返金済み。再試行できる
refunded	サポートの判断で返金済み。新しい購入としてやり直す
needs_attention	引き落とし済み、手動で調査中。再購入しないこと、サポートに連絡する

注文をポーリングする代わりに、イベントログ を読むこともできます。