--- agentTools: projectIndex: https://apt-shop.readme.io/llms.txt --- # /Orders/{id} Hier können Sie die Daten einer Bestellung abrufen. ## Identifier | Parameter | Wert | Beschreibung | | :-------- | :--- | :---------------------------------------- | | id | int | die Id des Objekts oder ggf Bestellnummer | ## Parameter | Name | Wert | Beschreibung | | :------------- | :--- | :-------------------------------- | | useOrderNrAsId | bool | der Identifier ist eine BestellNr | ## Response Parameter Es wird ein Array von Datensätzen mit folgenden Parametern zurückgeben: | Name | Beschreibung | Anmerkungen | Wert | | :----------------------------------- | :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- | :----- | | id | Die ID des Objekts. | | int | | location | Die REST URL zum Abrufen des Objekts. | | string | | order\_number | die Bestellnummer | | string | | order\_number\_extern | die externe Bestellnummer | | string | | channel\_number | die externe Kanalnummer | | string | | notice\_customer | die Kundenbemerkung der Bestellung | | string | | notice\_order | die Adminbemerkung der Bestellung | | string | | customer\_id | die Kundennummer | | int | | customer\_email | die E-Mail-Adresse | | string | | customer\_location | die URL, um Details zu der Kundendaten abzurufen | | string | | date | das Bestelldatum | YYYY-MM-DD | date | | custgroup\_id | die interne ID der Kundengruppe | | int | | custgroup\_name | die Bezeichnung der Kundengruppe | | string | | orderstatus\_id | die interne ID der Statusstufe | | int | | orderstatus\_name | die Bezeichnung der Statusstufe | | string | | orderstatus\_intern\_id | die ID des internen Status (benutzt bei erweiterter Warenwirtschaft) | 0 – offen, 1 – versendet, 2 – storniert, 3 -teil-versendet; sonst -1 – undefined | int | | orderstatus\_intern\_name | die Bezeichnung des internen Status (benutzt bei erweiterter Warenwirtschaft) | offen, versendet, storniert, teil-versendet; sonst undefined | string | | delivery\_salutation | die Anrede der Versandadresse | | string | | delivery\_firstname | der Vorname der Versandadresse | | string | | delivery\_lastname | der Nachname der Versandadresse | | string | | delivery\_company | die Firma der Versandadresse | | string | | delivery\_addition | der Zusatzeintrag zur Adresse der Versandadresse | | string | | delivery\_street | die Straße der Versandadresse | | string | | delivery\_streetnr | die Hausnummer der Versandadresse | | string | | delivery\_zip | die PLZ der Versandadresse | | string | | delivery\_city | der Ort der Versandadresse | | string | | delivery\_state | das Bundesland der Versandadresse | | string | | delivery\_country | das Land der Versandadresse | | string | | delivery\_country\_iso2 | der ISO2-Code des Landes der Versandadresse | | string | | delivery\_country\_iso3 | der ISO3-Code des Landes der Versandadresse | | string | | bill\_salutation | die Kundenanrede der Rechnungsadresse | | string | | bill\_firstname | der Vorname der Rechnungsadresse | | string | | bill\_lastname | der Nachname der Rechnungsadresse | | string | | bill\_company | die Firma der Rechnungsadresse | | string | | bill\_addition | der Zusatzeintrag zur Adresse der Rechnungsadresse | | string | | bill\_street | die Straße der Rechnungsadresse | | string | | bill\_street\_nr | die Hausnummer der Rechnungsadresse | | string | | bill\_zip | die PLZ der Rechnungsadresse | | string | | bill\_city | der Ort der Rechnungsadresse | | string | | bill\_state | das Bundesland der Rechnungsadresse | | string | | bill\_country | das Land der Rechnungsadresse | | string | | bill\_country\_iso2 | der ISO2-Code des Landes der Rechnungsadresse | | string | | bill\_country\_iso3 | der ISO3-Code des Landes der Rechnungsadresse | | string | | shipping\_name | die Bezeichnung der Versandart | | string | | shipping\_price | die Versandkosten | | float | | shipping\_tax\_rate | der Steuersatz der Versandart | | float | | billing\_name | die Bezeichnung der Zahlungsart | | string | | billing\_price | die Zahlungsartkosten | | float | | billing\_tax\_rate | der Steuersatz der Zahlungsart | | float | | billing\_modul | die Bezeichnung des Moduls der Zahlungsart | | string | | billing\_notice | die Bemerkung zur Zahlungsart | | string | | price\_exclude\_tax | 0 = Preise sind inkl. Steuer – 1 = Preise sind exkl. Steuer | | bool | | vat\_number | Ust-IdNr des Kunden, wenn in der Bestellung angewendet | | string | | currency\_name | die Währung der Bestellung | | string | | currency\_iso | der ISO-Code der Währung | | string | | order\_type\_id | die interne ID des Bestelltyps | | int | | order\_type\_name | die Bezeichnung des Bestelltyps | | string | | multishop\_id | Die ID des Multishops falls gesetzt | | int | | is\_offer | 1 = die Bestellung ist als Angebot deklariert, sonst 0 | | bool | | total\_amount\_include\_tax | Gesamtsumme inkl. Steuern | | float | | total\_amount\_exclude\_tax | Gesamtsumme exkl. Steuern | | float | | total\_details\_amount\_include\_tax | Summe Bestellpositionen der Bestellung inkl. Steuern | | float | | total\_details\_amount\_exclude\_tax | Summe Bestellpositionen der Bestellung exkl. Steuern | | float | | shipping\_weight | Das Versandgewicht der Bestellung | | float | | tax | Daten zu den Steuersätzen (s.u.) | | array | | voucher | Daten zu den Gutscheinen (s.u.) | | array | | rabatt | wenn Rabatt existiert, dann ist dieser Parameter gesetzt (s.u.) | | array | | details | Daten zu den Bestellpositionen (s.u.) | | array | | bills | die id und [location ](https://apt-shop.readme.io/reference/billsid) der bestehenden Rechnungen | | | ## tax Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Beschreibung | Wert | | :---------- | :------------------------------- | :----- | | tax\_rate | der Steuersatz | float | | tax\_notice | die Bezeichnung inkl. oder exkl. | string | | tax\_amount | der Steuerbetrag | float | ## voucher Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Beschreibung | Wert | | :-------------------- | :-------------------------------------------------- | :----- | | voucher\_type | 0 = Rabattgutschein, 1 = Wertgutschein | bool | | voucher\_number | die Gutscheinnummer | string | | voucher\_number\_text | die Gutscheinnummer, ggf mit Hinweis auf Hersteller | string | | voucher\_discount | der Gutscheinprozentsatz | float | | voucher\_amount | der Gutscheinbetrag | float | ## rabatt Sofern vorhanden, dann folgende Datensätze: | Name | Beschreibung | Wert | | :------- | :-------------------- | :---- | | discount | der Rabattprozentsatz | float | | amount | der Rabattbetrag | float | ## details Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Beschreibung | Wert | | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------- | :----- | | detail\_id | die interne iD | int | | detailstatus\_intern\_id | die ID des internen Status (benutzt bei erweiterter Warenwirtschaft; 0 – offen, 1 – versendet, 2 – storniert; sonst -1 – undefined) | int | | artikel\_nr | die Artikelnummer | string | | order\_nr | die Bestellnummer | string | | name | der Artikelname | string | | company | die Firma | string | | size\_name | die Größenbezeichnung | string | | color\_name | die Farbbezeichnung | string | | availability | die Verfügbarkeitsbezeichnung | string | | description | die Beschreibung | string | | quantity | die Bestellmenge | int | | amount | der Einzelpreis | float | | amount\_quantity | der Mengenpreis | float | | total\_amount | der Gesamtpreis | float | | artikel\_type | 0 – normaler Artikel, 1 – virtueller Artikel, 2 – Bundle, 3 – Gutschein | int | | quantity\_return | die retournierte Menge | int | | extern\_item\_number | die externe Positionsnummer | string | | bundles | Wenn artikel\_type = 2 ist sind hier die Daten zu den gebundleten Artikeln aufgeführt. | array | | details | Die Bestellmerkmale, sofern vorhanden. | array | | location | die URL zum Abrufen der Details, sofern es ein Shopartikel ist | string | ## bundles Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Beschreibung | Wert | | :---------------- | :------------------------------------------------------------- | :----- | | name | der Artikelname | string | | variation\_name | der Variantenname komplett | string | | artikel\_nr | die Artikelnummer | string | | size\_name | die Größenbezeichnung | string | | color\_name | die Farbbezeichnung | string | | quantity | die Bundlemenge | int | | quantity\_details | die Bundlemenge \* die Menge der Bestellpostition | int | | location | die URL zum Abrufen der Details, sofern es ein Shopartikel ist | string | ## details Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Bescheibung | Wert | | :-------------- | :--------------------------- | :----- | | name | der Name des Bestellmerkmals | string | | value | der Wert des Bestellmerkmals | string | | price\_info | Preis mit Währung | string | | price\_quantity | Zusatz-Preis | float | ## shipping Versandinformationen, wenn die Position versendet ist | Bescheibung | Wert | | | :---------------- | :-------------- | :----- | | date | Versanddatum | date | | shipping\_service | Transportdienst | string | | shipping\_method | Versandart | string | | tracking\_number | Sendungsnummer | string | | tracking\_link | Tracking Link | string | ## bills Ein oder mehrere Arrays mit folgenden Datensätzen: | Name | Beschreibung | Wert | | :------- | :------------------------------------ | :----- | | id | Die ID des Objekts. | int | | location | Die REST URL zum Abrufen des Objekts. | string | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "apt-shop REST API", "version": "1.0" }, "servers": [ { "url": "https://www.your-shop.de/api/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Apt-Api-Key", "x-default": "YOUR-API-KEY" }, "sec1": { "type": "apiKey", "in": "header", "name": "Apt-Api-Signature", "x-default": "YOUR-API-SIGNATURE" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/Orders/{id}": { "get": { "summary": "/Orders/{id}", "description": "", "operationId": "ordersid", "parameters": [ { "name": "id", "in": "path", "description": "Id oder Bestellnummer", "schema": { "type": "string" }, "required": true }, { "name": "useOrderNrAsId", "in": "query", "description": "der Identifier ist eine BestellNr", "schema": { "type": "string" } } ], "deprecated": false } } }, "x-readme": { "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "613b178bb774740194757c6a:6149a96897c4fa002ff90625" } ```