メインコンテンツへスキップ
POST
/
endpoint
注文のインポート
curl --request POST \
  --url https://api.example.com/endpoint
このエンドポイントを使用すると、トランザクション注文のリストを Kameleoon アカウントにインポートできます。データベースにすでに存在する注文とそのプロパティを更新するためにもこのエンドポイントを使用できます。データは JSON 文字列としてリクエスト本文に含めて送信する必要があります。

​
HTTP リクエスト

POST https://api.products.kameleoon.com/sync/orders

​
クエリパラメーターのリスト

パラメーター型必須説明
shop_idStringTrueストアキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。
shop_secretStringTrueシークレットキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。
ordersArrayTrue注文のリスト。orders に必要なパラメーターはこの表を参照してください。

​
orders オブジェクトのパラメーターリスト

パラメーター型必須説明
idStringTrue注文 ID
external_idStringTrueシステムまたは CRM 内でユーザーに関連付けられた一意の識別子。(Kameleoon の VisitorCode との正確なマッチングを確保するには、ID を最初に Kameleoon カスタムデータとして保存する必要があります。このカスタムデータを設定する際は、Use this custom data as a unique identifier for cross-device matching オプションを必ず有効にして、ID が両システム間でユーザーアクティビティをリンクするために使用されるようにしてください。)
statusStringTrue注文ステータス(例: Processing、Out for delivery、Delivered)
channelStringTrue注文に使用された媒体(例: Website、App、In-store)
dateIntegerTrue注文が発注または更新された Unix タイムスタンプ(秒)
offlineBooleanFalse注文をオフラインとしてフラグします。デフォルトは false です
location_idStringTrueユーザーの所在地(都市)ID
promocodeStringFalse注文で使用されたプロモコード
delivery_typeStringFalse配送タイプ(例: Courier、Pickup in-store)
delivery_addressStringFalseCRM の配送先住所
delivery_dateDateFalse配送予定日。形式: “YYYY-MM-DD”
delivery_timeTimeFalse配送予定時間。形式: “HH:MM”
payment_typeStringFalse支払い方法(例: Cash、Card、Wire)
tax_freeBooleanFalseアイテムが免税かどうかを示します
bank_issuerStringFalse銀行発行者
bank_pos_processorStringFalse支払い時に使用された POS システム/端末を示します
bank_loyalty_programStringFalse銀行ロイヤリティプログラム
bank_total_installmentIntegerFalse銀行を通じて支払う必要のある合計分割回数
payment_card_providerStringFalse決済カードのプロバイダー
gift_packageBooleanFalseアイテムがギフトパッケージで提供されるかどうかを示します
valueObjectTrue注文の総額。value に必要なパラメーターはこの表を参照してください。
payment_structureObjectTrue支払いの内訳(例: 現金支払い、割引、配送料)。payment_structure に必要なパラメーターはこの表を参照してください。
itemsObjectTrue注文に含まれるすべてのもの。items に必要なパラメーターはこの表を参照してください。

​
value オブジェクトのパラメーターリスト

パラメーター型必須説明
TotalNumericTrue注文の合計

​
payment_structure オブジェクトのパラメーターリスト

パラメーター型必須説明
cashNumericFalse注文合計のうち、現金で支払われた割合を示します
bonusesNumericFalse注文合計のうち、ボーナスで支払われた割合を示します
deliveryNumericFalse注文の配送コストを示します
discountNumericFalse注文の値引き額を示します
value.total == payment_structure.cash + payment_structure.bonuses + payment_structure.delivery - payment_structure.discount となるようにしてください。

​
items オブジェクトのパラメーターリスト

パラメーター型必須説明
idStringTrue購入された商品の ID
priceNumericTrue商品 1 個あたりの価格
quantityIntegerTrue選択された商品の合計数量
statusStringTrueアイテムのステータス。次のいずれかのみ可: created、invoiced、shipped、delivered、cancelled、refunded
original_priceNumericFalse商品の元の価格
discount_productNumericFalse商品の値引き価格
discount_bonusesNumericFalse商品の値引きボーナス
delivery_companyStringFalseアイテムを配送した郵便サービス
barcodeStringFalse商品のバーコード
line_idStringFalseストアの注文システムにおけるこの商品の位置(ライン項目)の一意の ID。
cancel_reasonStringFalseキャンセル理由
items オブジェクトは注文を作成する際に必須です。注文のステータスを更新する際には、空の配列として送信できます。

​
JSON リクエスト例


{
  "shop_id": "DvLWN2ZTMZ",
  "shop_secret": "EIxTuot8sj",
  "orders": [
    {
      "id": "yKsvZbWpCL",
      "external_id":"jhfakfkadak",
      "status": "Processing",
      "channel": "In-store",
      "date": 1602338740,
      "offline": false,
      "location_id": "7701123",
      "promocode": "vxawxSi9Uy",
      "delivery_type": "courier",
      "delivery_address": "111 Peter Street, Toronto, ON, M5V 2H1",
      "delivery_date": "2021-12-21",
      "delivery_time": "15:00",
      "tax_free": false,
      "bank_issuer": "Scotiabank",
      "bank_pos_processor": "Clover",
      "bank_loyalty_program": "PC Optimum",
      "bank_total_installment": 0,
      "payment_card_provider": "Visa"
      "gift_package":true,
      "value": {
        "total": 200.13,
      },
      "payment_structure": {
        "cash": 190,
        "bonuses": 15,
        "delivery": 20,
        "discount": 24.87
      },
      "items": [
        {
          "id": "ITEM-ID-1",
          "price": 205,
          "quantity": 1,
          "status": "created",
          "original_price": 230,
          "discount_product": 30,
          "discount_bonuses": 20,
          "delivery_company": "Canada Post",
          "barcode_id": "195204003541",
          "line_id": "195204003541-22323443-123434",
          "cancel_reason": "none",
        },
}
        ...
      ]
    },
    ...
  ]
}

​
注文のキャンセル

注文のインポートエンドポイントは注文の作成と更新の両方に使用されるため、キャンセルされた注文を登録するためにも使用できます。 キャンセルされた注文を登録するには、次を指定します。

​
クエリパラメーター

パラメーター型必須説明
shop_idStringTrueストアキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。
shop_secretStringTrueシークレットキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。
ordersArrayTrue注文のリスト。キャンセル済みとして登録したい注文を指定します。

​
orders オブジェクトのパラメーター

パラメーター型必須説明
idStringTrue注文 ID
statusStringTrue注文のステータス(cancelled に設定)

​
キャンセル用 JSON リクエスト例

{
  "shop_id": "DvLWN2ZTMZ",
  "shop_secret": "EIxTuot8sj",
  "orders": [
    {
      "id": "yKsvZbWpCL",
      "status": "Cancelled"
    },
    ...
  ]
}