API-Referenz Bestellungen

API-Referenz Bestellungen

 

Der Endpunkt orders/ stellt Ihnen eine Schnittstelle zur Verwaltung von Bestelldaten in unserem Shop-System bereit. Mit dieser Schnittstelle können Sie Bestelldaten abrufen, löschen und den Status aktualisieren.

Inhaltsverzeichnis:


1. Unterstützte Methoden

Angabe aller unterstützten Methoden.

Befehl/Info

Endpunkte

GET

PUT

POST

DELETE

Befehl/Info

Endpunkte

GET

PUT

POST

DELETE

Bestellungen

orders/

 

2. Datenfelder einer Bestellung

Name

Typ

Bedeutung

Name

Typ

Bedeutung

createdAt

String

Zeitpunkt, zu dem die Bestellung aufgegeben wurde (ISO 8601-Format, UTC).

deleted

Boolean

Gibt an, ob die Bestellung gelöscht wurde.

deliveryStatus

Objekt

Informationen über den Versand

id

String

Eindeutige ID der Bestellung.

paymentStatus

Integer

Status der Bezahlung (z. B. offen, bezahlt, fehlgeschlagen)

Mögliche Werte:

0 = Pending
1 = Finished
2 = Error
3 = Redirected
4 = Canceled
5 = Rejected
6 = CanceledByAdmin
7 = Refunded
8 = RefundedPartially

processingStatus

Integer

Status der Bestellverarbeitung

Mögliche Werte:

0 = New
1 = Finished
2 = Deleted
3 = Canceled

verificationStatus

Integer

Status der Echtheit der Bestellung (z. B. echt, Testbestellung)

Mögliche Werte:

0 = Default
1 = Test
2 = Fake
3 = PendingDefault
4 = PendingTest
5 = PendingFake

subshopId

String

ID des Subshops, über den die Bestellung abgeschlossen wurde.

data.general.dateTime

String

Zeitpunkt der Bestellung laut Metadaten (ISO 8601-Format, UTC).

data.general.orderId

String

Eindeutige ID der Bestellung.

data.general.sessionId

String

ID der Session, in der die Bestellung abgeschlossen wurde.

data.general.shopId

String

Technischer Name des Shops.

data.general.shopLanguage

String

Sprache des Shops während der Bestellung.

data.general.subshopId

String

Subshop-ID aus Metadaten (redundant mit oberem Feld).

data.general.testMode

Boolean

Gibt an, ob die Bestellung im Testmodus erstellt wurde.

data.customer.accountId

Integer

ID des Kundenkontos, das die Bestellung getätigt hat.

data.customer.accountType

String

Typ des Kundenkontos.

Mögliche Werte:

"new"
"registered"
"guest"

data.customer.customerNumber

String

Kundennummer (sofern vergeben).

data.customer.deviceType

Integer

Gerätetyp des Kunden beim Checkout. 1 – Desktop, 2 – Handy, 3 – Tablet.

data.customer.email

String

E-Mail-Adresse des Kunden.

data.customer.ipAddress

String

IP-Adresse des Kunden bei der Bestellung.

data.customer.platformType

Integer

Plattformtyp des Kunden. 1 – Web, 2 – App.

data.shippingAddress

Objekt (Adresse)

Lieferadresse

data.billAddress

Objekt (Adresse)

Rechnungsadresse

data.order.currencyIso

String

ISO-Code der Währung (z. B. EUR).

data.order.currencySymbol

String

Währungssymbol (z. B. €).

data.order.defaultTaxRate

String

Standard-Mehrwertsteuersatz.

data.order.delivererId

String

ID des Versanddienstleisters.

data.order.delivererOrderText

String

Anzeigename des Versanddienstleisters.

data.order.deliveryCost

String

Versandkosten (Brutto).

data.order.deliveryTaxRate

String

Mehrwertsteuersatz auf Versand.

data.order.paymentId

String

ID der gewählten Zahlungsart.

data.order.paymentOrderText

String

Anzeigename der Zahlungsart.

data.order.priceType

String

Preisangabe: "gross" oder "net".

data.order.referer

String

Ursprungs-URL der Bestellung.

data.order.subreferer

String

Weitere Herkunftsinformationen.

data.order.subtotal

String

Zwischensumme der Produkte.

data.order.tax

String

Gesamtsumme der Steuern.

data.order.total

String

Gesamtsumme der Bestellung (inkl. Versand und Rabatte).

data.order.totalCommission

String

Gesamte Provision.

data.order.totalDiscount

String

Gesamter Rabattbetrag.

data.order.totalVoucher

String

Gesamter eingelöster Gutscheinwert.

data.order.totalWeight

number

Gesamtgewicht der Bestellung.

data.orderList.item[].basketId

String

ID des Warenkorbeintrags.

data.orderList.item[].discount

String

Rabatt auf diesen Artikel.

data.orderList.item[].extraFields

Objekt

Benutzerdefinierte Felder des Warenkorbartikels.

data.orderList.item[].isAutoBasket

Boolean

Artikel automatisch in den Warenkorb gelegt.

data.orderList.item[].isChangeable

Boolean

Warenkorbartikel änderbar.

data.orderList.item[].isRemovable

Boolean

Warenkorbartikel entfernbar.

data.orderList.item[].isVisible

Boolean

Gibt an, ob der automatisch gelegte Artikel im Warenkorb sichtbar ist.

data.orderList.item[].itemNumber

String

Artikelnummer.

data.orderList.item[].name

String

Artikelbezeichnung.

data.orderList.item[].orgPrice

String

Originalpreis (vor Rabatt).

data.orderList.item[].price

String

Preis pro Stück.

data.orderList.item[].productId

String

Produkt-ID.

data.orderList.item[].quantity

String

Bestellte Menge.

data.orderList.item[].singleTotal

String

Gesamtpreis dieses Artikels (Menge × Preis).

data.orderList.item[].taxId

String

Steuer-ID.

data.orderList.item[].taxRate

String

Mehrwertsteuersatz.

data.orderList.item[].total

String

Endpreis dieses Artikels (inkl. Rabatt etc.).

data.orderList.item[].variantId

String

Varianten-ID.

data.orderList.item[].variantSelection[]

Objekt[]

Varianten-Auswahl des Artikels.

data.orderList.item[].variantSelection[].attributeId

String

Name der Varianten-Eigenschaft (z. B. "Size").

data.orderList.item[].variantSelection[].optionId

String

Gewählte Option (z. B. "M").

data.orderList.item[].weight

Float

Gewicht des Artikels.

data.freeFields

Objekt

Benutzerdefinierte Felder der Bestellung

data.vouchers[].id

String

Gutschein-Code.

data.vouchers[].name

String

Name des Gutscheins.

data.vouchers[].charge

String

ID der Gutschein-Charge.

data.vouchers[].value

String

Ursprünglicher Gutscheinwert.

data.vouchers[].rest

String

Restwert des Gutscheins nach Einlösung.

data.vouchers[].taxId

String

Steuer-ID für Gutschein.

data.vouchers[].taxRate

Float

Steuersatz für Gutschein.

Beispiel:

{ "createdAt": "2025-04-16T13:02:43Z", "data": { "billAddress": { "additionalInfo": "", "addressType": "1", "businessFax": "", "businessPhone": "", "city": "asdf", "company": "WEBSALE AG", "country": "DE", "countryName": "Deutschland", "custom": null, "dateOfBirth": "", "department": "", "fax": "", "firstName": "asdff", "lastName": "asdf", "mobilePhone": "", "phone": "987", "salutationCode": "1", "salutationText": "Herr", "state": "", "street": "asdf", "streetNumber": "9", "taxId": "", "titleCode": "2", "titleText": "Dr.", "zip": "99999" }, "computop-hosted": {}, "customer": { "accountId": 1, "accountType": "registered", "customerNumber": "", "deviceType": 1, "email": "root@root.root", "ipAddress": "172.18.0.1", "platformType": 1 }, "dummy": {}, "freeFields": { "agb.checked": "true", "agb.merchantText": "agb text here", "comment.text": "" }, "general": { "dateTime": "2025-04-16T13:02:43Z", "orderId": "1300", "sessionId": "d25e2c0b739aacdf4d3e55727ea6ffae943ebf15021ac1d6b60ba5f5c5d04582", "shopId": "", "shopLanguage": "Deutsch", "subshopId": "deutsch", "testMode": false }, "order": { "currencyIso": "EUR", "currencySymbol": "€", "defaultTaxRate": "0.1900000", "delivererId": "hermes", "delivererOrderText": "Hermes", "deliveryCost": "3.95", "deliveryTaxRate": "0.1900000", "paymentId": "safepayment", "paymentOrderText": "Sichere Zahlungsart", "priceType": "gross", "referer": "https://myshop.localhost/?wsvc=View&view=confirm.htm", "subreferer": "", "subtotal": "10.00", "tax": "0.63", "total": "3.95", "totalCommission": "0.00", "totalDiscount": "0.00", "totalVoucher": "10.00", "totalWeight": 0 }, "orderList": { "item": [ { "basketId": "9680cda2830c10b063ca", "discount": "0.00", "extraFields": {}, "isAutoBasket": false, "isChangeable": true, "isRemovable": true, "isVisible": true, "itemNumber": "8765", "name": "Something2", "orgPrice": "0.00", "price": "5.00", "productId": "143-68071", "quantity": "1.00", "singleTotal": "5.00", "taxId": "19", "taxRate": "0.1900000", "total": "5.00", "variantId": "", "variantSelection": null, "weight": 0 }, { "basketId": "0d191c832e46f326fc420dc59aa9facfc69f2fda5a5cad2e26d...", "discount": "0.00", "extraFields": {}, "isAutoBasket": true, "isChangeable": false, "isRemovable": false, "isVisible": true, "itemNumber": "12341234", "name": "myProduct", "orgPrice": "0.00", "price": "5.00", "productId": "105-59442", "quantity": "1.00", "singleTotal": "5.00", "taxId": "19", "taxRate": "0.1900000", "total": "5.00", "variantId": "1", "variantSelection": [ { "attributeId": "Color", "optionId": "red" }, { "attributeId": "Size", "optionId": "M" } ], "weight": 0 } ] }, "paypal-checkout": { "executePayPalResponse": "", "expressCheckout": "false", "orderID": "", "paymentAction": "CAPTURE", "paymentID": "", "paymentMode": "PayPal", "paypalStatus": "" }, "shippingAddress": null, "vouchers": [ { "charge": "121", "id": "93JC-TGGL-KA3M-MRA7", "name": "myVoucher", "rest": "0.00", "taxId": "19", "taxRate": 0.19, "value": "55.00" } ] }, "deleted": false, "deliveryStatus": {}, "id": "1300", "paymentStatus": 1, "processingStatus": 0, "subshopId": "deutsch", "verificationStatus": 0 }

 

3. Verwendung der Methoden

3.1 GET orders

Diese Methode liefert eine Liste aller Bestellungen aus dem Admin-Interface des Shops.

Beispiel:

https://www.<ihr-shop>.de/admin/api/v1/orders

Antwort:

{ "endReached": true, "items": [ { "accountId": 1, "createdAt": "2024-11-07T17:38:32Z", "data": { "billAddress": { "country": "DE", "countryName": "Deutschland", "firstName": "asdf", ... }, "computop-hosted": {}, "customer": { "accountId": 1, "accountType": "registered", "email": "root@root.root", "ipAddress": "172.18.0.1" }, "dummy": {}, "freeFields": { "agb.checked": "true", "agb.merchantText": "agb text here", "comment.text": "" }, "general": { "dateTime": "2024-11-07T17:38:32Z", "orderId": "820", "sessionId": "79d803076669c8a41874d9d2cd8451f...", "shopId": "myshop", "shopLanguage": "", "subshopId": "deutsch", "testMode": false }, "order": { "currencyIso": "EUR", "currencySymbol": "€", "defaultTaxRate": "0.1900000", "delivererId": "dhl", "delivererOrderText": "DHL", "deliveryCost": "11.00", "deliveryTaxRate": "0.1900000", "paymentId": "bill", "paymentOrderText": "Rechnung", "priceType": "gross", "subtotal": "5.00", "tax": "2.55", "total": "16.00", "totalCommission": "0.00", "totalDiscount": "0.00", "totalVoucher": "0.00" }, "orderList": { "item": [ { "basketId": "d0c04a4cb60f708288a2", "freeFields": { "gravur1": "", "gravur2": "", "gravur3": "" }, "isAutoBasket": false, "isChangeable": true, "isRemovable": true, "isVisible": true, "itemNumber": "8", "name": "T-Shirt 'Land Rover' in Hellgrau", "price": "5.00", "productId": "105-59442", "quantity": "1.00", "singleTotal": "5.00", "taxId": "19", "taxRate": "0.1900000", "total": "5.00", "variantId": "1", "variantSelection": [ { "attributeId": "555", "optionId": "foo" }, { "attributeId": "888", "optionId": "bar" } ] } ] }, "paypal-checkout": { "executePayPalResponse": "", "orderID": "", "paymentAction": "CAPTURE", "paymentID": "", "paymentMode": "PayPal", "paypalStatus": "" }, "shippingAddress": null, "vouchers": null }, "deleted": false, "deliveryStatus": {}, "id": "820", "paymentStatus": 1, "processingStatus": 0, "subshopId": "deutsch", "version": 1 }, ... ], "nextPageToken": "Mw", "totalCount": 4 }

Filterfelder:

createdAt, payedAt, id, subshopId, accountId, processingStatus, paymentStatus, deleted

Sortierfelder:

createdAt, updatedAt, id, processingStatus, paymentStatus, subshopId

Fehlercodes:

Fehler

Typ

Grund

Fehler

Typ

Grund

401 Unauthorized

 

Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Benutzern.

400 Bad Request

"invalidValue"

size ∉ [1;300]
sort ∉ {"asc", "desc"}
pageToken ist keine Zahl oder kleiner als 0

400 Bad Request

"unknownDataField"

Ein Filter- oder Sortierfeld ist ungültig.

400 Bad Request

"unknownOperation"

Ein Filtertyp ist ungültig.

400 Bad Request

"invalidCharacters"

size ist keine Ganzzahl.
Ein Filterwert ist ungültig.

400 Bad Request

"syntaxError"

sort enthält mehr als einen oder keinen ":".

© 2025 WEBSALE AG | Impressum | Datenschutz