Zum Hauptinhalt springen
POST
/
endpoint
Bestellungen importieren
curl --request POST \
  --url https://api.example.com/endpoint
Mit diesem Endpoint können Sie eine Liste von Transaktionsbestellungen in Ihr Kameleoon-Konto importieren. Sie können diesen Endpoint auch verwenden, um Bestellungen und ihre Eigenschaften zu aktualisieren, wenn sie bereits in unserer Datenbank vorhanden sind. Die Daten sollten als JSON-Zeichenfolge im Anfragetext gesendet werden.

​
HTTP-Anfrage

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

​
Liste der Abfrageparameter

ParameterTypErforderlichBeschreibung
shop_idStringTrueIhr Store Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Sie können sich auch an Ihren Customer Success Manager wenden, um den Schlüssel zu erhalten.
shop_secretStringTrueIhr Secret Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Sie können sich auch an Ihren Customer Success Manager wenden, um den Schlüssel zu erhalten.
ordersArrayTrueListe der Bestellungen. In dieser Tabelle finden Sie die für orders erforderlichen Parameter.

​
Liste der Parameter für das orders-Objekt

ParameterTypErforderlichBeschreibung
idStringTrueBestell-ID
external_idStringTrueDies ist ein eindeutiger Identifikator, der einem Benutzer in Ihrem System oder CRM zugeordnet ist. (Um eine genaue Übereinstimmung mit dem Kameleoon VisitorCode zu gewährleisten, muss die ID zunächst als Kameleoon Custom Data gespeichert werden. Stellen Sie beim Einrichten dieser Custom Data sicher, dass Sie die Option Use this custom data as a unique identifier for cross-device matching aktivieren, um sicherzustellen, dass die ID verwendet wird, um Benutzeraktivitäten in beiden Systemen zu verknüpfen.)
statusStringTrueBestellstatus (zum Beispiel Processing, Out for delivery, Delivered)
channelStringTrueFür die Bestellung verwendetes Medium (zum Beispiel Website, App, In-store)
dateIntegerTrueUnix-Zeitstempel in Sekunden, wann die Bestellung aufgegeben oder aktualisiert wurde
offlineBooleanFalseMarkiert Bestellungen als offline. Standardmäßig auf false gesetzt
location_idStringTrueID des Standorts (Stadt) des Benutzers
promocodeStringFalseIn der Bestellung verwendeter Promo-Code
delivery_typeStringFalseLiefertyp (zum Beispiel Courier, Pickup in-store)
delivery_addressStringFalseZieladresse für CRM
delivery_dateDateFalseVoraussichtliches Lieferdatum. Format: “YYYY-MM-DD”
delivery_timeTimeFalseVoraussichtliche Lieferzeit. Format: “HH:MM”
payment_typeStringFalseZahlungsart (zum Beispiel Cash, Card, Wire)
tax_freeBooleanFalseGibt an, ob der Artikel steuerfrei ist
bank_issuerStringFalseBankaussteller
bank_pos_processorStringFalseGibt an, welches Point-of-Sales-System/Terminal (POS) zum Zeitpunkt der Zahlung verwendet wurde
bank_loyalty_programStringFalseBank-Treueprogramm
bank_total_installmentIntegerFalseGesamtanzahl der über die Bank zu zahlenden Raten
payment_card_providerStringFalseAnbieter der Zahlungskarte
gift_packageBooleanFalseGibt an, ob der Artikel in einem Geschenkpaket sein wird
valueObjectTrueGesamtsumme der Bestellung. Den erforderlichen Parameter für value finden Sie in dieser Tabelle.
payment_structureObjectTrueEine Aufschlüsselung der Zahlung (zum Beispiel Barzahlungen, Rabatte, Liefergebühren). Die für payment_structure erforderlichen Parameter finden Sie in dieser Tabelle.
itemsObjectTrueAlles, was in der Bestellung enthalten ist. Die für items erforderlichen Parameter finden Sie in dieser Tabelle.

​
Liste der Parameter für das value-Objekt

ParameterTypErforderlichBeschreibung
TotalNumericTrueBestellsumme

​
Liste der Parameter für das payment_structure-Objekt

ParameterTypErforderlichBeschreibung
cashNumericFalseGibt an, welcher Anteil der Bestellsumme bar bezahlt wurde
bonusesNumericFalseGibt an, welcher Anteil der Bestellsumme mit Boni bezahlt wurde
deliveryNumericFalseGibt die Lieferkosten der Bestellung an
discountNumericFalseGibt den rabattierten Wert der Bestellung an
Bitte stellen Sie sicher, dass value.total == payment_structure.cash + payment_structure.bonuses + payment_structure.delivery - payment_structure.discount

​
Liste der Parameter für das items-Objekt

ParameterTypErforderlichBeschreibung
idStringTrueID des gekauften Produkts
priceNumericTruePreis einer Einzeleinheit des Produkts
quantityIntegerTrueGesamtmenge der ausgewählten Produkte
statusStringTrueArtikelstatus; kann nur sein: created, invoiced, shipped, delivered, cancelled, refunded
original_priceNumericFalseOriginalpreis des Produkts
discount_productNumericFalseRabattierter Preis des Produkts
discount_bonusesNumericFalseRabattierte Boni des Produkts
delivery_companyStringFalsePostdienst, der den Artikel geliefert hat
barcodeStringFalseBarcode des Produkts
line_idStringFalseEindeutige ID für die Position dieses Produkts (Bestellposition) im Bestellsystem Ihres Geschäfts.
cancel_reasonStringFalseStornierungsgrund
Das items-Objekt ist erforderlich, wenn Sie eine Bestellung erstellen. Sie können es als leeres Array senden, wenn Sie den Status einer Bestellung aktualisieren.

​
Beispiel-JSON-Anfrage


{
  "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",
        },
}
        ...
      ]
    },
    ...
  ]
}

​
Eine Bestellung stornieren

Da der Endpoint Import orders sowohl zum Erstellen als auch zum Aktualisieren von Bestellungen verwendet wird, können Sie ihn verwenden, um eine stornierte Bestellung zu registrieren. Um eine stornierte Bestellung zu registrieren, geben Sie Folgendes an:

​
Abfrageparameter

ParameterTypErforderlichBeschreibung
shop_idStringTrueIhr Store Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Sie können sich auch an Ihren Customer Success Manager wenden, um den Schlüssel zu erhalten.
shop_secretStringTrueIhr Secret Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Sie können sich auch an Ihren Customer Success Manager wenden, um den Schlüssel zu erhalten.
ordersArrayTrueListe der Bestellungen. Geben Sie die Bestellungen an, die Sie als storniert registrieren möchten.

​
orders-Objektparameter

ParameterTypErforderlichBeschreibung
idStringTrueBestell-ID
statusStringTrueStatus der Bestellung (auf cancelled gesetzt)

​
Beispiel für eine Stornierungs-JSON-Anfrage

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