Detail objednávky
Základní info
- URL:
https://b2bapi-{INSTANCE}/api/orders/{orderId} - Povolené metody:
GET
Schéma
Hlavička objednávky
| Pole | Datový typ | Popis |
|---|---|---|
id | int | Unikátní identifikátor |
formNumber | string(150) | Číslo dokladu ve Vašem systému |
transportTypeId | int | ID typu dopravy |
paymentTypeId | int | ID typu platby |
note | string(255) | Poznámka |
address | OrderAddress | Adresy objednávky |
items | OrderItem[] | Položky objednávky (popsáno níže) |
lastModify | Date / null | Datum poslední změny |
createdAt | Date | Datum pořízení |
Položky objednávky
| Pole | Datový typ | Popis |
|---|---|---|
productId | int | ID produktu |
barcode | string(50) | Čárový kód |
quantity | decimal(15,2) | Objednané množství |
productCode | string(50) | Kód zboží |
productName | string(200) | Název produktu |
price | decimal(15,2) | Cena |
priceWoVat | decimal(15,2) | Cena bez DPH |
vatRate | decimal | Sazba DPH |
Adresy objednávky
Adresa buď obsahuje Vaši výchozí adresu uloženou v systému, nebo je možné ji při vytváření objednávky specifikovat.
| Pole | Datový typ | Popis |
|---|---|---|
companyIdentificationNumber | string(15) | IČ |
VATRegistrationNumber | string(15) | DIČ |
VATPayer | bool | Je plátce DPH |
note | string(255) | Poznámka |
deliveryAddress | OrderDeliveryAddress | Dodací adresa objednávky (popsáno níže) |
invoicingAddress | OrderInvoicingAddress | Fakturační adresa objednávky (popsáno níže) |
OrderDeliveryAddress
| Pole | Datový typ | Popis |
|---|---|---|
name | string(510) | Jméno a příjmení nebo název firmy |
address1 | string(160) | 1. adresní řádek |
address2 | string(160) | 2. adresní řádek |
address3 | string(160) | 3. adresní řádek |
city | string(160) | Město |
zipCode | string(160) | PSČ |
country | string(160) | Země v ISO 3166-1 alpha-3 formátu |
contact | string(160) | Kontaktní osoba |
phone | string(60) | Telefonní číslo |
email | string(160) |
OrderInvoicingAddress
| Pole | Datový typ | Popis |
|---|---|---|
name | string(510) | Jméno a příjmení nebo název firmy |
address1 | string(160) | 1. adresní řádek |
address2 | string(160) | 2. adresní řádek |
address3 | string(160) | 3. adresní řádek |
city | string(160) | Město |
zipCode | string(160) | PSČ |
country | string(160) | Země v ISO 3166-1 alpha-3 formátu |
contact | string(160) | Kontaktní osoba |
phone | string(60) | Telefonní číslo |
email | string(160) |
JSON náhled
{
"id": 27,
"formNumber": "WS-2024-0042",
"transportTypeId": 0,
"paymentTypeId": 1,
"note": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
"address": {
"deliveryAddress": {
"name": "Testovací odběratel 1",
"address1": "Adresa 1",
"address2": "Adresa 2",
"address3": "Adresa 3",
"city": "Praha",
"zipCode": "32165 ",
"country": "Česko",
"contact": "",
"phone": "Kontaktní@MAIL.CZ",
"email": "654789362"
},
"invoicingAddress": {
"name": "Testovací odběratel 1",
"address1": "Fakturace Adresa 1",
"address2": "Fakturace Adersa 2",
"address3": "Fakturace Adresa 3",
"city": "Praha",
"zipCode": "123 45",
"country": "Česká republika",
"contact": "",
"phone": "",
"email": "Kontaktní@MAIL.CZ"
},
"companyIdentificationNumber": "4568132",
"vatRegistrationNumber": "CZ86168143",
"vatPayer": true,
"note": "Doručit do 15:00"
},
"items": [
{
"productCode": "6001",
"productName": "Javor",
"price": 23.4,
"priceWoVat": 19.34,
"vatRate": 21,
"productId": 10,
"barcode": "",
"quantity": 1
},
{
"productCode": "0200001",
"productName": "Buk",
"price": 1350,
"priceWoVat": 1115.7,
"vatRate": 21,
"productId": 11,
"barcode": "2000000000206",
"quantity": 1
},
{
"productCode": "0100001",
"productName": "Řezané květiny Ø",
"price": 0.9,
"priceWoVat": 0.74,
"vatRate": 21,
"productId": 21,
"barcode": "8594001020096",
"quantity": 1
},
{
"productCode": "0100004",
"productName": "Jack of all trades",
"price": 900,
"priceWoVat": 743.8,
"vatRate": 21,
"productId": 30,
"barcode": "2000000000534",
"quantity": 1
},
{
"productCode": "0300001",
"productName": "Veneček velikonoční",
"price": 0,
"priceWoVat": 0,
"vatRate": 21,
"productId": 16,
"barcode": "",
"quantity": 1
}
],
"lastModify": null,
"createdAt": "2018-08-07T16:40:18.53"
}