Manuál

Vrátí všechny objednávky daného eshopu.

Dostupné GET parametry

Parametr	Povinný	Popis
shopId	Ano	ID eshopu
id	Ne	ID objednávky
offset	Ne	Místo, od kterého budou záznamy vraceny. Výchozí = 0
limit	Ne	Počet vrácených záznamů

Ukázková odpověď

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "remote_id": "1234-5678",
            "provider_id": 1,
            "created": "2021-04-27 12:04:46",
            "state_id": 1,
            "state_text": "Přijatá",
            "customer_state_id": null,
            "customer_state_text": null,
            "invoice_firstname": "Jan",
            "invoice_surname": "Novotný",
            "invoice_street": "Ulice 123",
            "invoice_city": "Město",
            "invoice_zipcode": 12345,
            "country": "CZ",
            "invoice_company": "",
            "invoice_ico": 0,
            "invoice_dic": "",
            "contact_like_invoice": true,
            "contact_firstname": "",
            "contact_surname": "",
            "contact_street": "",
            "contact_city": "",
            "contact_zipcode": 0,
            "contact_company": null,
            "contact_ico": 0,
            "contact_dic": null,
            "price": 10189,
            "paid": false,
            "commision": 0,
            "commision_status": null,
            "device": "desktop",
            "source": null,
            "note": "",
            "basket": [
                {
                    "id": 1,
                    "price_retail_vat": 10189,
                    "quantity": 1
                }
            ],
            "payment": {
                "id": 1,
                "name": "Bankovním převodem",
                "price_vat": 0
            },
            "delivery": {
                "id": 1,
                "name": "GLS - ČR",
                "price_vat": 0
            }
        }
    ]
}            

Popis parametrů odpovědi

Parametr	Typ	Popis
id	int	ID objednávky
remote_id	string	ID objednávky dodavatele
provider_id	int	ID distributora
created	string	Datum vytvoření
state_id	int	ID stavu
state_text	string	Název stavu
customer_state_id	int|null	ID stavu zákazníka - nenulový při reklamacích
customer_state_text	string	Text stavu zákazníka
invoice_firstname	string	Křestní jméno plátce
invoice_surname	string	Příjmení plátce
invoice_street	string	Ulice plátce
invoice_city	string	Město plátce
invoice_zipcode	int	PSČ plátce
country	string	Kód země plátce
invoice_company	string	Firma plátce
invoice_ico	int	IČ plátce
invoice_dic	string	DIČ plátce
contact_like_invoice	bool	Zda jsou fakturační údaje shodné s doručovacími
contact_firstname	string	Křestní jméno adresáta
contact_surname	string	Příjmení adresáta
contact_street	string	Ulice adresáta
contact_city	string	Město adresáta
contact_zipcode	int	PSČ adresáta
contact_company	string	Firma adresáta
contact_ico	int	IČ adresáta
contact_dic	string	DIČ adresáta
price	float	Celková cena s DPH
paid	bool	Stav zaplacení
commision	float	Výše provize
commision_status	int|null	Stav provize (1 - vyřízeno)
device	string	Zařízení (desktop, tablet, phone)
source	string|null	Zdroj (např. Heureka, Google)
note	string	Poznámka
basket	OrderBasket[]	Objednané zboží
payment	OrderPayment	Platební metoda
delivery	OrderDelivery	Způsob dodání

Popis parametrů typu OrderBasket

Parametr	Typ	Popis
id	int	ID varianty produktu
price_retail_vat	float	Cena za kus včetně DPH
quantity	int	Počet kusů

Popis parametrů typu OrderPayment

Parametr	Typ	Popis
id	int	ID platební metody
name	string	Název
price_vat	float	Cena včetně DPH

Popis parametrů typu OrderDelivery

Parametr	Typ	Popis
id	int	ID způsobu dopravy
name	string	Název
price_vat	float	Cena včetně DPH