DOCS

カタログAPI

自社システムから直接、プログラムで検証済みアカウントのカタログを構築できます。

カタログAPIは、検証済みアカウントのカタログを構築する3つの方法のうちの1つで、開発リソースがあり、商品データをすでに保持しているシステム(ERP、WMS、PIM、または配送プラットフォーム)をお持ちの荷送人向けの選択肢です。そのシステムが信頼できる情報源として維持され、チャネル連携から同期したりCSVファイルをアップロードしたりする代わりに、商品を直接Zonosに書き込みます。対応チャネルで販売している場合や、コードを書きたくない場合は、これら2つの方法でより少ない手間で同じカタログを構築できます。

API経由で作成されたアイテムは、他のソースから追加されたアイテムとまったく同じように扱われます。カタログに登録されたアイテムは、どのように追加されたかに関係なく同じです。HSコードを指定しなかった場合は各アイテムが通関用に分類され、米国パートナー政府機関(PGA)の要件についてスクリーニングされ、そのアイテムを含む発送品の関税と税金の計算に使用されます。

ただし、その一部はAPIの対象外です。PGAスクリーニングでアイテムに対応が必要のフラグが付いた場合、そのフラグに関連するコンプライアンス質問票はDashboardで回答・確認する必要があります。これに対応するAPIはありませんが、Zonosが可能な範囲で事前入力するため、作業の大部分は確認と承認になります。この連携を構築する担当者と、フラグを解消する担当者は通常異なるため、カタログの読み込み後に組織内の誰かがDashboardでフラグに対応するよう計画してください。フラグが付いたアイテムの発送はブロックされませんが、発送前にフラグを解消しておくことで、発送品が米国の国境で保留されるのを防げます。

仕組み 

  1. 発送する商品ごとにカタログアイテムを作成します。

  2. 各アイテムに、郵便キャリアが引き継ぐ識別子が含まれていることを確認します。

  3. 発送データがZonosに届くと、各行がカタログアイテムと照合され、そのアイテムの商品データが計算に適用されます。

カタログアイテムを作成する 

catalogItemCreateはリストを受け付けるため、1回のリクエストで多数の商品を送信できます。

1mutation CatalogItemCreate($input: [CatalogItemInput!]!) {
2 catalogItemCreate(input: $input) {
3 id
4 itemKey
5 name
6 productId
7 sku
8 hsCode
9 customsDescription
10 countryOfOrigin
11 }
12}

同じ商品を2回送信する場合

SKUまたは商品IDがすでに存在する商品を送信すると、Zonosは2つ目の商品を追加するのではなく、その商品を更新します。再試行や繰り返し実行しても問題ありません。

その反面、SKUまたは商品IDが同じ異なる2つの商品は1つに統合されます。一括読み込みの前に、データに重複がないか確認してください。

フィールド

フィールド↕必須↕説明↕
skuはい*商品の一意の識別子です。*各商品にはSKUまたは商品ID、あるいはその両方が必要です。
productIdはい*プラットフォーム上の商品の識別子です。*各商品にはSKUまたは商品ID、あるいはその両方が必要です。
nameはい商品名です。
customsDescription推奨税関申告用に、商品が何であるかをわかりやすく記載したものです。「Summer Vibes Tee」ではなく「綿のTシャツ」のように記載してください。
countryOfOrigin推奨商品が製造された国の2文字のISOコードです。関税を正確に計算するために必要です。
measurements推奨重量と寸法です。料金算出と税関申告に使用されます。
hsCodeいいえ国際共通の6桁のHSコードです。省略した場合、Zonosが商品名と説明から商品を分類します。
amountいいえ商品価格(数値)です。
currencyCodeいいえ価格の通貨を表す3文字のISOコードです。amountを指定する場合は必須です。
itemTypeいいえPHYSICAL_GOOD、DIGITAL_GOOD、SERVICE、SUBSCRIPTION、BUNDLE、またはPARTIAL_ITEMです。物理的でないアイテムが商品として申告されるのを防ぎます。
provinceOfOriginいいえ商品の原産地の州または県です。一部の仕向国で必要です。
productCompositionいいえ{material, percentage}のリストです。これがないと、繊維製品は6桁を超えて分類できません。
catalogItemUrlいいえ自社サイト上の商品ページへのリンクです。分類の精度が向上します。
imageUrlいいえ商品画像の公開アクセス可能なURLです。分類の精度が向上します。

アイテムを照合可能にする 

Zonosは、お客様の識別子を使用して、各発送行をカタログアイテムに関連付けます。照合の順序は、商品ID、次にSKU、最後に名前です。使用する識別子は、カタログとキャリアに送信するデータの間で正確かつ一貫した状態に保ってください。

郵便発送にはさらに制約があります。Zonosが郵便キャリアから受け取るフィールドは限られており、多くのレーンでは、商品固有の情報を含んで届くフィールドは税関申告用の説明のみです。カタログ全体で同一の説明では、それだけで何かを識別することはできません。

キャリアに送信する税関申告用の説明に、商品IDまたはSKUを追加してください。

Men's bifold wallet, cowhide leather - 123456

追加する識別子は、対応するカタログアイテムのproductIdまたはskuと完全に一致する必要があります。

説明フィールドは短く制限されています。たとえばCanada Postへの提出では約49文字までしか使用できないため、識別子が長い場合は説明部分を短くしてください。説明文よりも識別子のほうが重要です。

アイテムのcustomsDescriptionをキャリアに送信する文字列と同じにすることは必須ではありませんが、同じにしておくと、行が一致せず原因を調べる必要がある場合に、両者を直接比較できます。

照合が失敗する主なケースは次のとおりです。

  • 説明に識別子が含まれていない。
  • 識別子がカタログ内のどのproductIdまたはskuにも対応していない。
  • キャリアの文字数制限によって識別子が切り捨てられている。
  • 発送ごとに書式が変わっている。

この動作はまだ最終決定されておらず、リリース前に変更される可能性があります。

カタログアイテムを更新する 

catalogItemUpdateは、作成時と同じ入力型を受け取ります。変更したいフィールドのみを送信してください。

1mutation CatalogItemUpdate($input: [CatalogItemInput!]!) {
2 catalogItemUpdate(input: $input) {
3 id
4 itemKey
5 hsCode
6 customsDescription
7 }
8}

注: 省略したフィールドは変更されないため、部分的な更新を安全に行えます。nullを送信しても値はクリアされず、無視されます。値を別の値で上書きすることはできますが、APIで値を空にすることはできません。フィールドをクリアする必要がある場合は、Zonosの担当者にお問い合わせください。

アイテムを読み取る 

catalogItemクエリは、id、productId、またはskuを受け付けます。Zonosが商品について保持している情報を確認する際に使用してください。

1query CatalogItem($sku: String!) {
2 catalogItem(sku: $sku) {
3 id
4 itemKey
5 name
6 customsDescription
7 hsCode
8 productId
9 sku
10 countryOfOrigin
11 }
12}

カタログアイテムを削除する 

catalogItemDeleteは、お客様のSKUや商品IDではなく、ZonosのカタログアイテムIDを受け取ります。まずcatalogItemクエリでIDを確認してください。

1mutation CatalogItemDelete($input: [ID!]!) {
2 catalogItemDelete(input: $input)
3}

関連情報 

  • チャネル連携 — サポートされている販売チャネルからカタログを自動的に同期します。
  • CSVインポート — コードを書く代わりに、スプレッドシートでカタログアイテムをアップロードします。
  • PGAチェック — カタログアイテムを米国政府機関(PGA)の要件に照らしてスクリーニングします。
  • カタログの仕組み — Zonosがお客様の商品データをどのように使用するかを説明します。
GraphQL API ReferenceTypes, inputs, and operations used in this guide

このページは役に立ちましたか?


このページでは: