Exitshop API
https://www.exitshop.cz/api/v1
Všechny dotazy musí obsahovat hlavičku X-API-KEY s API klíčem. Ten získáte v administraci Exitshopu. V případě úspěchu vrací status 200 a výsledek v poli "result". V případě chyby vrací statusy 400, 401, 403, 405 nebo 500, popis chyby je v poli "error". Limit je 2000 požadavků pro typ akce za hodinu. Pro vytváření objednávek je limit 100 za hodinu.
/products
Slouží k naskladnění zadaného počtu produktů na určitou pozici. Pozice jsou volitelné, stejně tak nákupní cena a měna (při nezadaní se vloží výchozí, měny jsou ve formátu CZK, EUR, ...). Pohyb se uloží do historie, zboží se případně doplní do objednávek kde chybí. Nevytváří se příjemka (prozatím).
Slouží k přeskladnění zadaných kusů na novou pozici. Volitelně umí i nastavit výchozí pozici.
post /products/placements
Slouží k naskladnění zadaného počtu produktů na určitou pozici. Pozice jsou volitelné, stejně tak nákupní cena a měna (při nezadaní se vloží výchozí, měny jsou ve formátu CZK, EUR, ...). Pohyb se uloží do historie, zboží se případně doplní do objednávek kde chybí. Nevytváří se příjemka (prozatím).
Body
Media type: application/json
Type: any
Example:
{
"primary_id": 52665,
"quantity": 1,
"placement":
{
"purchase_price": 100,
"purchase_price_currency": "EUR",
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": "4A1-1-2-B",
"warehouse": null
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"inserted": 1
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Naskladnit se dá jen určitý počet kusů, přesněji mezi 1 a 5000."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Nemáte práva k úpravě tohoto produktu."
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Naskladnění se nepovedlo, chyba."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
put /products/placements
Slouží k přeskladnění zadaných kusů na novou pozici. Volitelně umí i nastavit výchozí pozici.
Body
Media type: application/json
Type: any
Example:
{
"placements":
[
{
"placement_id": "25918109",
"placement":
{
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": "4A1-1-2-B",
"warehouse": null
},
"set_as_default_position": 0
}
]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"updated": 1
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Žádné kusy k přeskladnění nezadány"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Nemáte práva k úpravě tohoto produktu."
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Naskladnění se nepovedlo, chyba."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Zadejte jedno nebo více ID mateřských produktů oddělených čárkou (případně EANů nebo názvů produktů). Vrací informace o mateřských produktech a pozice jednotlivých kusů.
get /products/placements/{XXX,YYY,ZZZ}
Zadejte jedno nebo více ID mateřských produktů oddělených čárkou (případně EANů nebo názvů produktů). Vrací informace o mateřských produktech a pozice jednotlivých kusů.
URI Parameters
- XXX,YYY,ZZZ: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
"result":
[
{
"primary_id": 52665,
"name": "Povlečení - modré XL",
"quantity": 3,
"fake_quantity": 3,
"reserved": 0,
"on_road" : 5,
"user_id": 33,
"supplier": "",
"own_id": "XYZ12",
"purchase_price": 100,
"image": "https://domena.cz/obrazek-produktu.jpg",
"default_placement": {
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": "",
"warehouse": null
},
"placement": [
{
"placement_id": 25918109,
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": null,
"warehouse": null
},
{
"placement_id": 25918110,
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": null,
},
{
"placement_id": 25918111
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "50",
"alternative": null
}
]
},
{
"primary_id": 57928,
"name": "Mobil Nokia 3310",
"quantity": 1,
"fake_quantity": 0,
"reserved": 0,
"on_road": 0,
"supplier": "Můj dodavatel",
"own_id": "",
"purchase_price": 100,
"image": "https://domena.cz/obrazek-produktu-02.jpg",
"default_placement": {
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": "",
"warehouse": null
},
"placement": [
{
"placement_id": "25918163",
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": "4A1-1-2-B",
"warehouse": 4
}
]
}
]
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Nebyly zadány žádné kódy produktů."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Produkt nebo produkty nebyly nalezeny."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Zadejte jedno nebo více ID mateřských produktů oddělených čárkou (případně EANů nebo názvů produktů). Vrací informace o mateřských produktech, seskupené podle pozic.
get /products/details/{XXX,YYY,ZZZ}
Zadejte jedno nebo více ID mateřských produktů oddělených čárkou (případně EANů nebo názvů produktů). Vrací informace o mateřských produktech, seskupené podle pozic.
URI Parameters
- XXX,YYY,ZZZ: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
"result":
[
{
"primary_id": 52665,
"name": "Povlečení - modré XL",
"quantity": 3,
"fake_quantity": 3,
"reserved": 0,
"on_road": 5,
"user_id": 33,
"supplier": "",
"own_id": "XYZ12",
"purchase_price": 100,
"image": "https://domena.cz/obrazek-produktu.jpg",
"default_placement": {
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": "",
"warehouse": null
},
"placement_grouped": [
{
"quantity": 2,
"position": "10_20_30_40"
},
{
"quantity": 1,
"position": "10_20_30_50"
}
]
},
{
"primary_id": 57928,
"name": "Mobil Nokia 3310",
"quantity": 1,
"fake_quantity": 0,
"reserved": 0,
"on_road": 0,
"supplier": "Můj dodavatel",
"own_id": "",
"purchase_price": 100,
"image": "https://domena.cz/obrazek-produktu-02.jpg",
"default_placement": {
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": "",
"warehouse": null
},
"placement_grouped": [
{
"quantity": 1,
"position": "00_00_00_00"
}
]
}
]
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Nebyly zadány žádné kódy produktů."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Produkt nebo produkty nebyly nalezeny."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Slouží k editaci zadaných produktů. Při změně názvu produktu je možno zadat parametr save_all_translations - název se propíše i do všech napárovaných produktů v jazyce upřesněném parametrem save_all_translations_lang (cs,sk,hu,pl,...). Pokud je parametr jazyku prázdný, editace se provede ve všech napárovaných produktech. Parametr custom_price zapíná / vypíná funkci "Nenastavovat automaticky prodejní ceny od dodavatele".
put /products/details
Slouží k editaci zadaných produktů. Při změně názvu produktu je možno zadat parametr save_all_translations - název se propíše i do všech napárovaných produktů v jazyce upřesněném parametrem save_all_translations_lang (cs,sk,hu,pl,...). Pokud je parametr jazyku prázdný, editace se provede ve všech napárovaných produktech. Parametr custom_price zapíná / vypíná funkci "Nenastavovat automaticky prodejní ceny od dodavatele".
Body
Media type: application/json
Type: any
Example:
{
"primaries":
[
{
"primary_id": 112,
"name": "Produktík",
"save_all_translations": true,
"save_all_translations_lang": "cs"
},
{
"primary_id": 113,
"price": 120,
"custom_price": true
}
]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"updated": 1
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Cena není validní číslo."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Nemáte práva k úpravě tohoto produktu."
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Editace se nepovedla, chyba."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vytvoří nákupní seznam (resp. více nákupních seznamů podle dodavatelů)
post /products/shopping_list
Vytvoří nákupní seznam (resp. více nákupních seznamů podle dodavatelů)
Body
Media type: application/json
Type: any
Example:
{
"placements":
[
{
"primary_id": 52665,
"quantity": 1,
"placement":
{
"purchase_price": 100,
"purchase_price_currency": "EUR",
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": null,
"warehouse": null
}
},
{
"primary_id": 52666,
"quantity": 2,
"placement":
{
"purchase_price": 50,
"AA": "10",
"BB": "20",
"CC": "30",
"DD": "40",
"alternative": "4A1-1-2-B",
"warehouse": 25
}
}
]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"shopping_lists_created": 2,
"primaries_created": 3
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Chyba požadavku...[špatná měna, matka nemá dodavatele, ... atd]"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Uživatel nenalezen"
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Vytváření nákupních seznamů se nepovedlo, chyba. (rollback)"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
/stocktaking
Vrátí seznam zboží na dané pozici ve skladu. Pozice musí mít minimálně dva znaky (AA). Může být tedy AA, AABB, AABBCC nebo plně zadaná AABBCCDD. Vrací seznam produktů, které mají odpovídající výchozí pozici. Dále seznam produktů ze skladu a rezervovaných objednávek, které mají odpovídající pozici a jejich počet - tento seznam je seskupen podle ID produktu a pozice.
get /stocktaking/whatishere/{AABBCCDD}
Vrátí seznam zboží na dané pozici ve skladu. Pozice musí mít minimálně dva znaky (AA). Může být tedy AA, AABB, AABBCC nebo plně zadaná AABBCCDD. Vrací seznam produktů, které mají odpovídající výchozí pozici. Dále seznam produktů ze skladu a rezervovaných objednávek, které mají odpovídající pozici a jejich počet - tento seznam je seskupen podle ID produktu a pozice.
URI Parameters
- AABBCCDD: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
"result": {
"default_placements": [
{
"primary_id": 1,
"name": "První mateřský produkt",
"image": "https://www.exitshop.cz/image.jpg",
"AA": "12",
"BB": "34",
"CC": "56",
"DD": "78"
}
],
"real_placements": [
{
"primary_id": 1,
"quantity": 918,
"name": "První mateřský produkt",
"image": "https://www.exitshop.cz/image2.jpg",
"AA": "12",
"BB": "34",
"CC": "56",
"DD": "78"
},
{
"primary_id": 2,
"quantity": 22,
"name": "Druhý mateřský produkt",
"image": "https://www.exitshop.cz/image3.jpg",
"AA": "12",
"BB": "34",
"CC": "56",
"DD": "78"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Pozice má nedovolený počet znaků"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vytvoří seznam produktů v sekci Inventura v ExitShop administraci.
post /stocktaking/inventory
Vytvoří seznam produktů v sekci Inventura v ExitShop administraci.
Body
Media type: application/json
Type: any
Example:
{
"name": "Inventura parfémů",
"content": [
{
"primary_id": 123,
"quantity": 10
},
{
"primary_id": 456,
"quantity": 15
}
]
}
HTTP status code 200
Vše v pořádku
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Objekt nemá požadovanou strukturu."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Produkt nebo produkty nebyly nalezeny."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
/user
Vrátí informaci o aktuálně přihlášeném uživateli (podle použitého API klíče)
get /user/detail
Vrátí informaci o aktuálně přihlášeném uživateli (podle použitého API klíče)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
"result": {
"user":
{
"id": 99,
"email": "test@exitshop.cz",
"name": "Testovací účet"
}
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Uživatel nenalezen, chyba."
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
/statuses
Vrátí seznam stavů objednávek (podle použitého API klíče)
get /statuses/all
Vrátí seznam stavů objednávek (podle použitého API klíče)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
"result": {
"statuses": [
{
"id": "123",
"name": "Zabalit",
"color": "e322e3",
"storno": "0",
"return_goods": "0",
"storno_without_returning": "0"
},
{
"id": "456",
"name": "Storno",
"color": "000000",
"storno": "1",
"return_goods": "0",
"storno_without_returning": "0"
}
]
}
HTTP status code 500
Body
Media type: application/json
Type: any
Example:
{
"error": "Stav objednávky nenalezen"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
/orders
Naplánuje změnu stavu objednávky. Změna samotná pak proběhne během 1-2 minuty. Pokud použijete parametr fast, změna se provede ihned (dotaz bude trvat déle).
post /orders/change_status/{ORDER_NUMBER}/{STATUS_ID}
Naplánuje změnu stavu objednávky. Změna samotná pak proběhne během 1-2 minuty. Pokud použijete parametr fast, změna se provede ihned (dotaz bude trvat déle).
URI Parameters
- ORDER_NUMBER: required(string)
- STATUS_ID: required(string)
Body
Media type: application/json
Type: any
Example:
{
"options": {
"fast": true,
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"ok": 1
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Stav objednávky nenalezen / Objednávka nenalezena"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Odešle objednávku prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL a Česká pošta; v případě GLS použijte rovnou get_label_raw).
post /orders/send_packet/{ORDER_NUMBER}
Odešle objednávku prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL a Česká pošta; v případě GLS použijte rovnou get_label_raw).
URI Parameters
- ORDER_NUMBER: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"order_number": 12345678,
"message": "Balík byl nahrán"
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Nepodporovaný dopravce / Jiná chyba"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Objednávka nenalezena / Uživatel nenalezen"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vrací PDF štítek (A6) prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL, a Česká pošta).
get /orders/get_label/{ORDER_NUMBER}
Vrací PDF štítek (A6) prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL, a Česká pošta).
URI Parameters
- ORDER_NUMBER: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"order_number": 12345678,
"pdf": "Base64 zakódované PDF"
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Nepodporovaný dopravce / Jiná chyba"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Objednávka nenalezena / Uživatel nenalezen"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vrací URI s protokolem exitshop: obsahující štítek pro tiskárny Citizen nebo Zebra (aktuálně je podporována Zásilkovna, DPD, PPL, GLS a Česká pošta). Pokud máte nainstalovaný Exitshop Print a tiskárnu, tak tiskne přímo bez nutnosti otevírat PDF.
get /orders/get_label_raw/{ORDER_NUMBER}
Vrací URI s protokolem exitshop: obsahující štítek pro tiskárny Citizen nebo Zebra (aktuálně je podporována Zásilkovna, DPD, PPL, GLS a Česká pošta). Pokud máte nainstalovaný Exitshop Print a tiskárnu, tak tiskne přímo bez nutnosti otevírat PDF.
URI Parameters
- ORDER_NUMBER: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"order_number": 12345678,
"uri": "exitshop:ABCDEFGHIJKLMN"
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Nepodporovaný dopravce / Jiná chyba"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Objednávka nenalezena / Uživatel nenalezen"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vrací seznam objednávek podle zadaných query parametrů.
get /orders/details
Vrací seznam objednávek podle zadaných query parametrů.
Query Parameters
- page: (int)
Číslo stránky (výchozí 0)
Example:
0 - per_page: (int)
Počet objednávek na stránku (výchozí 10, max 1000)
Example:
10 - date_from: (string)
Datum faktury od (výchozí - neomezovat)
Example:
2020-01-01 - date_to: (string)
Datum faktury do (výchozí - neomezovat)
Example:
2020-01-01 - invoice: (bool)
Vrátit jen objednávky s fakturou?
Example:
true - number: (int)
Číslo objednávky
Example:
2101010001 - tracking_number: (string)
Sledovací číslo objednávky (minimálně 5 znaků).
Example:
Z123456789 - status_id: (int)
ID stavu objednávky
Example:
12345
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"total": 2,
"used_filters": {
"page": 0,
"per_page": 10,
"facture_date_from": "2020-06-12",
"facture_date_to": null
},
"invoices": [
{
"number": 20000253,
"currency": "Kč",
"country": "CZ",
"order_date": "2020-06-16 11:00:27",
"invoice_date": "2020-06-16 00:00:00",
"pdf_link": "https://www.exitshop.cz/objednavky/faktura/2334846/false/false/748230e7a328e9272c51158dc8e090df4efceaf1",
"customer": {
"name": "Jan Novák",
"street": "Testovní 7",
"city": "Praha",
"zip": "10000",
"ic": null,
"dic": null,
"phone": "999999999",
"email": "jan@centrum.cz"
},
"seller": {
"name": "Velkobaron Podnikatel",
"street": "Měcholupská 88",
"city": "Praha",
"zip": "12000",
"ic": "12345678",
"dic": "CZ12345678",
"phone": "777666555",
"email": "test@user.cz"
},
"goods": [
{
"id": 57928,
"primary_id": 57928,
"quantity": 1,
"price": "20",
"name": "Ukázkový produkt 1",
"primary_name": "Název mateřského produktu",
"vat": "21",
"own_id": null,
"barcodes": "123456789,987654321",
"image": "https://www.exitshop.cz/url-obrazku-360-px.jpg",
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": null,
"warehouse": null,
"is_service": false,
"dispatchable": true
},
{
"id": 61991,
"primary_id": 61991,
"quantity": 1,
"price": "48",
"name": "Ukázkový produkt 2 - doplňková služba",
"primary_name": null,
"vat": "20",
"own_id": "ahoj",
"barcodes": "",
"image": "https://www.exitshop.cz/url-obrazku-360-px.jpg",
"AA": "0",
"BB": "0",
"CC": "0",
"DD": "0",
"alternative": null,
"warehouse": null,
"is_service": true,
"dispatchable": false
}
]
},
{
"number": 20000249,
"currency": "€",
"country": "SK",
"order_date": "2020-06-10 11:49:06",
"invoice_date": "2020-06-12 00:00:00",
"pdf_link": "https://www.exitshop.cz/objednavky/faktura/2334846/false/false/748230e7a328e9272c51158dc8e090df4efceaf2",
"customer": {
"name": "Honza Novotný",
"street": "Testovací 123",
"city": "Balls",
"zip": "11000",
"ic": null,
"dic": null,
"phone": "999999999",
"email": "honza@centrum.cz"
},
"seller": {
"name": "Velkobaron Podnikatel",
"street": "Měcholupská 88",
"city": "Praha",
"zip": "12000",
"ic": "12345678",
"dic": "SK12345678",
"phone": "777666555",
"email": "test@user.cz"
},
"goods": [
{
"id": 3996331,
"primary_id": 57928,
"quantity": 1,
"price": "1",
"name": "Ukázkový produkt 3",
"primary_name": "Název mateřského produktu",
"vat": "21",
"own_id": null,
"AA": "1",
"BB": "2",
"CC": "30",
"DD": "40",
"alternative": "cokoli",
"warehouse": null,
"is_service": false,
"dispatchable": true
}
]
}
]
}
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Vytvoří objednávku.
Položky shop_id, primary_id, shipping_id musí odpovídat existujícím položkám v Exitshopu. Internal_id je vaše označení objednávky, musí být vždy unikátní.
Ceny jsou včetně DPH.
Položky branch_* vyplňujte jen tehdy, když se jedná o objednávku na výdejní místo. Aktuálně je přes API možno přenášet jen pobočky Zásilkovny (branch_type = "ZAS").
Poznámka a fakturační adresa jsou nepovinné položky
post /orders/create
Vytvoří objednávku.
Položky shop_id, primary_id, shipping_id musí odpovídat existujícím položkám v Exitshopu. Internal_id je vaše označení objednávky, musí být vždy unikátní.
Ceny jsou včetně DPH.
Položky branch_* vyplňujte jen tehdy, když se jedná o objednávku na výdejní místo. Aktuálně je přes API možno přenášet jen pobočky Zásilkovny (branch_type = "ZAS").
Poznámka a fakturační adresa jsou nepovinné položky
Body
Media type: application/json
Type: any
Example:
{
"order": {
"internal_id": 1234567,
"shop_id": 2,
"shipping_address": {
"email": "muj@email.cz",
"phone": "608 608 608",
"name": "Jan Novák",
"street": "Vinohradská 90",
"city": "Praha",
"zip": "120 00"
},
"invoice_address": {
"email": "firemni@email.cz",
"phone": "999 608 608",
"name": "Exitshop",
"street": "Vinohradská 91",
"city": "Praha",
"zip": "120 00",
"ic": "12345678",
"dic": "CZ123456789"
},
"shipping": {
"shipping_id": 1,
"price": 100,
"branch_type": "ZAS",
"branch_id": 12345,
"branch_name": "Zásilkovna - Krůtí prodejna, Liptákov"
},
"items": [
{
"primary_id": 1,
"quantity": 1,
"price": 150,
"name": "Hezký produkt 1"
},
{
"primary_id": 2,
"quantity": 2,
"price": 250,
"name": "Hezký produkt 2"
}
],
"note": "Prosím o brzké dodání"
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"result":
{
"order_number": 12345678,
"message": "Objednávka vytvořena"
}
}
HTTP status code 400
Body
Media type: application/json
Type: any
Example:
{
"error": "Jiná chyba v těle požadavku"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{
"error": "Uživatel nenalezen"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
Přiřadí pickovací košíky k objednávkám, podle čísla objednávek.
Zruší přiřazení košíkům ke všem objednávkám zaměstnance.
put /orders/dispatch
Přiřadí pickovací košíky k objednávkám, podle čísla objednávek.
Body
Media type: application/json
Type: any
Example:
{
"orders": [
2301011234,
2301011235
]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"orders": [
{
"cart": "A03",
"order_number": 2301011234
},
{
"cart": "A04",
"order_number": 2301011235
}
]
}
HTTP status code 409
Body
Media type: application/json
Type: any
Example:
{
"error": "Objednávky jsou již v košících (1123000229 - A01, 1123000230 - A02)"
}
HTTP status code 428
Body
Media type: application/json
Type: any
Example:
{
"error": "Chybí volné košíky (2)"
}
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d
delete /orders/dispatch
Zruší přiřazení košíkům ke všem objednávkám zaměstnance.
Secured by X-API-KEY
Headers
- X-API-KEY: required(string)
API klíč získáte v administraci Exitshopu
Example:
X-API-KEY: 816179965fb9b95593abb31614628392c9e1b05d