以下はAPIを介した注文データの同期で説明された、標準的な同期リクエストで可能なプロパティの概要です。
リクエストアイテム
| プロパティ | 説明 | 必須/任意 | 例 |
|---|---|---|---|
gtin | 注文内の商品を特定するためのコードです。 | 必須 | 9891998566P |
id | これは、小売業者のシステムにおける注文の識別子です。 提供されない場合、CitrusAdは識別子を生成します。 | 任意 | 3h30e938-c158-4d78-a0af-b48bbwfrcss4 |
orderDate | 注文した日付または日時です。これはISO-8601規格の形式で、正確かつ完全なタイムスタンプでなければなりません。例：2019-03-14T15:06:17+10:00 UTC時間で記載するか、上記の例に従ってタイムゾーンに応じて調整する必要があります。 | 必須 | 2021-12-02T15:00:00Z |
catalogId | 注文を同期しているカタログID。API経由で同期中のマルチ小売業者の場合に便利。 ファイル同期には非適用。 | 任意 | 6adb93d0-7he4-4d4e-9b47-e5d3714c976a |
orderItems | 注文にて送信されたすべてのアイテムの配列です。 | 必須 | [ { "gtin": "9891998566P", "quantity": 3, "regularUnitPrice": "1.00", "totalOrderItemPriceAfterDiscounts": "3.00" } ] |
quantity | 注文された商品の数量 | 必須 | 3 |
regularUnitPrice | 注文の商品の通常単価です。 | 任意 | 2.99 |
sessionId | ユーザーのセッションを識別するために生成されたIDで、コントロールが可能です。CitrusAdはこれを購入のアトリビューションに使用できます。 | 標準的な統合に必要 | 5cat7-9964-4f |
totalOrderItemPriceAfterDiscounts | 割引を適用した商品の合計金額です。例えば、注文の数量が3つで、価格が2.00の場合、合計金額は次の値になります： 6.00. | 任意 | 5.98 |
sellerId | 出品者の一意のID。マーケットプレイス出品者のオンボーディングの場合のみ必要です。マーケットプレイス以外の商品については空白のままにすることができます。 seller_idの統合については他にも要件があります。詳細については、 マーケットプレイス出品者IDをご覧ください。 | 任意 | 73nns-32sxr-32ss 統合ごとのカスタム |