API Dokumentace | Dropshipping.cz

Obchody

GET /eshops

Popis:

seznam vašich aktivních obchodů

Úplná adresa:

https://client.api.dropshipping.cz/v1/eshops

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/eshops HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Můj obchod",
            "www": "http://www.mujobchod.cz",
            "product_xml": "https://www.dropshipping.cz/.../",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID obchodu
`name`	`string`	Název obchodu
`www`	`string`	WWW obchodu
`product_xml`	`string`	URL XML zdroje produktů vašeho obchodu

Produkty

GET /products

Popis:

seznam aktivních produktů vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/products?eshop_id=1&limit=30&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/products?eshop_id=1&limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	ANO	ID obchodu
`id`	`int`	NE	ID produktu (pro zobrazení konretního produktu)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30. Maximální hodnota je neomezená.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "group_id": 1,
            "manufacturer_id": 1,
            "name": "Plavky AF (červené + černá) - L 90-100 cm",
            "product_name": "Plavky AF (červené + černá)",
            "variant_name": "L 90-100 cm",
            "description": "...",
            "description_html": "...",
            "code": "DS46689145",
            "ext_code": "DZ411",
            "ean": "1010121353001",
            "price_retail": 185.95,
            "price_retail_vat": 214,
            "price_wholesale": 121.49,
            "price_wholesale_vat": 146,
            "minimal_price_retail": 185.95,
            "minimal_price_retail_vat": 214,
            "vat": 21,
            "clearance": true,
            "warehouse_quantity": 1,
            "delivery_date": 0,
            "inhouse_quantity": 0,
            "partner_quantity": 1,
            "partner_delivery_date": 0,
            "preview_image": "http://www.eshop.cz/img/9841.jpg",
            "categories": ["1","2"],
            "images": [
                "http://www.eshop.cz/img/9841.jpg",
                "http://www.eshop.cz/img/9842.jpg",
                "http://www.eshop.cz/img/9843.jpg",
            ],
            "parameters": [
                {
                    id: 1,
                    key: "color",
                    value: "černá",
                },
                {
                    id: 2,
                    key: "size",
                    value: "XL",
                },
            ],
            "special_delivery_prices": [
                {
                    delivery_id: 13,
                    type: "atyp",
                }
            ],
            "blacklisted_delivery_ids": [10,14,24]
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID produktu
`group_id`	`int\|null`	Označení skupiny produktů, které vzájemně představují varianty. Pokud je hodnota null, produkt nemá žádné varianty.
`manufacturer_id`	`int\|null`	ID výrobce produktu. Pokud je hodnota null, výrobce je neznámý.
`name`	`string`	Název produktu včetně názvu varianty (oddělené "-")
`product_name`	`string`	Název produktu bez varianty
`variant_name`	`string`	Název varianty
`description`	`string`	Popis produktu
`description_html`	`string`	HTML popis produktu
`code`	`string`	Kód produktu v systému Dropshipping.cz
`ext_code`	`string`	Kód produktu dodavatele
`ean`	`string\|null`	EAN produktu. Pokud je hodnota null, EAN je neznámý.
`price_retail`	`float`	Maloobchodní cena bez DPH
`price_retail_vat`	`float`	Maloobchodní cena s DPH
`minimal_price_retail`	`float`	Minimální maloobchodní cena bez DPH
`minimal_price_retail_vat`	`float`	Minimální maloobchodní cena s DPH
`price_wholesale`	`float`	Velkooobchodní cena bez DPH
`price_wholesale_vat`	`float`	Velkooobchodní cena s DPH
`vat`	`int`	DPH
`clearance`	`bool`	Likvidace
`warehouse_quantity`	`int\|null`	Počet kusů skladem. Pokud je hodnota neznámá, vrací null.
`delivery_date`	`int\|null`	Dodací doba produktu ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`inhouse_quantity`	`int`	Počet kusů na skladech interních dropshipping.cz.
`partner_quantity`	`int\|null`	Počet kusů skladem u dodavatele. Pokud je hodnota neznámá, vrací null.
`partner_delivery_date`	`int\|null`	Dodací doba produktu u dodavatele ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`preview_image`	`string`	Celá adresa náhledového obrázku
`categories`	`array`	Pole ID kategorií
`images`	`array`	Pole URL všech obrázků
`parameters`	`array`	Pole parametrů produktů.
`special_delivery_prices`	`array`	Pole doručovacích metod, pro které má produkt nestandartní cenu ("atyp" nebo "oversized", viz sekce Doručovací metody).
`blacklisted_delivery_ids`	`array`	Pole ID doručovacích metod, kterými nelze produkt zákazníkovi odeslat.

Produkty - skladovost

POST /products/inventory

Popis:

skladovost produktů (variant)

Úplná adresa:

https://client.api.dropshipping.cz/v1/products/inventory

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/products/inventory HTTP/1.1
Authorization: TOKEN
Accept: application/json

{
    "ids": [1,2,3]
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`ids`	`array`	ANO	Pole ID produktů (variant)

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "code": "code",
            "warehouse_quantity": 99,
            "delivery_date": 0,
            "inhouse_quantity": 99,
            "partner_quantity": NULL,
            "partner_delivery_date": 7,
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`warehouse_quantity`	`int\|null`	Počet kusů skladem. Pokud je hodnota neznámá, vrací null.
`delivery_date`	`int\|null`	Dodací doba produktu ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`inhouse_quantity`	`int`	Počet kusů na skladech interních dropshipping.cz.
`partner_quantity`	`int\|null`	Počet kusů skladem u dodavatele. Pokud je hodnota neznámá, vrací null.
`partner_delivery_date`	`int\|null`	Dodací doba produktu u dodavatele ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.

Produkty - kategorie

GET /products/categories

Popis:

seznam aktivních kategorií produktů vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/products/categories?eshop_id=1

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/products/categories?eshop_id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	ANO	ID obchodu
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultně se vypisují všechny kategorie.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "parent": 0,
            "name": "Pánské oblečení"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID kategorie
`parent`	`int`	ID nadřazené kategorie. Nejvyšší stupeň kategorií je zapsán jako parent = 0.
`name`	`string`	Název kategorie

Produkty - výrobci

GET /products/manufacturers

Popis:

seznam výrobců produktů vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/products/manufacturers?eshop_id=1

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/products/manufacturers?eshop_id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	ANO	ID obchodu
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Nike"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID
`name`	`string`	Název

Produkty - parametry

GET /products/parameters

Popis:

seznam parametrů produktů vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/products/parameters?eshop_id=1

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/products/parameters?eshop_id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	ANO	ID obchodu
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "key": "color",
            "name": "Barva"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID
`key`	`string`	Textový, unikátní identifikátor
`name`	`string`	Název

Platební metody

GET /payments

Popis:

seznam aktivních platebních metod vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/payments?eshop_id=1

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/payments?eshop_id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	Podm.	ID obchodu. Nepovinné pokud je uveden parametr partner_id.
`partner_id`	`int`	Podm.	ID dodavatele. Nepovinné pokud je uveden parametr eshop_id.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Hotově",
            "price": 87.23,
            "price_vat": 89,
            "vat": 21,
            "permitted_delivery": ["1","2"]
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID platební metody
`name`	`string`	Název
`price`	`float`	Cena bez DPH
`price_vat`	`float`	Cena s DPH
`vat_id`	`int`	DPH
`permitted_delivery[]`	`array`	Pole povolených ID kombinací doručovacích metod

Doručovací metody

GET /deliveries

Popis:

seznam aktivních doručovacích metod vašeho obchodu

Úplná adresa:

https://client.api.dropshipping.cz/v1/deliveries?eshop_id=1

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/deliveries?eshop_id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	Podm.	ID obchodu. Nepovinné pokud je uveden parametr partner_id.
`partner_id`	`int`	Podm.	ID dodavatele. Nepovinné pokud je uveden parametr eshop_id.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Česká pošta",
            "price": 87.23,
            "price_vat": 89,
            "price_atyp": null,
            "price_atyp_vat": null,
            "price_oversized": null,
            "price_oversized_vat": null,
            "vat": 21,
            "has_place": 1,
            "permitted_payment": ["1","2"]
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID doručovací metody
`name`	`string`	Název
`price`	`float`	Cena bez DPH
`price_vat`	`float`	Cena s DPH
`price_atyp`	`float\|NULL`	Speciální cena bez DPH za produkty, označené jako "atyp"
`price_atyp_vat`	`float\|NULL`	Speciální cena s DPH za produkty, označené jako "atyp"
`price_oversized`	`float\|NULL`	Speciální cena bez DPH za produkty, označené jako "oversized"
`price_oversized_vat`	`float\|NULL`	Speciální cena s DPH za produkty, označené jako "oversized"
`vat_id`	`int`	DPH
`has_place`	`int`	Údaj o tom, jestli konkrétní způsob dopravy vyžaduje zaslání odběrného místa (0 = NE; 1 = ANO). Viz také "Doručovací metody - odběrné místa"
`permitted_delivery[]`	`array`	Seznam povolených ID kombinací platebních metod

Doručovací metody - odběrné místa

GET /delivery-places

Popis:

seznam aktivních odběrných míst konkrétní doručovací metody

Úplná adresa:

https://client.api.dropshipping.cz/v1/delivery-places?delivery_id=1&limit=30&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/delivery-places?delivery_id=1&limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`delivery_id`	`int`	ANO	ID doručovací metody
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30. Maximální hodnota je neomezená.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

Zasilkovna.cz (delivery_id: 10)

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "ext_id": 321,
            "place": "Zásilkovna s.r.o.",
            "street": "Vltavská 277/28",
            "city": "Praha",
            "zipcode": "150 00",
            "region_name": "Hlavní město Praha",
            "lat": "50.06980",
            "lon": "14.40607",
            "url": "http://www.zasilkovna.cz/point/praha-5-andel",
            "note": "",
            "direction": "Pobočka se nachází na v Praze na Smíchově 50 m od autobusového nádraží Na Knížecí.",
            "direction_car": "před pobočkou nelze parkovat. Je možné zaparkovat v ulicích Jindřich Plachty, nebo Staropramenná, jsou však dost plné. Jistější je zaparkovat v podzemních garážích pod Albertem - vjezd z ulice Bozděchova (200m), nebo na hlídaném parkovišti vedle polikliniky - vjezd z ulice Stroupežnického (200m), nebo na hlídaném parkovišti vedle aut. nádraží - vjezd z ulice Za ženskými domovy (200m)",
            "direction_public": "Pobočka se nachází 200m od východu z metra Anděl - Výstup na Knížecí",
            "opening_hour_short_html": "<strong>Po–Pá</strong> 10:00–19:00<br /><strong>So</strong> 10:00–15:00</span>",
            "opening_hour_table_html": "<table class="packetery-hours"><tr><th>Po</th><td>10:00–19:00</td></tr><tr><th>Út</th><td>10:00–19:00</td></tr><tr><th>St</th><td>10:00–19:00</td></tr><tr><th>Čt</th><td>10:00–19:00</td></tr><tr><th>Pá</th><td>10:00–19:00</td></tr><tr><th>So</th><td>10:00–15:00</td></tr><tr><th>Ne</th><td></td></tr></table>",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID odběrného místa (v systému dropshipping.cz)
`ext_id`	`int`	ID odběrného místa externí služby (ze systému provozovatele)
`place`	`string`	Název konkrétní pobočky
`street`	`string`	Ulice
`city`	`string`	Město
`zipcode`	`string`	PSČ
`region_name`	`string`	Kraj
`lat`	`string`	GPS souřadnice latitude
`lon`	`string`	GPS souřadnice longitude
`url`	`string`	URL adresa detailu pobočky na stránkách zasilkovna.cz
`note`	`string`	Poznámka
`direction`	`string`	Popis polohy pobočky
`direction_car`	`string`	Popis k nalezení pobočky autem
`direction_public`	`string`	Popis k nalezení pobočky pěšky
`opening_hour_short_html`	`string`	HTML tabulka otevíracích hodin, zkrácená
`opening_hour_table_html`	`string`	HTML tabulka otevíracích hodin

Stavy objednávek

GET /order-statuses

Popis:

seznam všech stavů objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/order-statuses

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/order-statuses HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Příjatá",
            "active": true,
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID stavu
`name`	`string`	Název stavu
`active`	`bool`	Jedná se o aktivní stav?

Popis:

seznam vašich objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/orders?eshop_id=1&limit=30&offset=0&sort=-created

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/orders?eshop_id=1&limit=30&offset=0&sort=-created HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`eshop_id`	`int`	NE	ID obchodu (pro zobrazení objednávek konkrétního obchodu)
`id`	`int`	NE	ID objednávky (pro zobrazení konkrétní objednávky)
`serial_number`	`string`	NE	Číslo objednávky
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30. Maximální hodnota = 100.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=created" = "created ASC"; "sort=-created" = "created DESC"). Defaultní řazení je "id ASC".
`created_from`	`string`	NE	Určuje datum, od kterého se mají objednávky vyhledat. Formát yyyy-mm-dd (např. 2017-01-01).
`created_to`	`string`	NE	Určuje datum, do kterého se mají objednávky vyhledat. Formát yyyy-mm-dd (např. 2017-01-01).
`remote_id`	`string`	NE	ID objednávky z Vašeho systému

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "remote_id": "123456789",
            "eshop_id": 1,
            "status_id": 1,
            "serial_number": "1-0002",
            "variable_symbol": ""1-0002"",
            "email": "jan.novak@gmail.com",
            "phone": "777 777 777",
            "invoice_firstname": "Jan",
            "invoice_surname": "Novák",
            "invoice_street": "Korunní 21",
            "invoice_city": "Praha 2",
            "invoice_zipcode": "128 00",
            "invoice_company": "Jan Novak",
            "invoice_ico": "123456",
            "invoice_dic": "654321",
            "contact_like_invoice": "0",
            "contact_firstname": "Jana",
            "contact_surname": "Nováková",
            "contact_street": "Vinohradská 47",
            "contact_city": "Praha 2",
            "contact_zipcode": "128 00",
            "contact_company": "Jan Novak",
            "contact_ico": "123456",
            "contact_dic": "654321",
            "note": "",
            "paid": true,
            "commision_status": 1,
            "commision": 54.90,
            "balance": 14.90,
            "payment": {
                "id": 1,
                "name": Dobírka,
                "price": 64.95,
                "price_vat": 79,
                "gateway_link": "https://www.platbaobjednavky.cz/zaplatit/rk7nq9xkq53ecr1moix0imc8u54hvf0gekmkjekg31oij8ju4icutmo5e8kf66rb",
                "qr_code": "https://www.dropshipping.cz/api/open/order/v4ij79tvrnyb0ms4yslz0ttfaom0ykf1xs1v5hp9jcylafah4nz60fy93lw8fhvv/qr-payment.png",
            },
            "delivery": {
                "id": 1,
                "name": Intime,
                "price": 64.95,
                "price_vat": 79,
            },
            "tracking": {
                "number": Z1051590747,
                "link": http://www.zasilkovna.cz/vyhledavani?id=Z1051590747,
            },
            "proforma_invoice": {
                "link": https://www.dropshipping.cz/...,
            },
            "invoice": {
                "link": https://www.dropshipping.cz/...,
            },
            "basket": [
                {
                    "id": 1,
                    "name": 3D kreslená kabelka,
                    "code": 1-ZS190,
                    "price_retail": 338.84,
                    "price_retail_vat": 410,
                    "quantity": 9,
                    "reserved_quantity": 8,
                    "note": zelená varianta,
                }
            ],
            "inserts": [
                {
                    "id": 1,
                    "name": 3D kreslená kabelka,
                    "code": 1-ZS190,
                    "quantity": 9,
                }
            ],
            "created": "2015-04-04 16:30:19",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID objednávky
`remote_id`	`string (36)\|NULL`	Unikátní identifikátor z Vašeho systému. Např. číslo objednávky.
`eshop_id`	`int`	ID vašeho obchodu
`status_id`	`int`	ID stavu objednávky
`serial_number`	`string`	Číslo objednávky
`variable_symbol`	`string`	Variabilní symbol
`email`	`string`	E-mail zákazníka
`phone`	`string`	Telefon zákazníka
`invoice_firstname`	`string`	Fakturační jméno zákazníka
`invoice_surname`	`string`	Fakturační příjmení zákazníka
`invoice_street`	`string`	Fakturační ulice zákazníka
`invoice_city`	`string`	Fakturační město zákazníka
`invoice_zipcode`	`string`	Fakturační PSČ zákazníka
`invoice_company`	`string`	Fakturační společnost zákazníka
`invoice_ico`	`string`	Fakturační IČO zákazníka
`invoice_dic`	`string`	Fakturační DIČ zákazníka
`contact_like_invoice`	`int`	Doručovací adresa stejná jako fakturační (0 = NE; 1 = ANO)
`contact_firstname`	`string`	Doručovací jméno zákazníka
`contact_surname`	`string`	Doručovací příjmení zákazníka
`contact_street`	`string`	Doručovací ulice zákazníka
`contact_city`	`string`	Doručovací město zákazníka
`contact_zipcode`	`string`	Doručovací PSČ zákazníka
`contact_company`	`string`	Doručovací společnost zákazníka
`contact_ico`	`string`	Doručovací IČO zákazníka
`contact_dic`	`string`	Doručovací DIČ zákazníka
`note`	`string`	Poznámka k objednávce
`paid`	`bool`	Je objednávka zaplacená?
`commision_status`	`int\|NULL`	Je schválena provize za objednávku? (null = provize čeká na schválení; 0 = provize byla zamítnuta; 1 = provize byla schválena)
`commision`	`float`	Potencionální, čistá, provize z objednávky
`balance`	`float`	Aktuální součet zisků a ztrát objednávky
`payment`	`array`	Platební metoda
`delivery`	`array`	Doručovací metoda
`tracking`	`array\|NULL`	Sledovací číslo a odkaz na stav zásilky
`proforma_invoice`	`array`	Odkaz pro stažení zálohové faktury
`invoice`	`array\|NULL`	Odkaz pro stažení faktury
`basket`	`array`	Pole produktů v košíku
`inserts`	`array`	Pole insertů
`created`	`string`	Datum a čas vytvoření objednávky (Y-m-d H:i:s)

Popis:

vkládání objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/orders

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/orders HTTP/1.1
Authorization: TOKEN
Accept: application/json

{
    "remote_id": "123456789",
    "auto_resend": 1,
    "eshop_id": 1,
    "email": "jan.novak@gmail.com",
    "phone": "777 777 777",
    "invoice_firstname": "Jan",
    "invoice_surname": "Novák",
    "invoice_street": "Korunní 21",
    "invoice_city": "Praha 2",
    "invoice_zipcode": "128 00",
    "invoice_company": "Jan Novak",
    "invoice_ico": "123456",
    "invoice_dic": "654321",
    "contact_like_invoice": "0",
    "contact_firstname": "Jana",
    "contact_surname": "Nováková",
    "contact_street": "Vinohradská 47",
    "contact_city": "Praha 2",
    "contact_zipcode": "128 00",
    "contact_company": "Jan Novak",
    "contact_ico": "123456",
    "contact_dic": "654321",
    "zpl_note": "Pro nejlepšího dědu",
    "note": "",
    "payment_id": "",
    "payment_price_vat": "",
    "delivery_id": "",
    "delivery_price_vat": "",
    "delivery_place_id": 1,
    "delivery_place_ext_id": NULL,
    "basket": [
        {
            "id": 1,
            "code": "DS12345678",
            "price_retail_vat": 123.00,
            "quantity": 3,
            "note": "zelená varianta",
        }
    ],
    "inserts": [
        {
            "id": 1,
            "code": "DS12345678",
            "quantity": 3,
        }
    ],
    "test": "0",
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`remote_id`	`string (36)\|NULL`	NE	Unikátní identifikátor z Vašeho systému. Např. číslo objednávky. Použitím tohoto paremetru zamezíte vzniku duplicitních objednávek.
`auto_resend`	`int\|NULL`	NE	Má se objednávka poslat dále ke zpracování nebo má čekat na Vaše potvrzení? Pokud nebude parametr uveden, objednávka bude vždy automaticky poslána ke zpracování. (0 = NE; 1 = ANO)
`eshop_id`	`int`	ANO	ID vašeho obchodu
`email`	`string`	ANO	E-mail zákazníka
`phone`	`string`	ANO	Telefon zákazníka
`invoice_firstname`	`string`	ANO	Fakturační jméno zákazníka
`invoice_surname`	`string`	ANO	Fakturační příjmení zákazníka
`invoice_street`	`string`	ANO	Fakturační ulice zákazníka
`invoice_city`	`string`	ANO	Fakturační město zákazníka
`invoice_zipcode`	`string`	ANO	Fakturační PSČ zákazníka
`invoice_company`	`string`	NE	Fakturační společnost zákazníka
`invoice_ico`	`string`	NE	Fakturační IČO zákazníka
`invoice_dic`	`string`	NE	Fakturační DIČ zákazníka
`contact_like_invoice`	`int`	ANO	Doručovací adresa stejná jako fakturační (0 = NE; 1 = ANO)
`contact_firstname`	`string`	NE	Doručovací jméno zákazníka
`contact_surname`	`string`	NE	Doručovací příjmení zákazníka
`contact_street`	`string`	NE	Doručovací ulice zákazníka
`contact_city`	`string`	NE	Doručovací město zákazníka
`contact_zipcode`	`string`	NE	Doručovací PSČ zákazníka
`contact_company`	`string`	NE	Doručovací společnost zákazníka
`contact_ico`	`string`	NE	Doručovací IČO zákazníka
`contact_dic`	`string`	NE	Doručovací DIČ zákazníka
`note`	`string`	NE	Poznámka k objednávce
`zpl_note`	`string\|NULL`	NE	Poznámka na balík s maximálním počtem 23 znaků. Pokud bude parametr vynechán nebo NULL, bude použita defaultní poznámka nastavená u obchodu.
`payment_id`	`int`	ANO	ID aktivní platební metody partnera
`payment_price_vat`	`float`	ANO	Cena platební metody s DPH
`delivery_id`	`int`	ANO	ID aktivní doručovací metody partnera
`delivery_place_id`¹	`int\|NULL`	NE	ID odběrného místa (ze systému dropshipping.cz). Viz Doručovací metody - odběrné místa
`delivery_place_ext_id`¹	`int\|NULL`	NE	ID odběrného místa (z externí služby, například zasilkovna.cz).
`delivery_price_vat`	`float`	ANO	Cena doručovací metody s DPH
`basket`	`array`	ANO	pole produktů v košíku
`basket.id`	`int`	Podm.	ID aktivního produktu dodavatele. Nepovinné, pokud je uveden kód produktu
`basket.code`	`string`	Podm.	Kód aktivního produktu dodavatele. Nepovinné, pokud je uvedeno ID produktu
`basket.price_retail_vat`	`float`	ANO	Cena produktu s DPH
`basket.quantity`	`int`	ANO	Počet kusů produktu
`basket.note`	`string`	NE	Poznámka konkrétního produktu
`inserts`	`array`	NE	pole insertů objednávky
`inserts.id`	`int`	Podm.	ID aktivního produktu. Nepovinné, pokud je uveden kód produktu
`inserts.code`	`string`	Podm.	Kód aktivního produktu. Nepovinné, pokud je uvedeno ID produktu
`inserts.quantity`	`int`	ANO	Počet kusů insertu
`test`	`int`	NE	Testovací objednávka. V případě označení objednávky jako testovací ("test": "1"), nebude objednávka předána dodavateli.

¹ pro vložení odběrného místa můžete použít buď ID z naší databáze, nebo ID z databáze poskytovatele služby. Objednávka bude přijata i v případě, že žádná ID nepošlete, i když to konkrétní způsob dopravy vyžaduje. V tomto případě ale nebude objednávka předána dále dodavateli a klient bude vyzván k doplnění tohoto místa v administraci.

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "id": 1,
    "eshop_id": 1,
    "serial_number": "1-0002",
    "variable_symbol": ""1-0002"",
    "email": "jan.novak@gmail.com",
    "phone": "777 777 777",
    "invoice_firstname": "Jan",
    "invoice_surname": "Novák",
    "invoice_street": "Korunní 21",
    "invoice_city": "Praha 2",
    "invoice_zipcode": "128 00",
    "invoice_company": "Jan Novak",
    "invoice_ico": "123456",
    "invoice_dic": "654321",
    "contact_like_invoice": "0",
    "contact_firstname": "Jana",
    "contact_surname": "Nováková",
    "contact_street": "Vinohradská 47",
    "contact_city": "Praha 2",
    "contact_zipcode": "128 00",
    "contact_company": "Jan Novak",
    "contact_ico": "123456",
    "contact_dic": "654321",
    "note": "",
    "payment": {
        "id": 1,
        "name": Dobírka,
        "price": 64.95,
        "price_vat": 79,
        "gateway_link": "https://www.platbaobjednavky.cz/zaplatit/rk7nq9xkq53ecr1moix0imc8u54hvf0gekmkjekg31oij8ju4icutmo5e8kf66rb",
        "qr_code": "https://www.dropshipping.cz/api/open/order/v4ij79tvrnyb0ms4yslz0ttfaom0ykf1xs1v5hp9jcylafah4nz60fy93lw8fhvv/qr-payment.png",
    },
    "delivery": {
        "id": 1,
        "name": Intime,
        "price": 64.95,
        "price_vat": 79,
    },
    "basket": [
        {
            "id": 1,
            "name": 3D kreslená kabelka,
            "code": 1-ZS190,
            "price_retail": 338.84,
            "price_retail_vat": 410,
            "quantity": 9,
        }
    ],
    "inserts": [
        {
            "id": 1,
            "name": 3D kreslená kabelka,
            "code": 1-ZS190,
            "quantity": 9,
        }
    ],
    "created": "2015-04-04 16:30:19",
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID objednávky
`eshop_id`	`int`	ID vašeho obchodu
`serial_number`	`string`	Číslo objednávky
`variable_symbol`	`string`	Variabilní symbol
`email`	`string`	E-mail zákazníka
`phone`	`string`	Telefon zákazníka
`invoice_firstname`	`string`	Fakturační jméno zákazníka
`invoice_surname`	`string`	Fakturační příjmení zákazníka
`invoice_street`	`string`	Fakturační ulice zákazníka
`invoice_city`	`string`	Fakturační město zákazníka
`invoice_zipcode`	`string`	Fakturační PSČ zákazníka
`invoice_company`	`string`	Fakturační společnost zákazníka
`invoice_ico`	`string`	Fakturační IČO zákazníka
`invoice_dic`	`string`	Fakturační DIČ zákazníka
`contact_like_invoice`	`int`	Doručovací adresa stejná jako fakturační (0 = NE; 1 = ANO)
`contact_firstname`	`string`	Doručovací jméno zákazníka
`contact_surname`	`string`	Doručovací příjmení zákazníka
`contact_street`	`string`	Doručovací ulice zákazníka
`contact_city`	`string`	Doručovací město zákazníka
`contact_zipcode`	`string`	Doručovací PSČ zákazníka
`contact_company`	`string`	Doručovací společnost zákazníka
`contact_ico`	`string`	Doručovací IČO zákazníka
`contact_dic`	`string`	Doručovací DIČ zákazníka
`note`	`string`	Poznámka k objednávce
`payment`	`array`	Platební metoda
`delivery`	`array`	Doručovací metoda
`basket`	`array`	Pole produktů v košíku
`inserts`	`array`	Pole insertů
`created`	`string`	Datum a čas vytvoření objednávky (Y-m-d H:i:s)

Popis:

editace objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/orders?id=1

JSON požadavek:

PUT https://client.api.dropshipping.cz/v1/orders?id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`int`	ANO	ID objednávky

{
    "email": "jan.novak@gmail.com",
    "phone": "777 777 777",
    "invoice_firstname": "Jan",
    "invoice_surname": "Novák",
    "invoice_street": "Korunní 21",
    "invoice_city": "Praha 2",
    "invoice_zipcode": "128 00",
    "invoice_company": "Jan Novak",
    "invoice_ico": "123456",
    "invoice_dic": "654321",
    "contact_like_invoice": "0",
    "contact_firstname": "Jana",
    "contact_surname": "Nováková",
    "contact_street": "Vinohradská 47",
    "contact_city": "Praha 2",
    "contact_zipcode": "128 00",
    "contact_company": "Jan Novak",
    "contact_ico": "123456",
    "contact_dic": "654321",
    "zpl_note": "Pro nejlepšího dědu",
    "note": "",
    "payment_id": "",
    "payment_price_vat": "",
    "delivery_id": "",
    "delivery_price_vat": "",
    "delivery_place_id": 1,
    "delivery_place_ext_id": NULL,
    "basket": [
        {
            "id": 1,
            "code": "DS12345678",
            "price_retail_vat": 123.00,
            "quantity": 3,
            "note": "zelená varianta",
        }
    ],
    "inserts": [
        {
            "id": 1,
            "code": "DS12345678",
            "quantity": 3,
        }
    ],
    "test": "0",
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`email`	`string`	ANO	E-mail zákazníka
`phone`	`string`	ANO	Telefon zákazníka
`invoice_firstname`	`string`	ANO	Fakturační jméno zákazníka
`invoice_surname`	`string`	ANO	Fakturační příjmení zákazníka
`invoice_street`	`string`	ANO	Fakturační ulice zákazníka
`invoice_city`	`string`	ANO	Fakturační město zákazníka
`invoice_zipcode`	`string`	ANO	Fakturační PSČ zákazníka
`invoice_company`	`string`	NE	Fakturační společnost zákazníka
`invoice_ico`	`string`	NE	Fakturační IČO zákazníka
`invoice_dic`	`string`	NE	Fakturační DIČ zákazníka
`contact_like_invoice`	`int`	ANO	Doručovací adresa stejná jako fakturační (0 = NE; 1 = ANO)
`contact_firstname`	`string`	NE	Doručovací jméno zákazníka
`contact_surname`	`string`	NE	Doručovací příjmení zákazníka
`contact_street`	`string`	NE	Doručovací ulice zákazníka
`contact_city`	`string`	NE	Doručovací město zákazníka
`contact_zipcode`	`string`	NE	Doručovací PSČ zákazníka
`contact_company`	`string`	NE	Doručovací společnost zákazníka
`contact_ico`	`string`	NE	Doručovací IČO zákazníka
`contact_dic`	`string`	NE	Doručovací DIČ zákazníka
`note`	`string`	NE	Poznámka k objednávce
`zpl_note`	`string\|NULL`	NE	Poznámka na balík s maximálním počtem 23 znaků. Pokud bude parametr vynechán nebo NULL, bude použita defaultní poznámka nastavená u obchodu.
`payment_id`	`int`	ANO	ID aktivní platební metody partnera
`payment_price_vat`	`float`	ANO	Cena platební metody s DPH
`delivery_id`	`int`	ANO	ID aktivní doručovací metody partnera
`delivery_place_id`¹	`int\|NULL`	NE	ID odběrného místa (ze systému dropshipping.cz). Viz Doručovací metody - odběrné místa
`delivery_place_ext_id`¹	`int\|NULL`	NE	ID odběrného místa (z externí služby, například zasilkovna.cz).
`delivery_price_vat`	`float`	ANO	Cena doručovací metody s DPH
`basket`	`array`	ANO	pole produktů v košíku
`basket.id`	`int`	Podm.	ID aktivního produktu dodavatele. Nepovinné, pokud je uveden kód produktu
`basket.code`	`string`	Podm.	Kód aktivního produktu dodavatele. Nepovinné, pokud je uvedeno ID produktu
`basket.price_retail_vat`	`float`	ANO	Cena produktu s DPH
`basket.quantity`	`int`	ANO	Počet kusů produktu
`basket.note`	`string`	NE	Poznámka konkrétního produktu
`inserts`	`array`	NE	pole insertů objednávky
`inserts.id`	`int`	Podm.	ID aktivního produktu. Nepovinné, pokud je uveden kód produktu
`inserts.code`	`string`	Podm.	Kód aktivního produktu. Nepovinné, pokud je uvedeno ID produktu
`inserts.quantity`	`int`	ANO	Počet kusů insertu
`test`	`int`	NE	Testovací objednávka. V případě označení objednávky jako testovací ("test": "1"), nebude objednávka předána dodavateli.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

změna stavu objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/orders?id=1

JSON požadavek:

PATCH https://client.api.dropshipping.cz/v1/orders?id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`int`	ANO	ID objednávky

{
    "status_id": 1
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`status_id`	`string`	ANO	ID stavu, do kterého chcete objednávku změnit.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

zrušení objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/orders?id=1

JSON požadavek:

DELETE https://client.api.dropshipping.cz/v1/orders?id=1 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`int`	ANO	ID objednávky

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

WEBHOOKs

Objednávky

OrderStatusChanged

Popis:

změna stavu objednávky v systému dropshipping.cz

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderStatusChanged",
    "data": {
        "order_id": 265317,
        "from_status_id": 1,
        "to_status_id": 10
    }
}

Parametry eventu:

Klíč	Typ	Komentář
`order_id`	`int`	ID objednávky ze systému dropshipping.cz
`from_status_id`	`int`	Předchozí ID stavu objednávky
`to_status_id`	`string`	Nové ID stavu objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

B2b

REST API

Objednávky

GET /b2b/orders
POST /b2b/orders

Popis:

seznam vašich b2b objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/b2b/orders

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/b2b/orders HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`int`	NE	ID objednávky (pro zobrazení konkrétní objednávky)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30. Maximální hodnota = 100.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=created" = "created ASC"; "sort=-created" = "created DESC"). Defaultní řazení je "created ASC".
`created_from`	`string`	NE	Určuje datum, od kterého se mají objednávky vyhledat. Formát yyyy-mm-dd (např. 2017-01-01).
`created_to`	`string`	NE	Určuje datum, do kterého se mají objednávky vyhledat. Formát yyyy-mm-dd (např. 2017-01-01).

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "number": "1-00001",
            "status": {
                "id": 1,
                "name": "Přijatá"
            },
            "payment": {
                "id": 2,
                "variable_symbol": "5111438483",
                "paid": false,
            },
            "items": [
                {
                    "variantId": 1,
                    "variantCode": "DS34712286",
                    "buyerVariantId": 2,
                    "buyerVariantCode": "DS13605827",
                    "name": "Nůž na brambory",
                    "quantity": 5,
                    "stored_quantity": 0,
                    "ordered_quantity": 5,
                    "date_of_delivery": "2015-04-04",
                    "note": "",
                    "vat": 21,
                    "price": 13.22,
                    "price_vat": 16.00,
                }
            ],
            "note": "",
            "price": 66.1,
            "price_vat": 80.00,
            "created": "2015-04-04 16:30:19",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID objednávky
`number`	`string`	Číslo objednávky
`status.id`	`int`	ID stavu objednávky
`status.name`	`string`	Název stavu objednávky
`payment.id`	`int`	ID platební metody
`payment.variable_symbol`	`string`	Variabilní symbol objednávkys
`payment.paid`	`bool`	Je objednávka zaplacená?
`items.variantId`	`int`	ID varianty
`items.variantCode`	`string`	Kód varianty
`items.buyerVariantId`	`int`	ID varianty nakupujícího (pod kterou variantou bude položka naskladněna)
`items.buyerVariantCode`	`string`	Kód varianty nakupujícího (pod kterou variantou bude položka naskladněna)
`items.name`	`string`	Název varianty
`items.quantity`	`int`	Počet kusů
`items.stored_quantity`	`int`	Počet kusů, které již byly nakupijícímu naskladněny
`items.ordered_quantity`	`int`	Počet kusů, které jsou aktuálně objednány u dodavatele. NULL = produkty ješte nebyly u dodavatele objednány. 0 = produkty již byly u dodavatele dříve objednány, ale dodavatel je nemohl dodat.
`items.date_of_delivery`	`int`	Datum dodání produktů na základě výjádření dodavatele. NULL = produkty ještě nebyly objednány (items.ordered_quantity = NULL) nebo dodavatel nezná jejich dostupnost (items.ordered_quantity = 0).
`items.note`	`string`	Poznámka k variantě
`items.vat`	`int`	DPH (%)
`items.price`	`float`	Cena za kus bez DPH
`items.price_vat`	`float`	Cena za kus s DPH
`note`	`string`	Poznámka k objednávce
`price`	`float`	Cena celkem bez DPH
`price_vat`	`float`	Cena celkem s DPH
`created`	`string`	Datum a čas vytvoření objednávky (Y-m-d H:i:s)

Popis:

vkládání objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/b2b/orders

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/b2b/orders HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

¹ doporučená hlavička pro zabránění duplicitního vložení požadavku. Použijte jakykoliv řetězec (char 36), unikátní pro konkrétní zadání požadavku. Ideálně UUID4 (wikipedie, PHP knihovna)

{
    "paymentId": 2,
    "email": "zakaznik@gmail.com",
    "phone": "777666555",
    "note": ,
    "items": [
        {
            "variantId": 1,
            "variantCode": "DS34712286",
            "buyerVariantId": 2,
            "buyerVariantCode": "DS13605827",
            "quantity": 5,
            "note": ""
        }
    ]
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`paymentId`	`int`	ANO	Platební metoda 2 => bankovním převodem 16 => zálohovým účtem
`email`	`string`	NE	E-mail nakupujícího. Defautlně bude použit přihlašovací e-mail
`phone`	`string`	NE	E-mail nakupujícího. Defautlně bude použit telefon z profilu
`note`	`string`	NE	Poznámka
`items.variantId`	`int`	Podm.	Id varianty. Nepovinné, pokud je vyplněno items.variantCode
`items.variantCode`	`string`	Podm.	Kód varianty. Nepovinné, pokud je vyplněno items.variantId
`items.buyerVariantId`	`int`	Podm.	ID varianty nakupujícího (pod kterou variantou bude položka naskladněna). Nepovinné, pokud je vyplněno items.buyerVariantCode
`items.buyerVariantCode`	`string`	Podm.	Kód varianty nakupujícího (pod kterou variantou bude položka naskladněna) Nepovinné, pokud je vyplněno items.buyerVariantId
`items.quantity`	`int`	ANO	Počet kusů
`items.note`	`string`	NE	Poznámka

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "id": 1
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`id`	ID objednávky v systému dropshipping.cz

Produkty

GET /b2b/products/<productId>

Popis:

detail b2b produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/b2b/products/<productId>

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/b2b/products/<productId> HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`productId`	`int`	ANO	ID b2b produktu

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Horké kameny",
            "variants": [
                {
                    "id": 1,
                    "name": "červené",
                    "code": "DS12345678",
                    "ext_code": "xyz",
                    "ean": "",
                    "price": 317.36,
                    "price_individual": 285.62,
                    "price_retail": 475.21,
                    "price_retail_vat": 575,
                    "minimal_price_retail": 356.41,
                    "minimal_price_retail_vat": 431,
                    "warehouse_quantity": 99,
                    "delivery_date": 0,
                    "inhouse_quantity": 99,
                    "partner_quantity": 0,
                    "partner_delivery_date": 60,
                    "discounts": [
                        {
                            "quantity": 10,
                            "price": 285.62,
                        },
                        {
                            "quantity": 100,
                            "price": 225.62,
                        }
                    ],
                    "paired_variants": [
                        {
                            "id": 1558976,
                            "code": "DS12471440",
                        }
                    ]
                }
            ]
        }
    ]

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID produktu
`name`	`string`	Název produktu
`variants`	`array`	Varianty produktu
`variants.id`	`int`	ID varianty
`variants.name`	`string`	Název varianty
`variants.code`	`string`	Kód varianty
`variants.ext_code`	`int`	Kód dodavatele
`variants.ean`	`int`	EAN
`variants.price`	`float`	Základní cena bez DPH
`variants.price_individual`	`float\|NULL`	Vaše individuální cena
`variants.price_retail`	`float`	Doporučená maloobchodní cena bez DPH
`variants.price_retail_vat`	`float`	Doporučená maloobchodní cena s DPH
`variants.minimal_price_retail`	`float`	Minimální maloobchodní cena bez DPH
`variants.minimal_price_retail_vat`	`float`	Minimální maloobchodní cena s DPH
`variants.warehouse_quantity`	`int\|NULL`	Počet kusů skladem celkem. Pokud je hodnota neznámá, vrací null.
`variants.delivery_date`	`int\|NULL`	Dodací doba produktu ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`variants.inhouse_quantity`	`int`	Počet kusů na skladech interních dropshipping.cz.
`variants.partner_quantity`	`int\|NULL`	Počet kusů skladem u dodavatele. Pokud je hodnota neznámá, vrací null.
`variants.partner_delivery_date`	`int\|NULL`	Dodací doba produktu u dodavatele ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`variants.discounts`	`array`	Množstevní slevy
`variants.discounts.quantity`	`int`	Počet kusů - minimální odběr
`variants.discounts.price`	`float`	Cena bez DPH
`variants.paired_variants`	`array`	Seznam variant z vašich produktů napárované na tuto variantu
`variants.paired_variants.id`	`int`	ID vaší varianty
`variants.paired_variants.code`	`string`	Kód vaší varianty

Produkty - varianty

GET /b2b/products/<productId>/variants/<variantId>
PATCH PairSku

Popis:

detail b2b varianty

Úplná adresa:

https://client.api.dropshipping.cz/v1/b2b/products/<productId>/variants/<variantId>

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/b2b/products/variants/<variantId> HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`productId`	`int`	ANO	ID b2b produktu
`variantId`	`int`	ANO	ID b2b varianty

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "červené",
            "code": "DS12345678",
            "ext_code": "xyz",
            "ean": "",
            "price": 317.36,
            "price_individual": 285.62,
            "price_retail": 475.21,
            "price_retail_vat": 575,
            "minimal_price_retail": 356.41,
            "minimal_price_retail_vat": 431,
            "warehouse_quantity": 99,
            "delivery_date": 0,
            "inhouse_quantity": 99,
            "partner_quantity": 0,
            "partner_delivery_date": 60,
            "discounts": [
                {
                    "quantity": 10,
                    "price": 285.62,
                },
                {
                    "quantity": 100,
                    "price": 225.62,
                }
            ],
            "paired_variants": [
                {
                    "id": 1558976,
                    "code": "DS12471440",
                }
            ]
        }
    ]

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID varianty
`name`	`string`	Název varianty
`code`	`string`	Kód varianty
`ext_code`	`int`	Kód dodavatele
`ean`	`int`	EAN
`price`	`float`	Základní cena bez DPH
`price_individual`	`float\|NULL`	Vaše individuální cena
`price_retail`	`float`	Doporučená maloobchodní cena bez DPH
`price_retail_vat`	`float`	Doporučená maloobchodní cena s DPH
`minimal_price_retail`	`float`	Minimální maloobchodní cena bez DPH
`minimal_price_retail_vat`	`float`	Minimální maloobchodní cena s DPH
`warehouse_quantity`	`int\|NULL`	Počet kusů skladem celkem. Pokud je hodnota neznámá, vrací null.
`delivery_date`	`int\|NULL`	Dodací doba produktu ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`inhouse_quantity`	`int`	Počet kusů na skladech interních dropshipping.cz.
`partner_quantity`	`int\|NULL`	Počet kusů skladem u dodavatele. Pokud je hodnota neznámá, vrací null.
`partner_delivery_date`	`int\|NULL`	Dodací doba produktu u dodavatele ve dnech. 0 = produkt je skladem. Maximální hodnota = 60. Pokud je hodnota neznámá, vrací null.
`discounts`	`array`	Množstevní slevy
`discounts.quantity`	`int`	Počet kusů - minimální odběr
`discounts.price`	`float`	Cena bez DPH
`paired_variants`	`array`	Seznam variant z vašich produktů napárované na tuto variantu
`paired_variants.id`	`int`	ID vaší varianty
`paired_variants.code`	`string`	Kód vaší varianty

Popis:

spárování b2b varianty s vaší variantou

Úplná adresa:

https://client.api.dropshipping.cz/v1/b2b/products/<productId>/variants/<variantId>

JSON požadavek:

PATCH https://client.api.dropshipping.cz/v1/b2b/products/variants/<variantId> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Command: PairSku

{
    "variant_id": 1
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`variant_id`	`int`	ANO	ID vaší varianty, kterou chcete napárovat na b2b variantu. Pokud bude vyplněna hodnota NULL, bude vytvořena nová varianta!

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "id": 1
}

Fulfillment

REST API

Objednávky

GET /fulfillment/orders
POST /fulfillment/orders
PATCH /fulfillment/orders

Popis:

seznam vašich objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/orders?limit=10&offset=0&sort=-created

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/orders?limit=30&offset=0&sort=-created HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID objednávky (pro zobrazení konrétní objednávky)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 30. Maximální hodnota = 100.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=created" = "created ASC"; "sort=-created" = "created DESC"). Defaultní řazení je "created ASC".

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 10,
    "data": [
        {
            "id": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f",
            "number": "FF291015",
            "remote_number": "123456789",
            "currency_id": "CZK",
            "on_hold": true,
            "status": "problem_in_expedition",
            "expedition": {
                "status": "problem",
                "problem": {
                    "source": "packing",
                    "description": "Produkt není k nalezení.",
                    "solution": NULL,
                    "postponed": true,
                },
            },
            "recipient": {
                "email": "zakaznik@gmail.com",
                "phone": "777666555",
                "firstname": "Jan",
                "surname": "Novák",
                "street": "Korunní 21",
                "city": "Praha 2",
                "zipcode": "12800",
                "company": ""
            },
            "delivery": {
                "id": 25,
                "value": 999.0,
                "name": "DPD",
                "tracking_number": "xyz",
                "status": "inTransit"
            },
            "payment": {
                "cod": true,
                "variable_symbol": "1234567890",
                "price": 1001
            },
            "products": [
                {
                    "name": "Horké kameny",
                    "image": "https://dscdn.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                    "code": "DS12345678",
                    "ext_code": null,
                    "quantity": 3
                }
            ],
            "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
            "damaged": false,
            "note": "Poznámka",
            "tickets": [
                {
                    "barcode": "DR0705127648C",
                    "data": "^XA..."
                }
            ],
            "billing": {
                "fulfillment_price": 29.50,
                "shipping_price": null
            },
            "created": "2019-03-17 14:26:45"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`status`	`string`	Stav objednávky created => vytvořeno waiting_for_storage => čeká na uskladnění in_expedition => v expedici packed => zabaleno canceled => stornováno problem_in_expedition => problém v expedici not_sent => neodesláno sent => odesláno delivered => doručeno returned => vráceno
`expedition.status`	`string`	Stav v expedici waiting => Objednávka čeká na picking. V případě potřeby můžete objednávku v expedici zrušit. picking => Objednávka je v procesu pickingu. waitingForPacking => Objednávka byla čeka na kompletaci. packing => Objednávka je v procesu kompletace. packed => Objednávka byla zkompletována a čeká na zabalení. problem => Objednávka byla označena jako problémová a čeka na vyřešení. problemSolved => Objednávka byla v expedici zrušena a v případě potřeby můžete její stav změnit. finished => Objednávka byla zabalena a čeká na předání kurýrovi. picked => Objednávka byla čeka na kompletaci. packaging => Objednávka je v procesu balení. packaged => UNKNOWN STATUS
`expedition.problem.source`		Zdroj problému order => objednávka picking => picking packing => kompletace packaging => balení
`expedition.problem.description`		Popis problému
`expedition.problem.solution`		Rešení problému
`expedition.problem.postponed`		Expedice objednávky byla pouze krátkodobě odložena.

Popis:

vkládání objednávek

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/orders

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/orders HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "recipient": {
        "email": "zakaznik@gmail.com",
        "phone": "777666555",
        "firstname": "Jan",
        "surname": "Novák",
        "street": "Korunní 21",
        "city": "Praha 2",
        "zipcode": "12800",
        "company": ""
    },
    "delivery": {
        "id": 25,
        "value": 999.0,
        "place_id": null,
        "place_ext_id": null
    },
    "payment": {
        "cod": true,
        "variable_symbol": "1234567890",
        "price": 1001
    },
    "products": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "quantity": 3
        }
    ],
    "currency_id": "EUR",
    "on_hold": true,
    "remote_number": "123456789",
    "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "damaged": false,
    "note": "Poznámka",
    "tickets": [
        {
            "barcode": "DR0705127648C",
            "data": "^XA..."
        }
    ],
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`recipient.email`	`string`	ANO	E-mail zákazníka
`recipient.phone`	`string`	ANO	Telefon zákazníka
`recipient.firstname`	`string`	ANO	Jméno zákazníka
`recipient.surname`	`string`	ANO	Příjmení zákazníka
`recipient.street`	`string`	ANO	Ulice zákazníka
`recipient.city`	`string`	ANO	Město zákazníka
`recipient.zipcode`	`string`	ANO	PSČ zákazníka
`recipient.company`	`string`	NE	Společnost zákazníka
`delivery.id`	`int`	ANO	ID doručovací metody
`delivery.value`	`float`	ANO	Hodnota zboží v objednávce v měně objednávky
`delivery.place_id`¹	`int\|NULL`	NE	ID odběrného místa (ze systému dropshipping.cz). Viz Doručovací metody - odběrné místa
`delivery.place_ext_id`¹	`int\|NULL`	NE	ID odběrného místa (z externí služby, například zasilkovna.cz).
`payment.cod`	`bool`	ANO	Je objednávka na dobírku?
`payment.variable_symbol`	`string\|NULL`	Podm.	Variabilní symbol. Povinné v případě, že je objednávka na dobírku.
`payment.price`	`float`	ANO	Částka k zaplacení v měně objednávky. V případě, že je objednávka zaplacena předem pošlete 0.
`products[].code`	`string\|NULL`	Podm.	Kód produktu ze systému dropshipping.cz. Nepovinné, pokud je uvedeno ext_code produktu
`products[].ext_code`	`string\|NULL`	Podm.	Kód produktu dodavatele. Nepovinné, pokud je uvedeno code produktu
`products[].quantity`	`int`	ANO	Počet kusů produktu
`currency_id`	`string`	NE	Měna objednávky, defaultně bude nastaveno na CZK. Měna objednávky musí souhlasit s měnou země, do které je objednávka odeslána.
`on_hold`	`bool`	NE	Vyžaduje objednávka manuální poslání do expedice? Použijte u objednávek, které čekají na zaplacení a nesmí být poslány do expedice automaticky.
`remote_number`	`string`	ANO	Číslo objednávky z Vašeho systému
`invoice`	`string\|NULL`	NE	PDF faktura jako base64 encode string.
`damaged`	`bool`	NE	Jedná se o zásilku s poškozeným zbožím?
`note`	`string`	NE	Poznámka
`tickets[]`	`array`	NE	Odeslání zásilky přes vlastního dopravce. Vlastní štítky (ve formátu ZPL) používejte pouze na základě předchozí dohody s technickou podporou dropshipping.cz.
`tickets[].barcode`	`string`	ANO	Sledovací číslo balíku. Musí se shodovat s čárovým kódem na štítku.
`tickets[].data`	`string`	ANO	ZPL kód balíku

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "id": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f"
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`string`	UUID objednávky v systému dropshipping.cz

Popis:

odeslání objednávky k expedici

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f

JSON požadavek:

PATCH https://client.api.dropshipping.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON odpověď:

HTTP/1.1 200

Produkty

GET /fulfillment/products
POST /fulfillment/products
PUT /fulfillment/products/<id>

Popis:

seznam produktů

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/products?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID produktu (pro zobrazení pouze konkrétního produktu)
`code`	`string`	NE	DS kód varianty
`ext_code`	`string`	NE	Kód dodavatele varianty
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 100.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=name" = "name ASC"; "sort=-name" = "name DESC"). Defaultní řazení je "name ASC".

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "category_id": 1,
            "name": "Horké kameny",
            "description": "Popis",
            "description_html": "<strong>Popis</strong>",
            "variants": [
                {
                    "id": 1,
                    "sku_id": NULL,
                    "sku_code": NULL,
                    "name": "červené",
                    "code": "DS12345678",
                    "ext_code": "xyz",
                    "ean": "...",
                    "dropshipping": "private",
                    "clearance": false,
                    "purchase_price": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://dscdn.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131b.png",
                    "partner_warehouse_quantity": 3,
                    "partner_delivery_date": 0,
                    "inventory": {
                        "quantity": 3,
                        "reserved_quantity": 1,
                        "requested_quantity": 0,
                        "price_per_unit": 81.81,
                        "location": "A123"
                    }
                },
                {
                    "id": 2,
                    "sku_id": 5,
                    "sku_code": DS12345699,
                    "name": "černé",
                    "code": "DS12345679",
                    "ext_code": "xzy",
                    "ean": "...",
                    "dropshipping": "public",
                    "clearance": false,
                    "purchase_price": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://dscdn.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131c.png",
                    "partner_warehouse_quantity": null,
                    "partner_delivery_date": null,
                    "inventory": {
                        "quantity": 0,
                        "reserved_quantity": 0,
                        "requested_quantity": 2,
                        "price_per_unit": 81.81,
                        "location": "A123"
                    }
                }
            ]
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID produktu
`category_id`	`int\|NULL`	ID kategorie (pokud je produkt do kategorie zařazen).
`name`	`string`	Název produktu
`description`	`string`	Popis produktu
`description_html`	`string`	HTML popis produktu
`variants.id`	`int`	ID varianty
`variants.sku_id`	`int\|NULL`	ID nadřazené varianty varianty
`variants.sku_code`	`string\|NULL`	DS kód nadřazené varianty varianty
`variants.name`	`string`	Název varianty
`variants.code`	`string`	DS kód varianty
`variants.ext_code`	`string`	Váš kód varianty
`variants.ean`	`string`	EAN varianty
`variants.dropshipping`	`string`	Bude varianta nabízena také ostatním uživatelům systému nebo je vavrianta pouze pro vás? Hodnoty "private" nebo "public"
`variants.clearance`	`bool`	Varianta v likvidaci. Slouží primárně pro označení produktů, u kterých se nepočíta s dalším doskladňováním
`variants.purchase_price`	`float\|NULL`	Nákupní cena varianty bez DPH
`variants.price_wholesale`	`float\|NULL`	Velkoobchodní cena varianty bez DPH
`variants.price_retail`	`float\|NULL`	Doporučená maloobchodní cena varianty bez DPH
`variants.price_retail_vat`	`int\|NULL`	Doporučená maloobchodní cena varianty s DPH
`variants.vat`	`int`	DPH
`variants.preview_image`	`string`	Obrázek varianty
`variants.partner_warehouse_quantity`	`int\|NULL`	Počet kusů skladem u dodavatele. NULL = produkt je skladem s neznámým přesným počtem kusů
`variants.partner_delivery_date`	`int\|NULL`	Počet dní k naskladnění u dodavatele (v případě že není produkt skladem). 0 = je skladem, 60 = produkt již nebude naskladněn
`variants.inventory.quantity`	`int`	Počet kusů skladem celkem (pro dostupný počet kusů nezapomeňte odečíst "reserved_quantity")
`variants.inventory.reserved_quantity`	`int`	Počet rezervovaných kusů pro nevyřízené objednávky
`variants.inventory.requested_quantity`	`int`	Počet žádostí (ks) o variantu pro nevyřízené objednávky
`variants.inventory.price_per_unit`	`float\|NULL`	Průměrná cena za kus
`variants.inventory.location`	`string`	Umístění na skladě

Popis:

vytváření produktů

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "category_id": 1,
    "name": "Horké kameny",
    "variant_name": "červené",
    "ext_code": "xyz",
    "ean": "...",
    "dropshipping": "private",
    "clearance": false,
    "description": "Popis",
    "description_html": "<strong>Popis</strong>",
    "purchase_price": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "preview_image": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`category_id`	`int\|NULL`	ANO	Id kategorie
`name`	`string`	ANO	Název produktu
`variant_name`	`string`	ANO	Název varianty (pokud se jedná o produkt bez variant, pošlete prázdný řetězec)
`ext_code`	`string`	ANO	Kód produktu/varianty z vašeho systému
`ean`	`string`	ANO	EAN produktu/varianty
`dropshipping`	`string`	ANO	Bude produkt/varianta nabízena také ostatním uživatelům systému nebo je vavrianta pouze pro vás? Hodnoty "private" nebo "public"
`clearance`	`bool`	ANO	Produkt/varianta v likvidaci. Slouží primárně pro označení produktů, u kterých se nepočíta s dalším doskladňováním
`description`	`string`	ANO	Popis produktu
`description_html`	`string`	ANO	HTML popis produktu
`price_purchase`	`float\|NULL`	ANO	Nákupní cena varianty bez DPH
`price_wholesale`	`float\|NULL`	ANO	Velkoobchodní cena varianty bez DPH
`price_retail_vat`	`int\|NULL`	ANO	Doporučená maloobchodní cena varianty s DPH
`vat`	`int`	ANO	DPH (15/21)
`preview_image`	`string`	ANO	Obrázek produktu/varianty jako base64 encoded string.
`partner_warehouse_quantity`	`int\|NULL`	NE	Počet kusů skladem u dodavatele. NULL = produkt je skladem s neznámým přesným počtem kusů
`partner_delivery_date`	`int\|NULL`	NE	Počet dní k naskladnění u dodavatele (v případě že není produkt skladem). 0 = je skladem, 60 = produkt již nebude naskladněn

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1,
        "variant_id": 1
    }
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	Id produktu v systému dropshipping.cz
`variant_id`	`int`	Id varianty v systému dropshipping.cz

Popis:

editace produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "category_id": 1,
    "name": "Horké kameny",
    "description": "Popis",
    "description_html": "<strong>Popis</strong>",
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`category_id`	`int\|NULL`	ANO	Id kategorie
`name`	`string`	ANO	Název produktu
`description`	`string`	ANO	Popis produktu
`description_html`	`string`	ANO	HTML popis produktu

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Produkty - kategorie

GET /fulfillment/product-categories
POST /fulfillment/product-categories
PUT /fulfillment/product-categories/<id>
DELETE /fulfillment/product-categories/<id>

Popis:

seznam produktových kategorií

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/product-categories?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/product-categories?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID kategorie (pro zobrazení pouze konkrétní kategorie)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 1000.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=name" = "name ASC"; "sort=-name" = "name DESC"). Defaultní řazení je "name ASC".

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 10,
    "data": [
        {
            "id": 1,
            "parent": 0,
            "name": "Pro muže"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID kategorie
`parent`	`int`	ID nadřazené kategorie. Nejvyšší stupeň kategorií je zapsán jako parent = 0.
`name`	`string`	Název kategorie

Popis:

vytváření kategorií

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/product-categories

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/product-categories HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "name": "Pro muže",
    "parent": 0
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`name`	`string`	ANO	Název kategorie
`parent`	`int`	ANO	ID nadřazené kategorie. Nejvyšší stupeň kategorií je zapsán jako parent = 0.

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	Id kategorie v systému dropshipping.cz

Popis:

editace kategorie

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/product-categories/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/product-categories/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "name": "Pro muže",
    "parent": 0
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`name`	`string`	ANO	Název kategorie
`parent`	`int`	ANO	ID nadřazené kategorie. Nejvyšší stupeň kategorií je zapsán jako parent = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Popis:

smazání kategorie

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/product-categories/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/product-categories/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Produkty - varianty

GET
POST
PUT
PATCH PairSku

Popis:

seznam variant konkrétního produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/products<productId>/variants?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID produktu (pro zobrazení pouze konkrétní varianty)
`code`	`string`	NE	DS kód varianty
`ext_code`	`string`	NE	Kód dodavatele varianty
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 100.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`sort`	`string`	NE	Řazení záznámů. Směr řazení se určuje znakem "-" před názvem proměnné ("sort=name" = "name ASC"; "sort=-name" = "name DESC"). Defaultní řazení je "name ASC".

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 2,
    "data": [
        {
            "id": 1,
            "sku_id": 5,
            "sku_code": DS12345699,
            "name": "červené",
            "code": "DS12345678",
            "ext_code": "xyz",
            "ean": "...",
            "dropshipping": "private",
            "clearance": false,
            "purchase_price": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://dscdn.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131b.png",
            "partner_warehouse_quantity": 3,
            "partner_delivery_date": 0,
            "inventory": {
                "quantity": 3,
                "reserved_quantity": 1,
                "requested_quantity": 0,
                "price_per_unit": 81.81,
                "location": "A123"
            }
        },
        {
            "id": 2,
            "sku_id": NULL,
            "sku_code": NULL,
            "name": "černé",
            "code": "DS12345679",
            "ext_code": "xzy",
            "ean": "...",
            "dropshipping": "public",
            "clearance": false,
            "purchase_price": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://dscdn.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131c.png",
            "partner_warehouse_quantity": null,
            "partner_delivery_date": null,
            "inventory": {
                "quantity": 0,
                "reserved_quantity": 0,
                "requested_quantity": 2,
                "price_per_unit": 81.81,
                "location": "A123"
            }
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID varianty
`sku_id`	`int\|NULL`	ID nadřazené varianty varianty
`sku_code`	`string\|NULL`	DS kód nadřazené varianty varianty
`name`	`string`	Název varianty
`code`	`string`	DS kód varianty
`ext_code`	`string`	Váš kód varianty
`ean`	`string`	EAN varianty
`dropshipping`	`string`	Bude varianta nabízena také ostatním uživatelům systému nebo je vavrianta pouze pro vás? Hodnoty "private" nebo "public"
`clearance`	`bool`	Varianta v likvidaci. Slouží primárně pro označení produktů, u kterých se nepočíta s dalším doskladňováním
`purchase_price`	`float\|NULL`	Nákupní cena varianty bez DPH
`price_wholesale`	`float\|NULL`	Velkoobchodní cena varianty bez DPH
`price_retail`	`float\|NULL`	Doporučená maloobchodní cena varianty bez DPH
`price_retail_vat`	`int\|NULL`	Doporučená maloobchodní cena varianty s DPH
`vat`	`int`	DPH
`preview_image`	`string`	Obrázek varianty
`partner_warehouse_quantity`	`int\|NULL`	Počet kusů skladem u dodavatele. NULL = produkt je skladem s neznámým přesným počtem kusů
`partner_delivery_date`	`int\|NULL`	Počet dní k naskladnění u dodavatele (v případě že není produkt skladem). 0 = je skladem, 60 = produkt již nebude naskladněn
`inventory.quantity`	`int`	Počet kusů skladem celkem (pro dostupný počet kusů nezapomeňte odečíst "reserved_quantity")
`inventory.reserved_quantity`	`int`	Počet rezervovaných kusů pro nevyřízené objednávky
`inventory.requested_quantity`	`int`	Počet žádostí (ks) o variantu pro nevyřízené objednávky
`inventory.price_per_unit`	`float\|NULL`	Průměrná cena za kus
`inventory.location`	`string`	Umístění na skladě

Popis:

vytváření variant konkrétního produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "dropshipping": "public",
    "clearance": true,
    "purchase_price": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "preview_image": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`name`	`string`	ANO	Název varianty
`ext_code`	`string`	ANO	Kód produktu/varianty z vašeho systému
`ean`	`string`	ANO	EAN produktu/varianty
`dropshipping`	`string`	ANO	Bude produkt/varianta nabízena také ostatním uživatelům systému nebo je vavrianta pouze pro vás? Hodnoty "private" nebo "public"
`clearance`	`bool`	ANO	Produkt/varianta v likvidaci. Slouží primárně pro označení produktů, u kterých se nepočíta s dalším doskladňováním
`price_purchase`	`float\|NULL`	ANO	Nákupní cena varianty bez DPH
`price_wholesale`	`float\|NULL`	ANO	Velkoobchodní cena varianty bez DPH
`price_retail_vat`	`int\|NULL`	ANO	Doporučená maloobchodní cena varianty s DPH
`vat`	`int`	ANO	DPH (15/21)
`preview_image`	`string`	ANO	Obrázek produktu/varianty jako base64 encoded string.
`partner_warehouse_quantity`	`int\|NULL`	NE	Počet kusů skladem u dodavatele. NULL = produkt je skladem s neznámým přesným počtem kusů
`partner_delivery_date`	`int\|NULL`	NE	Počet dní k naskladnění u dodavatele (v případě že není produkt skladem). 0 = je skladem, 60 = produkt již nebude naskladněn

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	Id varianty v systému dropshipping.cz

Popis:

editace varianty

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "dropshipping": "public",
    "clearance": true,
    "purchase_price": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`name`	`string`	ANO	Název varianty
`ext_code`	`string`	ANO	Kód produktu/varianty z vašeho systému
`ean`	`string`	ANO	EAN produktu/varianty
`dropshipping`	`string`	ANO	Bude produkt/varianta nabízena také ostatním uživatelům systému nebo je vavrianta pouze pro vás? Hodnoty "private" nebo "public"
`clearance`	`bool`	ANO	Produkt/varianta v likvidaci. Slouží primárně pro označení produktů, u kterých se nepočíta s dalším doskladňováním
`price_purchase`	`float\|NULL`	ANO	Nákupní cena varianty bez DPH
`price_wholesale`	`float\|NULL`	ANO	Velkoobchodní cena varianty bez DPH
`price_retail_vat`	`int\|NULL`	ANO	Doporučená maloobchodní cena varianty s DPH
`vat`	`int`	ANO	DPH (15/21)
`preview_image`	`string`	NE	Pokud chcete ponechat aktální obrázek varianty, vynechte tuto proměnnou.
`partner_warehouse_quantity`	`int\|NULL`	NE	Počet kusů skladem u dodavatele. NULL = produkt je skladem s neznámým přesným počtem kusů
`partner_delivery_date`	`int\|NULL`	NE	Počet dní k naskladnění u dodavatele (v případě že není produkt skladem). 0 = je skladem, 60 = produkt již nebude naskladněn

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Popis:

spárování varianty s b2b variantou

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants/<id>

JSON požadavek:

PATCH https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/variants/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Command: PairSku

{
    "sku_id": 1,
    "sku_code": "DS95688674"
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`sku_id`	`int`	Podm.	ID b2b varianty. Nepovinné při uvedení proměnné sku_code.
`sku_code`	`string`	Podm.	Kód b2b varianty. Nepovinné při uvedení proměnné sku_id.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Produkty - galerie

GET /fulfillment/products/<productId>/images
POST /fulfillment/products/<productId>/images
DELETE /fulfillment/products/<productId>/images/<id>

Popis:

galerie konkrétního produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 1000.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 10,
    "data": [
        {
            "id": 1,
            "product_id": 1,
            "variant_id": 1,
            "url": "https://dscdn.cz/images/5/8/2/8/9/b/9/d/a/7/3ab95e3eb9e21986c724af.jpg"
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID obrázku
`product_id`	`int`	ID produktu
`variant_id`	`int\|NULL`	ID varianty, pokud se obrázek vztahuje ke konkrétní variante produktu.
`url`	`string`	ANO	URL obrázku

Popis:

vytváření nového obrázku galerie konkrétního produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "variant_id": 1,
    "image": "JVBERi0xLjMNCiXi48/TDQoNCjE..."
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`variant_id`	`int\|NULL`	ANO	ID varianty, pokud je na obrázku pouze konkrétní varianta produktu
`image`	`string`	ANO	Obrázek jako base64 encoded string.

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
        "url": "https://dscdn.cz/images/5/8/2/8/9/b/9/d/a/7/3ab95e3eb9e21986c724af.jpg"
    }
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`string`	ID vloženého obrázku
`url`	`string`	URL vloženého obrázku

Popis:

smazání obrázku produktu

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/products/<productId>/images/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Sklad - předskladnění

GET /fulfillment/warehouse-preloads
POST /fulfillment/warehouse-preloads
PUT /fulfillment/warehouse-preloads/<id>
DELETE /fulfillment/warehouse-preloads/<id>

Popis:

seznam předskladnění

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID kategorie (pro zobrazení pouze konkrétní kategorie)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 1000.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "extra_cost": 0,
            "note": "poznámka",
            "receiving_note": "poznámka k naskladnění",
            "date_of_delivery": "2020-12-31",
            "items": [
                {
                    "variant_id": 1,
                    "code": "DS12345678",
                    "ext_code": null,
                    "price_per_unit": 99.99,
                    "quantity": 3,
                    "received_quantity": 2,
                    "damaged_quantity": 1,
                    "photos": ["https://dscdn.cz/images/9/3/4/f/a/a/e/a/1/0/b31ea2df5b933d6cf9b661.png"]
                }
            ],
            "packages": [
                {
                    "barcode": "123456789"
                }
            ]
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID předskladnění
`extra_cost`	`float`	Náklady naskladnění bez DPH
`note`	`string`	Poznámka
`receiving_note`	`string`	Poznámka k naskladnění
`date_of_delivery`	`string`	Předpokládaný datum dodání
`items[].variantId`	`int`	Id produktu ze systému dropshipping.cz
`items[].code`	`string`	Kód produktu ze systému dropshipping.cz
`items[].ext_code`	`string`	Kód produktu dodavatele
`items[].price_per_unit`	`float`	Cena za kus bez DPH
`items[].quantity`	`int`	Počet kusů
`items[].received_quantity`	`int\|NULL`	Počet kusů, které byly reálně naskladněny. Pokud je hodnota NULL, k naskladnění zatím nedošlo
`items[].damaged_quantity`	`int\|NULL`	Počet kusů, které jsou poškozeny. Pokud je hodnota NULL, zatím nedošlo k naskladnění
`items[].photos`	`array`	Foto dokumentace, z pravidla v případě přijetí poškozených kusů
`packages[].barcode`	`string`	Sledovací číslo balíků

Popis:

vytváření předskladnění

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2020-12-31",
    "items": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "price_per_unit": 99.99,
            "quantity": 3
        }
    ],
    "packages": [
        {
            "barcode": "123456789"
        }
    ]
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`extra_cost`	`float`	ANO	Náklady naskladnění bez DPH
`note`	`string`	NE	Poznámka
`date_of_delivery`	`string`	ANO	Předpokládaný datum dodání
`items[].code`	`string`	Podm.	Kód produktu ze systému dropshipping.cz. Nepovinné, pokud je uvedeno ext_code produktu
`items[].ext_code`	`string`	Podm.	Kód produktu dodavatele. Nepovinné, pokud je uvedeno code produktu
`items[].price_per_unit`	`float`	ANO	Cena za kus bez DPH
`items[].quantity`	`int`	ANO	Počet kusů
`packages[].barcode`	`string`	NE	Sledovací číslo balíků

JSON odpověď:

HTTP/1.1 201
Content-type: application/json;

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	Id předskladnění v systému dropshipping.cz

Popis:

editace předskladnění

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2020-12-31",
    "items": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "price_per_unit": 99.99,
            "quantity": 3
        }
    ],
    "packages": [
        {
            "barcode": "123456789"
        }
    ]
}

Popis polí požadavku:

Klíč	Typ	Povinné	Komentář
`extra_cost`	`float`	ANO	Náklady naskladnění bez DPH
`note`	`string`	NE	Poznámka
`date_of_delivery`	`string`	ANO	Předpokládaný datum dodání
`items[].code`	`string`	Podm.	Kód produktu ze systému dropshipping.cz. Nepovinné, pokud je uvedeno ext_code produktu
`items[].ext_code`	`string`	Podm.	Kód produktu dodavatele. Nepovinné, pokud je uvedeno code produktu
`items[].price_per_unit`	`float`	ANO	Cena za kus bez DPH
`items[].quantity`	`int`	ANO	Počet kusů
`packages[].barcode`	`string`	NE	Sledovací číslo balíků

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Popis:

smazání předskladnění

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/warehouse-preloads/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Sklad - žádosti

GET /fulfillment/warehouse-requests
PUT /fulfillment/warehouse-requests/<id>

Popis:

seznam žádostí

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-requests?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/warehouse-requests?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID kategorie (pro zobrazení pouze konkrétní kategorie)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 1000.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "variant_id": 1,
            "variant_code": "DS12471440",
            "variant_ext_code": "xyz",
            "quantity": 3,
            "date_of_delivery": "2020-12-31",
            "created": "2020-12-31 12:12:12",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	ID žádosti
`variant_id`	`int`	Id produktu ze systému dropshipping.cz
`variant_code`	`string`	Kód produktu ze systému dropshipping.cz
`variant_ext_code`	`string`	Kód produktu dodavatele
`quantity`	`int`	Počet kusů
`date_of_delivery`	`string\|NULL`	Předpokládaný datum dodání. Pokud je hodnota rovna "NULL", žádost čeká na vaše vyjádření. Pokud je hodnota rovna "", předpokládaný datum dodání je nastaveno jako neznámé
`created`	`string`	Datum a čas vytvoření žádosti

Popis:

editace předpokládaného datumu dodání

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-requests/<id>

JSON požadavek:

POST https://client.api.dropshipping.cz/v1/fulfillment/warehouse-requests/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string¹

{
    "date_of_delivery": "2020-12-31",
}

Popis polí požadavku:

`date_of_delivery`	`string`	ANO	Předpokládaný datum dodání. Pokud je datum dodání neznámé, pošlete prázdný řetězec ("").

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": ""
}

Sklad - pohyby

GET /fulfillment/warehouse-movements

Popis:

seznam pohybů

Úplná adresa:

https://client.api.dropshipping.cz/v1/fulfillment/warehouse-movements?limit=100&offset=0

JSON požadavek:

GET https://client.api.dropshipping.cz/v1/fulfillment/warehouse-movements?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Popis parametrů požadavku:

Klíč	Typ	Povinné	Komentář
`id`	`string`	NE	ID kategorie (pro zobrazení pouze konkrétní kategorie)
`limit`	`int`	NE	Počet požadovaných záznamů. Defaultní hodnota = 100. Maximální hodnota = 1000.
`offset`	`int`	NE	Určuje, od kterého místa bude výsledek zobrazen. Defaultní hodnota = 0.
`dateFrom`	`string`	NE	Datum od ve formátu Y-m-d (např. 2020-01-31).
`dateTo`	`string`	NE	Datum do ve formátu Y-m-d (např. 2020-01-31).

Záznamy jsou vždy řazeny od nejnovějšího po nejstarší.

JSON odpověď:

HTTP/1.1 200
Content-type: application/json;

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "variant_id": 1,
            "movement": "in",
            "reason": {
                "id": 1,
                "name": "ztráta na skladě"
            }
            "order_id": null,
            "order_number": null,
            "fulfillment_order_id": null,
            "price_per_unit": 99.99,
            "extra_cost_per_unit": 0.0,
            "quantity": 3,
            "created": "2020-12-31 12:12:12",
        }
    ]
}

Popis polí odpovědi:

Klíč	Typ	Komentář
`id`	`int`	Id pohybu
`variant_id`	`int`	Id varianty ze systému dropshipping.cz
`movement`	`string`	Směr pohybu ("in"\|"out")
`reason`	`obj\|NULL`	Důvod pohybu (pokud je hodnota NULL, důvod nebyl specifikován)
`order_id`	`int\|NULL`	Id dropshippingové objednávky
`order_number`	`string\|NULL`	Číslo dropshippingové objednávky
`fulfillment_order_id`	`string\|NULL`	Id fulfillmentové objednávky ve formátu UUID4
`price_per_unit`	`float\|NULL`	Cena/kus za kterou byla položka naskladněna
`extra_cost_per_unit`	`float\|NULL`	Náklady/kus za kterou byla položka naskladněna
`quantity`	`int`	Počet kusů
`created`	`string`	Datum a čas vytvoření ve formátu "Y-m-d H:i:s"

WEBHOOKs

Objednávky

OrderCreated
OrderUpdated
OrderCanceled
OrderDeliveryChanged
OrderPushedToExpedition
OrderPacked
OrderReturned
OrderNotSent
OrderSent
OrderDelivered
OrderRestored
OrderStatusChangedToWaitingForStorage

Popis:

vytvoření objednávky

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderCreated",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "number": "FF701392",
        "remote_number": "1",
        "currency_id": "CZK",
        "on_hold": false,
        "recipient": {
            "email": "zakaznik@gmail.com",
            "phone": "777666555",
            "firstname": "Jan",
            "surname": "Novák",
            "street": "Korunní 21",
            "city": "Praha 2",
            "zipcode": "12800",
            "company": ""
        },
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
        "payment": {
            "cod": true,
            "variable_symbol": "1234567890",
            "price": 1001
        },
        "products": [
            {
                "name": "Horké kameny",
                "image": "https://dscdn.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                "code": "DS12345678",
                "ext_code": null,
                "quantity": 3
            }
        ],
        "note": "",
        "tickets": [
            {
                "barcode": "DR0705127648C",
            }
        ],
        "created": "2020-10-28 06:45:23"
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

změna udajů objednávky

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderUpdated",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "number": "FF701392",
        "remote_number": "1",
        "currency_id": "CZK",
        "on_hold": false,
        "recipient": {
            "email": "zakaznik@gmail.com",
            "phone": "777666555",
            "firstname": "Jan",
            "surname": "Novák",
            "street": "Korunní 21",
            "city": "Praha 2",
            "zipcode": "12800",
            "company": ""
        },
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
        "payment": {
            "cod": true,
            "variable_symbol": "1234567890",
            "price": 1001
        },
        "products": [
            {
                "name": "Horké kameny",
                "image": "https://dscdn.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                "code": "DS12345678",
                "ext_code": null,
                "quantity": 3
            }
        ],
        "note": "",
        "tickets": [
            {
                "barcode": "DR0705127648C",
            }
        ],
        "created": "2020-10-28 06:45:23"
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

zrušení objednávky

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderCanceled",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

změna stavu zásilky

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderDeliveryChanged",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

předání objednávky na sklad k expedici

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderPushedToExpedition",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávka byla zabalena a čeká převzetí dopravcem

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderPacked",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávka se vrátila zpět na sklad

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderReturned",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávku nebylo možné odeslat

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderNotSent",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávka byla odeslána

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderSent",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávka byla doručena

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderDelivered",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

obnovení zrušené objednávky

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderRestored",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;

Popis:

objednávka byla přepnuta do stavu čeká na uskladnění

Požadavek webhooku:

POST $endpoint¹ HTTP/1.1
Authorization: $token²
Content-Type: application/json

¹ URL endpoint, nastavený u Vašeho obchodu, na který je objednávka vytvořena

² Váš autorizační API token ze systému dropshipping.cz

Parametry webhooku:

Klíč	Typ	Komentář
`event_id`	`string`	Unikátní identifikátor eventu ve formátu UUID4
`event_type`	`string`	Typ eventu
`data`	`array`	Data eventu
`created`	`string`	Datum a čas vytvoření eventu ve formátu "Y-m-d H:i:s"

Ukázka:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderStatusChangedToWaitingForStorage",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}

Parametry eventu:

Pro detailní popis parametrů v sekci REST API - Objednávky

Očekávaná odpověď:

HTTP/1.1 200
Content-type: application/json;