/Orders/{id}

GET https://www.your-shop.de/api/v1/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 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