Bestellungen ("orders")

Aufbau

"orders": array of `OrderObject`

OrderObject

Property name	Description	Definition
id	Webshop Order Number	string, max 255 characters, unique
created_at_utc	Order creation date	format utc with timezone
updated_at_utc	Order update date	datetime, format utc with timezone
status	Webshop Order Status	string
shipping_method	ShippingObject	Versandart
currency	Currency Code (nur info wie der Kunde bezahlt, die Line items sind immer in Euro)	3 characters
comment	Customer order comment	string, max. 255 characters, optional
taxmodel	Kennzeichen ob Brutto oder Netto verrechnet wurde: Preisangaben in Line items sind dann auch brutto od netto	"GROSS" or "NET"
_payment	OrderPaymentObject	Zahlungsinformation
_lines	array of OrderLineObject	Rechnungszeilen (Produkt, Versandkosten, Rabatte, Gesamtsumme)
_shipping_address	OrderAddressObject	Versandadresse des Kunden (optional bei Bestellungen ohne materielle Güter)
_billing_address	OrderAddressObject	Rechnungsadresse des Kunden

Beispiel

{
  "orders": [
    {
      "id": "100000222",
      "created": "2019-05-22 07:30:50",
      "updated": "2019-05-22 07:31:25",
      "status": "processing",
      "shipping_method": {
        "type": "DHL",
        "description": "Versand über DHL"
      },
      "currency": "EUR",
      "comment": "Kommentar zur Bestellung vom Kunden",
      "taxmodel": "GROSS",
      "_payment": {
        "method": "CC",
        "cctype": "Visa"
      },
      "_lines": [
        {
          "type": "product",
          "is_line": true,
          "quantity": "1",
          "sku": "2113000016259",
          "name": "Product name",
          "unitprice": 19.99,
          "amount": 19.99,
          "discount_amount": 0,
          "tax_amount": 3.33,
          "taxclass": "REGULAR"
        },
        {
          "type": "shipping",
          "is_line": true,
          "amount": 4.9,
          "tax_amount": 0.82,
          "taxclass": "REGULAR"
        },
        {
          "type": "total",
          "is_line": false,
          "amount": 24.89,
          "tax_amount": 4.15
        }
      ],
      "_shipping": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "[email protected]",
        "phone": "[phone]",
        "vat_id": "ATU192853434"
      },
      "_billing": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "[email protected]",
        "phone": "[phone]",
        "vat_id": "ATU1928533434"
      }
    }
  ]
}

ShippingObject

Property name	Description	Definition
type	Webshop Shipping Method Identifier	string, max 255 characters
description	Description information for shipping method (like address if packup at store)	string, max 255 characters, optional

OrderPaymentObject

Property name	Description	Definition
method	Webshop Payment Method Identifier	string, max 255 characters One of cc, paypal, sofort, invoice, banktransfer, cod
cctype	Type of credit card (various)	string, max 255 characters, if method="cc" One of Visa, MC/MasterCard, Amex (exact values may vary)

OrderLineObject

Property name	Description	Definition
type	Type of line item	one of "product", "shipping", "discount", "total" (is special because all other lines sum up to equal total line)
is_line	Flag whether line should appear in billing documents	true (if type=product or shipping) / false (if type=discount or total)
quantity	Line item quantity	numeric, needed if type="product"
sku	SKU of product	needed if type="product"
name	Name of product	needed if type="product", string max 255 characters
unitprice	Base price of product (noch nicht rabattiert)	needed if type="product", decimal, 2 decimals if order taxmodel="GROSS", 4 decimals precision of order taxmodel="NET"
discount_amount	Discount calculated on product line	optional if type="product", decimal, 2 decimals if order taxmodel="GROSS", 4 decimals precision of order taxmodel="NET"
amount	Line price of product	(=unitprice * quantity - discount_amount) needed if type="product", decimal, 2 decimals if order taxmodel="GROSS", 4 decimals precision of order taxmodel="NET"
tax_amount	Tax amount of line price	(tax of amount) needed if type="product", decimal, 2 decimals if order taxmodel="GROSS", 0 if order taxmodel="NET"
taxclass	Tax class identifier of product	string

OrderAddressObject

Property name	Description	Definition
id	Webshop Address Entry ID	numeric
salutation	Customer Prefix (Mr,Mrs,Herr,Frau)	string, max 255 characters, optional
firstname	Customer First Name	string, max 255 characters
lastname	Customer Last Name	string, max 255 characters
street	Customer Street Address	string, max 255 characters. May contain "\n" for line breaks
zip	Customer ZIP	string, max 255 characters
city	Customer City	string, max 255 characters
country	Customer Country Code	2 characters ISO Country code
company	Customer Company Name Code	string, max 255 characters, optional
email	Customer eMail Address	string, max 255 characters
phone	Customer Phone Number	string, max 255 characters, optional
vat_id	Customer VAT Number	string, max 255 characters, optional

Mapping Tabelle, Anforderungen onRetail

OrderObject

JSON API FELD	Transformation	onRetail Datenziel	Anpassung	Related US
id	1:1	-	Neues Feld für die Webshop Order ID	​
created	Umwandlung zu Datetime	sale.order.create_date	-	​
updated	Umwandlung zu Datetime	sale.order.write_date	-	​
status	Mapping Tabelle	-	sale.order Stati auf die des Webshops mappen	​
shipping_method	Mapping Tabelle	delivery.carrier	-	​
currency	Mapping Tabelle	res.currency	-	​
comment	1:1	-	Neues Feld	​
taxmodel	1:1	-	Neues Feld, Berechnung der Preise	​
_payment	OrderPaymentObject	-	​	​
_lines	array of OrderLineObject	​	​	​
_shipping_address	OrderAddressObject	​	​	​
_billing_address	OrderAddressObject	​	​	​

OrderPaymentObject

JSON API FELD	Transformation	onRetail Datenziel	Anpassung	Related US
method	Mapping Table	-	Mapping Table	​
additional_information	Mapping Table	-	Mapping Table. Bei Info success, Zahlung zur sale.order hinzufügen	​

OrderLineObject

JSON API FELD	Transformation	onRetail Datenziel	Anpassung	Related US
type	-	sale.order	Versandkosten/Rabatt zuordnen	​
quantity	1:1	sale.order.line.product_uom_qty	-	​
sku	1:1	sale.order.line.product_id	-	​
name	-	sale.order.line.product_id.name	Feld verwerfen, Name ist abhängig von der gewählten Sprache	​
unitprice	1:1	sale.order.line.price...	Berechnung/Datenziel abhängig vom Typ	​
amount	1:1	sale.order.line.price_subtotal	-	​
tax_amount	1:1	-	Neues Feld, Berechnung der Steuer durch onRetail muss möglicherweise umgangen werden	​
taxclass	1:1	product.product.tax_id.code	-	​

OrderAddressObject

JSON API FELD	Transformation	onRetail Datenziel	Anpassung	Related US
id	1:1	-	Neues Feld für die Webshop Kunden ID	​
prefix	Mapping Table	res.partner.title	Mapping	​
firstname	Concat	res.partner.name	Vor- und Nachname zuammenführen	​
lastname	Concat	res.partner.name	Vor- und Nachname zuammenführen	​
street	String Bereinigen	res.partner.street	-	​
zip	1:1	res.partner.zip	-	​
city	1:1	res.partner.city	-	​
country	1:1	res.partner.country_id.code	-	​
company	Neuanlage Unternehmen bei Neukunden, ansonsten Feld verwerfen	res.company	Weshop Kunden ID	​
email	1:1	res.partner.email	-	​
phone	1:1	res.partner.phone	-	​
vat	1:1	res.partner.vat	-	​