id
Typ: string
Beschreibung: Der (technische) eindeutige Identifier der Bestellung. Wenn du dieselbe id beim Übermitteln einer Bestellung wiederverwendest, wird die alte Version überschrieben.
Beispielwert(e): '12345678' oder 'ABC-12345678-XYZ'
createdAt
Typ: number
Beschreibung: Unix-Timestamp in Sekunden des Zeitpunkts, zu dem die Bestellung aufgegeben wurde.
Beispielwert(e): 1678376546
updatedAt
Typ: number
Beschreibung: Unix-Timestamp in Sekunden des Zeitpunkts, zu dem die Bestellung zuletzt in deinem System aktualisiert wurde.
Beispielwert(e): 1678376546
processedAt
Typ: number
Beschreibung: Unix-Timestamp in Sekunden des Zeitpunkts, zu dem die Bestellung erfüllt wurde.
Beispielwert(e): 1678376546
closedAt
Typ: number
Beschreibung: Unix-Timestamp in Sekunden des Zeitpunkts, zu dem die Bestellung geschlossen wurde.
Beispielwert(e): 1678376546
cancelledAt
Typ: number
Beschreibung: Unix-Timestamp in Sekunden des Zeitpunkts, zu dem die Bestellung storniert wurde.
Beispielwert(e): 1678376546
currencyCodeIso3Letter
Typ: string
Beschreibung: 3-stelliger Währungscode nach dem ISO 4217 Alpha-3-Standard, in dem die Bestellung verarbeitet wurde.
Beispielwert(e): 'EUR' oder 'GBP'
financialStatus
Typ: string
Beschreibung: Der Status der Bestellung hinsichtlich der finanziellen Verarbeitung. Du kannst deine internen Status verwenden, die sich in der App auf Klars Standard-Status mappen lassen — z.B. wenn der Status in deinem System statt 'pending' 'open' heißt, kannst du 'open' auf 'pending' mappen, sodass die Bestellstatus übereinstimmen.
Beispielwert(e): 'pending' oder 'partially_paid' oder 'paid'
shipmentStatus
Typ: string
Beschreibung: Der Status der Bestellung hinsichtlich des Versands. Du kannst deine internen Status verwenden, die sich in der App auf Klars Standard-Status mappen lassen — z.B. wenn der Status in deinem System statt 'pending' 'open' heißt, kannst du 'open' auf 'pending' mappen, sodass die Bestellstatus übereinstimmen.
Beispielwert(e): 'shipped' oder 'pending'
paymentGatewayName
Typ: string
Beschreibung: Das Payment Gateway, das zur Zahlungsabwicklung verwendet wurde.
Beispielwert(e): 'paypal' oder 'stripe'
paymentMethodName
Typ: string
Beschreibung: Die Zahlungsmethode, die zur Zahlungsabwicklung verwendet wurde.
Beispielwert(e): 'credit_card' oder 'invoice'
orderName
Typ: string
Beschreibung: Ein kundenfreundlicher Name der Bestellung, üblicherweise in einer Transaktions-E-Mail oder auf einer Bestellstatus-Seite enthalten.
Beispielwert(e): 'Order #12312341234' oder 'Awesome Food - Order #1342'
orderNumber
Typ: string
Beschreibung: Die Bestellnummer, die in deinem Shopsystem zur Identifikation der Bestellung verwendet wird.
Beispielwert(e): '12312345213412' oder 'O-4234234-A'
tags
Typ: [string]
Beschreibung: Ein Array von Tags für die Bestellung
Beispielwert(e): ['subscription', 'first_order'] oder ['giveaway']
lineItems
Typ: [LineItem]
Beschreibung: Die Produkte, die Teil dieser Bestellung waren, als Array von Objekten des Typs LineItem.
Beispielwert(e): siehe LineItem
refundedLineItems
Typ: [RefundedLineItems]
Beschreibung: Die Produkte, die in dieser Bestellung erstattet wurden, vom Typ refundedLineItem. Leeres Array [], wenn keine Artikel erstattet wurden.
Beispielwert(e): siehe RefundedLineItem
shipping
Typ: Shipping
Beschreibung: Die Versandinfos für diese Bestellung vom Typ Shipping
Beispielwert(e): siehe Shipping
transactionCosts
Typ: number
Beschreibung: Die Zahlungs- und Transaktionskosten für die Bestellung.
Beispielwert(e): 1.10 oder 2
customer
Typ: Customer
Beschreibung: Die Kundeninfos für diese Bestellung vom Typ Customer
Beispielwert(e): siehe Customer
optionalIdentifiers
Typ: OptionalIdentifiers
Beschreibung: Ein Objekt vom Typ OptionalIdentifiers, das Infos wie utmParameters, Subscription-Infos, Order-Source und weitere enthält.
Beispielwert(e): siehe OptionalIdentifiers