> For the complete documentation index, see [llms.txt](https://helpcenter.etron.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpcenter.etron.info/verwaltungsoberflache/konfiguration/e-commerce/json-schnittstelle/bestellungen-orders.md).

# Bestellungen ("orders")

## Aufbau <a href="#aufbau" id="aufbau"></a>

```
"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": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "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": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "vat_id": "ATU1928533434"
      }
    }
  ]
}
```

### ShippingObject <a href="#shippingobject" id="shippingobject"></a>

| 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 <a href="#orderpaymentobject" id="orderpaymentobject"></a>

| 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 <a href="#orderlineobject" id="orderlineobject"></a>

| 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 <a href="#orderaddressobject" id="orderaddressobject"></a>

| 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 <a href="#mapping-tabelle-anforderungen-onretail" id="mapping-tabelle-anforderungen-onretail"></a>

### **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              | -                                    | ​          |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://helpcenter.etron.info/verwaltungsoberflache/konfiguration/e-commerce/json-schnittstelle/bestellungen-orders.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
