API für Bestellungen
Bestellung erstellen
Testendpunkt:
https://transact.ti.com/v2/store/orders/test
Produktionsendpunkt:
https://transact.ti.com/v2/store/orders/
Die API für Bestellungen gibt Ihnen die Möglichkeit, Bestellungen zu erstellen und detaillierte Bestellinformationen abzurufen. Bevor Sie eine Bestellung erstellen, müssen Sie die Verfügbarkeit der einzelnen Artikel mithilfe der Inventar- und Preis-API überprüfen.
Um eine Bestellung aufgeben zu können (Test oder Produktion), müssen Sie ein API-fähiges Checkout-Profil in Ihrem Firmenkonto gespeichert haben. Weitere Informationen finden Sie unter Erste Schritte. Dort finden Sie weitere Informationen zur Erstellung von Firmenkonten und Checkout-Profilen. Um ein Checkout-Profil auszuwählen, auf das Sie bei Ihrer Bestellung verweisen möchten, verwenden Sie die Checkout-Profil-API. In der Antwort werden nur API-fähige Checkout-Profile zurückgegeben. Wenn ein Checkout-Profil fehlt, stellen Sie sicher, dass das Checkout-Profil vollständig ist und eine zulässige Zahlungsmethode hinzugefügt wurde (siehe Zahlungsinformationen für weitere Informationen).
Die vom Testendpunkt zurückgegebenen Daten simulieren die Informationen, die von einer Produktionsbestellung zurückgegeben werden (die Daten dienen nur der Veranschaulichung und stellen keine verarbeiteten Daten dar). Wenn Sie bereit sind, einen Produktionsbestellung aufzugeben, überprüfen Sie alle Parameter, die Sie in der Nutzlast der Anfrage senden möchten, und verwenden Sie das HTTP-Verb "post" zum Produktionsendpunkt.
HINWEIS: Die Felder customerOrderComments und customerItemComments sind Arrays von Pass-Through-Text, die in der Retrieve-Antwort zur Bestellung zurückgegeben werden. Die Daten sind nur für den Kunden bestimmt und werden nicht von TI validiert. Im Beispiel unten wird das Array customerOrderComments verwendet, um ein Array von durch Pipes getrennten Strings zu übergeben, um die Jobnummer und den Namen der Person anzugeben, die die Bestellung aufgibt.
Beispiel:
"customerOrderComments": [
{
"message": "jobNumber|54851-50"
},
{
"message": "orderedBy|John Smith"
}
]
Ablauf der Auftragserstellung
- Authentifizieren Sie sich mit Ihrem zugewiesenen API-Schlüssel und -Kennwort.
- Senden Sie eine Abfrage an die Inventar- und Preis-API, um die Produktverfügbarkeit und aktuelle Preisinformationen abzurufen.
- Die API antwortet mit dem Statuscode 200 OK und einer JSON-Antwort (JavaScript Object Notation), die die angeforderten Produktdaten enthält.
- Nachdem Sie die Verfügbarkeit mit der Bestands- und Preis-API bestätigt haben, erstellen Sie Ihre Bestellung mit der gewünschten Payload und senden Sie sie an die Bestell-API.
- Die API antwortet mit dem Statuscode 201 OK und einer JSON-Datei, die die Auftragsbestätigung enthält.
Beispielantwort: