Übersicht der Metadata für Lese und Schreibzugriffe auf die Warenkörbe und Warenkorbpositionen
Erstellen eines Warenkorbs
Der Request-Body zum Erstellen eines Warenkorbs enthält die Variable „cartName“, der man den Namen des zu erstellenden Warenkorbs zuweisen kann.
URL der POST-Methode: https://api.itscope.com/2.1/business/carts
Beispiel:
POST https://api.itscope.com/2.1/business/carts
{
"cartName": "Warenkorb von Thomas"
}Bearbeiten eines Warenkorbs (umbenennen)
Der Request-Body ist der gleiche wie beim Warenkorb erstellen. Der Variable „cartName“ ist also der neue Name des Warenkorbs zugewiesen.
Der zu editierende Warenkorb ist anhand der Warenkorb-ID (cartId) festzulegen, der beim Erstellen eines Warenkorbs vergeben wird.
URL der PUT-Methode: https://api.itscope.com/2.1/business/carts/<cartId>
Beispiel:
PUT https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e
{
"cartName": "Einkäufe von Thomas"
}Löschen eines Warenkorbs
Der zu löschende Warenkorb kann mithilfe der Warenkorb-ID (cartId) bestimmt werden.
URL der DELETE-Methode: https://api.itscope.com/2.1/business/carts/<cartId>
Beispiel:
DELETE https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e
Einem Warenkorb Produkte hinzufügen
Der Request-Body zum Hinzufügen eines Warenkorbs enthält das Objekt „cartLineItem“.
Die benötigten Vairablen sind im Metadaten Thema nachzuschauen
Der Warenkorb, dem die Produkte hinzugefügt werden sollen, wird anhand der Warenkorb-ID (cartId) bestimmt.
URL der POST-Methode: https://api.itscope.com/2.1/business/carts/<cartId>/cartlineitems
Beispiel 1:
Wir möchten das Produkt mit der PUID 1559972000 zum Warenkorb hinzufügen und möchten dieses Produkt 5 mal von Ingram Micro beziehen. Ingram hat die Lieferanten-ID 14 und das Produkt hat bei Ingram die Artikelnummer „9432GFW“. Eine Endkundenbestellreferenz oder Adressen setzen wir nicht, da wie erstere nicht brauchen und zweitere aus ITscope geladen wird.
POST https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cartlineitems
{
"cartLineItem": [
{
"puid": 1559972000,
"supplierId": 14,
"supplierItemId": "9432GFW",
"quantity": 5,
"comment": "Für den Drucker im Büro Süd"
}
]
}Beispiel 2:
Wieder wollen wir das Produkt mit der PUID 1559972000 fünf mal dem Warenkorb hinzufügen. Dieses mal beschaffen wir das Produkt für einer unserer Kunden, dessen Bestellreferenz AB12345 entspricht. Die Bestellung soll an eine bestimmte Adresse gesendet werden, weshalb noch eine Lieferadresse (delivery) und eine Endkundenadresse (customer) gesetzt wurde. Neben Lieferadresse (delivery), kann auch noch zusätzlich eine Rechnungsadresse (invoice_recipient) und Endkundenadresse (customer) gesetzt werden.
POST https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cartlineitems
{
"cartLineItem": [
{
"puid": 1559972000,
"supplierId": 14,
"supplierItemId": "9432GFW",
"quantity": 5,
"comment": "Für den Drucker im Büro Süd",
"customerOrderReference": "AB12345",
"referencedAddresses":
{
"referencedAddress": [
{
"addressType": "delivery",
"name": "Max Mustermann",
"street": "Musterstr. 5",
"zipCode": "12345",
"city": "Karlsruhe",
"countryCoded": "DE",
"contactEmail": "Max@Mustermann.de"
},
{
"addressType": "customer",
"name": "Peter Mustermann",
"name2": "Addresszusatz1",
"name3": "Addresszusatz2",
"street": "Endkundenstrasse 5",
"zipCode": "12345",
"city": "Karlsruhe",
"countryCoded": "DE",
"contactFirstName": "Peter"
"contactLastName": "Mustermann"
"contactEmail": "peter@Mustermann.de"
}
]
}
}
]
}
Produkte aus einem Warenkorb entfernen
Das zu entfernende Produkt kann mithilfe der Positions-ID (lineitemId) bestimmt werden. Weiterhin muss natürlich die Warenkorb-ID (cartId) mit angegeben werden.
URL der DELETE-Methode: https://api.itscope.com/2.1/business/carts/<cartId>/cartlineitems/<lineitemId>
Beispiel:
Einen Warenkorb abrufen
Zum Abrufen eines Warenkorb wird die Warenkorb-ID (cartId) benötigt. Die Ausgabe erfolgt im Warenkorbformat.
URL der GET-Methode: https://api.itscope.com/2.1/business/carts/<cartId>/cart.json*
* oder cart.xml
Beispiel:
GET https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cart.json
Alle Warenkörbe auflisten
Zum Abrufen der Liste aller Warenkörbe. Die Ausgabe erfolgt im Warenkorbformat.
URL der GET-Methode: https://api.itscope.com/2.1/business/carts/cart.json*
* oder cart.xml
Beispiel: