API Dokumentace

Aktuální "TOKEN" najdete ve Vaší administraci.

REST API

Popis:

seznam vašich objednávek

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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í konkrétní objednávky)
ids array NE ID objednávek (pro zobrazení konkrétních objednávek)
remote_number string NE Číslo objednávky ze systému klienta
status string NE Stav objednávky
created_from string NE Datum vytvoření objednávky OD ve formátu "Y-m-d"
created_to string NE Datum vytvoření objednávky DO ve formátu "Y-m-d"
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": "FF2996255084",
            "remote_number": "123456789",
            "currency_id": "CZK",
            "on_hold": true,
            "status": "problem_in_expedition",
            "status_note": "",
            "expedition": {
                "status": "problem",
                "problem": {
                    "source": "packing",
                    "description": "Produkt není k nalezení.",
                    "solution": NULL,
                    "postponed": true,
                    "photos": [],
                },
            },
            "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://cdn.fulfillment.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                    "code": "DS12345678",
                    "ext_code": null,
                    "quantity": 3
                }
            ],
            "packages": [
                {
                    "id": "edae9cfa-c07f-4e28-ba9b-d6ba3fc90749",
                    "items": [
                        {
                            "variant_id": 123,
                            "code": "DS12345678",
                            "ext_code": "XYZ",
                            "quantity": 3
                        }
                    ]
                }
            ],
            "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
            "damaged": false,
            "note": "Poznámka",
            "tickets": [
                {
                    "barcode": "DR0705127648C",
                    "data": "^XA..."
                }
            ],
            "billing": {
                "fulfillment_price": 29.50,
                "shipping_price": null
            },
            "dispatch_date": "2024-12-21"
            "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
delivery.status string|NULL Stav zásilky
  • inTransit => předáno dopravci
  • 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
status_note Poznámka ke stavu objednávky
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.
expedition.problem.photos Fotografie (pole URL)
Popis:

vkládání objednávek

Úplná adresa:

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

JSON požadavek:

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

1 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)

{
    "idempotency_key": "381e62f7-d11e-4291-97d4-be8a4851d4c2",
    "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,
            "bcx": BCX123456789,
            "quantity": 3
        }
    ],
    "sets": [
        {
            "code": "123456",
            "quantity": 3
        }
    ],
    "eshop": "https://www.uzasne-darky.cz",
    "currency_id": "EUR",
    "on_hold": true,
    "instant_reservation": true,
    "remote_number": "123456789",
    "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "damaged": false,
    "note": "Poznámka",
    "tickets": [
        {
            "barcode": "DR0705127648C",
            "data": "^XA..."
        }
    ],
    "dispatch_date": "2024-12-21"
}

Popis polí požadavku:
Klíč Typ Povinné Komentář
idempotency_key string NE Unikátní identifikátor objednávky z externího systému. Ochrana proti duplicitním zápisům.
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_id1 int|NULL NE ID odběrného místa (ze systému fulfillment.cz). Viz Doručovací metody - odběrné místa
delivery.place_ext_id1 string|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 fulfillment.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[].bcx string|NULL NE BCX kód produktu
products[].quantity int ANO Počet kusů produktu
sets[] array NE Produktové sety
sets[].code string ANO Kód produktového setu
sets[].quantity int ANO Počet kusů produktového setu
eshop string NE URL adresa eshopu (včetně http(s))
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.
instant_reservation bool NE Vytvoření rezervací skladových zásob ihned při vytvoření objednácky. (default = false)
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 fulfillment.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
dispatch_date string|NULL NE Vyplňte v případě, pokud chcete expedici objednávky odložit na konkrétní datum ve formátu "Y-m-d".

1 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": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f"
}
Popis polí odpovědi:
Klíč Typ Komentář
id string UUID objednávky v systému fulfillment.cz
Popis:

editace objednávek

Úplná adresa:

https://client.api.fulfillment.cz/v1/fulfillment/orders/<orderId>

JSON požadavek:

POST https://client.api.fulfillment.cz/v1/fulfillment/orders/<orderId> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 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)

{
    "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
        }
    ],
    "sets": [
        {
            "code": "123456",
            "quantity": 3
        }
    ],
    "eshop": "https://www.uzasne-darky.cz",
    "currency_id": "EUR",
    "on_hold": true,
    "instant_reservation": true,
    "remote_number": "123456789",
    "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "damaged": false,
    "note": "Poznámka",
    "tickets": [
        {
            "barcode": "DR0705127648C",
            "data": "^XA..."
        }
    ],
    "dispatch_date": "2024-12-21"
}

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_id1 int|NULL NE ID odběrného místa (ze systému fulfillment.cz). Viz Doručovací metody - odběrné místa
delivery.place_ext_id1 string|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 fulfillment.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
sets[] array NE Produktové sety
sets[].code string ANO Kód produktového setu
sets[].quantity int ANO Počet kusů produktového setu
eshop string NE URL adresa eshopu (včetně http(s))
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.
instant_reservation bool NE Vytvoření rezervací skladových zásob ihned při vytvoření objednácky. (default = false)
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 fulfillment.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
dispatch_date string|NULL NE Vyplňte v případě, pokud chcete expedici objednávky odložit na konkrétní datum ve formátu "Y-m-d".

1 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": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f"
}
Popis polí odpovědi:
Klíč Typ Komentář
id string UUID objednávky v systému fulfillment.cz
Popis:

odeslání objednávky k expedici

Úplná adresa:

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

JSON požadavek:

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

JSON odpověď:

HTTP/1.1 200

Popis:

zrušení objednávky (změna stavu na "zrušeno")

Úplná adresa:

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

JSON požadavek:

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

JSON odpověď:

HTTP/1.1 200


Popis:

seznam produktů

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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,
                    "size_id": A4,
                    "name": "červené",
                    "code": "DS12345678",
                    "ext_code": "xyz",
                    "ean": "...",
                    "clearance": false,
                    "price_purchase": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://cdn.fulfillment.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,
                    "size_id": A4,
                    "name": "černé",
                    "code": "DS12345679",
                    "ext_code": "xzy",
                    "ean": "...",
                    "clearance": false,
                    "price_purchase": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://cdn.fulfillment.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.size_id string|NULL Velikost manipulační jednotky
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.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.price_purchase 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.fulfillment.cz/v1/fulfillment/products

JSON požadavek:

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

1 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)

{
    "category_id": 1,
    "name": "Horké kameny",
    "variant_name": "červené",
    "ext_code": "xyz",
    "ean": "...",
    "clearance": false,
    "description": "Popis",
    "description_html": "<strong>Popis</strong>",
    "price_purchase": 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
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
        "variant_code": "DS12345678"
    }
}
Popis polí odpovědi:
Klíč Typ Komentář
id int Id produktu v systému fulfillment.cz
variant_id int Id varianty v systému fulfillment.cz
variant_code string Kód varianty v systému fulfillment.cz
Popis:

editace produktu

Úplná adresa:

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

JSON požadavek:

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

1 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)

{
    "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": ""
}

Popis:

seznam produktových kategorií

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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.fulfillment.cz/v1/fulfillment/product-categories

JSON požadavek:

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

1 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)

{
    "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 fulfillment.cz
Popis:

editace kategorie

Úplná adresa:

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

JSON požadavek:

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

1 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)

{
    "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.fulfillment.cz/v1/fulfillment/product-categories/<id>

JSON požadavek:

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

1 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)


JSON odpověď:

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

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

Popis:

seznam variant konkrétního produktu

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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,
            "size_id": A4,
            "name": "červené",
            "code": "DS12345678",
            "ext_code": "xyz",
            "ean": "...",
            "clearance": false,
            "price_purchase": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://cdn.fulfillment.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,
            "size_id": A4,
            "name": "černé",
            "code": "DS12345679",
            "ext_code": "xzy",
            "ean": "...",
            "clearance": false,
            "price_purchase": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://cdn.fulfillment.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
size_id string|NULL Velikost manipulační jednotky
name string Název varianty
code string DS kód varianty
ext_code string Váš kód varianty
ean string EAN varianty
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
price_purchase 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.fulfillment.cz/v1/fulfillment/products/<productId>/variants

JSON požadavek:

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

1 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)

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "clearance": true,
    "price_purchase": 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
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 fulfillment.cz
Popis:

editace varianty

Úplná adresa:

https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id> (alias: https://client.api.fulfillment.cz/v1/fulfillment/variants/<id>)

JSON požadavek:

POST https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id> (alias: https://client.api.fulfillment.cz/v1/fulfillment/variants/<id>) HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 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)

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "clearance": true,
    "price_purchase": 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
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.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id>

JSON požadavek:

PATCH https://client.api.fulfillment.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": ""
}

Popis:

galerie konkrétního produktu

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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://cdn.fulfillment.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.fulfillment.cz/v1/fulfillment/products/<productId>/images

JSON požadavek:

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

1 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)

{
    "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://cdn.fulfillment.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.fulfillment.cz/v1/fulfillment/products/<productId>/images/<id>

JSON požadavek:

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

1 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)


JSON odpověď:

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

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

Popis:

seznam variant na skladě

Úplná adresa:

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

JSON požadavek:

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

Popis parametrů požadavku:
Klíč Typ Povinné Komentář
variant_id string NE ID varianty (pro zobrazení pouze konkrétní varianty)
variant_ids array NE ID variant (pole)
quantity_from int NE Počet nepoškozených kusů skladem >= quantity_from.
damaged_quantity_from int NE Počet poškozených kusů skladem >= damaged_quantity_from.
total_quantity_from int NE Počet poškozených nebo nepoškozených kusů skladem >= total_quantity_from.
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": [
        {
            "variant_id": 1887274,
            "code": "DS62202039",
            "ext_code": "123",
            "quantity": 3,
            "available_quantity": 2,
            "damaged_quantity": 0,
            "reserved_quantity": 1,
            "requested_quantity": 0,
            "price_per_unit": 99
        }
    ]
}
Popis polí odpovědi:
Klíč Typ Komentář
variant_id int Id varianty ze systému fulfillment.cz
code string Kód varianty ze systému fulfillment.cz
code string Váš kód varianty
quantity int Počet kusů skladem nepoškozeno celkem (pro dostupný počet kusů nezapomeňte odečíst "reserved_quantity")
available_quantity int Dostupný počet volných kusů skladem nepoškozeno celkem. Počet kusů po odečtení rezervací a žádostí (může nabývat záporných hodnot).
damaged_quantity int Počet poškozených kusů skladem celkem
reserved_quantity int Počet rezervovaných kusů pro nevyřízené objednávky
requested_quantity int Počet žádostí (ks) o variantu pro nevyřízené objednávky
price_per_unit float|NULL Průměrná cena za kus

Popis:

seznam předskladnění

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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 předskladnění
ids array NE ID množiny předskladnění
uuid string NE UUID4 předskladnění
uuids array NE UUID4 množiny předskladnění
ext_id string NE Externí identifikátor předskladnění
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,
            "uuid": "7b73a4a1-ef89-4574-9321-d4134414ced5",
            "ext_id": "38582ff4-b6ce-4a1e-acfb-5085b73fdbf1",
            "closed": true,
            "extra_cost": 0,
            "note": "poznámka",
            "receiving_note": "poznámka k naskladnění",
            "date_of_delivery": "2024-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://cdn.fulfillment.cz/images/9/3/4/f/a/a/e/a/1/0/b31ea2df5b933d6cf9b661.png"]
                }
            ],
            "packages": [
                {
                    "size_id": "L1" // DEPRICATED
                    "barcode": "123456789"
                }
            ],
            "delivery_units": [
                {
                    "id": "d323b5e9-bab6-4d67-9550-0b93b63c8265",
                    "size_id": "L1",
                    "closed": false,
                }
            ],
            "notes": [
                {
                    "text": "Text poznamky"
                    "created": "2022-01-31 08:01:01"
                }
            ],
            "received_at": "2022-03-04"
        }
    ]
}
Popis polí odpovědi:
Klíč Typ Komentář
id int ID předskladnění
uuid string UUID4 předskladnění
ext_id string|NULL Externí identifikátor předskladnění (např. číslo Příjemky z ERP)
closed bool Je předskladnění uzavřeno?
extra_cost float Náklady naskladnění bez DPH
note string Poznámka
receiving_note string Poznámka k naskladnění. Depricated - pro poznámky k naskladnění viz notes[]
date_of_delivery string Předpokládaný datum dodání
items[].variantId int Id produktu ze systému fulfillment.cz
items[].code string Kód produktu ze systému fulfillment.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[].size_id string|NULL Velikost balíku (DEPRICATED)
packages[].barcode string Sledovací číslo balíku
delivery_units array Seznam naskladněných balíku
delivery_units[].id string UUID4 balíku
delivery_units[].size_id string|NULL Velikost balíku
delivery_units[].closed bool Bylo naskladnění balíku definitivně uzavřeno?
notes[].text string Text poznámky
notes[].created string Datum a čas vytvoření poznámky (Y-m-d H:i:s)
received_at string|NULL Datum posledního naskladnění (Y-m-d)
Popis:

vytváření předskladnění

Úplná adresa:

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

JSON požadavek:

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

1 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)

{
    "ext_id": "ba73abe4-a101-4c9c-9f05-592d0761bb83",
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2024-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ář
ext_id string|NULL NE Externí identifikátor předskladnění (např. číslo Příjemky z ERP)
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 fulfillment.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 fulfillment.cz
Popis:

editace předskladnění

Úplná adresa:

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

JSON požadavek:

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

1 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)

{
    "ext_id": "ba73abe4-a101-4c9c-9f05-592d0761bb83",
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2024-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ář
ext_id string|NULL NE Externí identifikátor předskladnění (např. číslo Příjemky z ERP)
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 fulfillment.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.fulfillment.cz/v1/fulfillment/warehouse-preloads/<id>

JSON požadavek:

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

1 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)


JSON odpověď:

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

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

Popis:

seznam žádostí

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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 žádosti
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": "2024-12-31",
            "created": "2024-12-31 12:12:12",
        }
    ]
}
Popis polí odpovědi:
Klíč Typ Komentář
id int ID žádosti
variant_id int Id produktu ze systému fulfillment.cz
variant_code string Kód produktu ze systému fulfillment.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.fulfillment.cz/v1/fulfillment/warehouse-requests/<id>

JSON požadavek:

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

1 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)

{
    "date_of_delivery": "2024-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": ""
}

Popis:

seznam pohybů

Úplná adresa:

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

JSON požadavek:

GET https://client.api.fulfillment.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 int NE ID pohybu
idFrom int NE ID pohybu od (ID je stoupajicí celé čislo...).
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": null,
            "order_id": null,
            "order_number": null,
            "b2b_order_id": null,
            "stock_taking_id": null,
            "fulfillment_order_id": null,
            "preload_id": 1751,
            "reload_id": null,
            "price_per_unit": 99.99,
            "extra_cost_per_unit": 0.0,
            "quantity": 3,
            "damaged_quantity": 0,
            "created": "2024-12-31 12:12:12",
        }
    ]
}
Popis polí odpovědi:
Klíč Typ Komentář
id int Id pohybu
variant_id int Id varianty ze systému fulfillment.cz
movement string Směr pohybu ("in"|"out")
reason obj|NULL Důvod pohybu (pokud je hodnota NULL, důvod nebyl specifikován)
reason.id int ID důvodu pohybu
reason.name string Název důvodu pohybu
order_id int|NULL Id dropshippingové objednávky
order_number string|NULL Číslo dropshippingové objednávky
b2b_order_id int|NULL Id B2B objednávky
stock_taking_id string|NULL Id inventury ve formátu UUID4
fulfillment_order_id string|NULL Id fulfillmentové objednávky ve formátu UUID4 (IN = naskladnění vratky; OUT = vyskladnění objednávky)
preload_id int|NULL Id předskladnění
reload_id int|NULL Id transformace
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ů
damaged_quantity int Počet poškozených kusů
created string Datum a čas vytvoření ve formátu "Y-m-d H:i:s"

Popis:

seznam aktivních doručovacích metod

Úplná adresa:

https://client.api.fulfillment.cz/v1/fulfillment/deliveries

JSON požadavek:

GET https://client.api.fulfillment.cz/v1/fulfillment/deliveries 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": "Česká pošta",
            "price": 87.23, // Depricated
            "price_vat": 89, // Depricated
            "price_atyp": null, // Depricated
            "price_atyp_vat": null, // Depricated
            "price_oversized": null, // Depricated
            "price_oversized_vat": null, // Depricated
            "vat": 21, // Depricated
            "has_place": 1,
            "permitted_payment": ["1","2"] // Depricated
        }
    ]
}
Popis polí odpovědi:
Klíč Typ Komentář
id int ID doručovací metody
name string Název
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"

Popis:

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

Úplná adresa:

https://client.api.fulfillment.cz/v1/fulfillment/delivery-places?deliveryId=10&limit=30&offset=0

JSON požadavek:

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

Popis parametrů požadavku:
Klíč Typ Povinné Komentář
deliveryId 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; 

{
    "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 fulfillment.cz)
ext_id string 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

WEBHOOKs

Popis:

vytvoření objednávky

Požadavek webhooku:

POST $endpoint1 HTTP/1.1
Authorization: $token2
Content-Type: application/json

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

2 Váš autorizační API token ze systému fulfillment.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",
        "warehouse_id": "677bb033-e50e-4ddf-8a5c-97817314e650",
        "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://cdn.fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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://cdn.fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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",
        "note": "Nadrozměr",
    },
    "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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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 $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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;



	

	

Popis:

objednávka byla přepnuta do vytvořeno. Z pravidla při nutnosti upravit objednávku na základě problému v expedici.


Požadavek webhooku:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




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


2 Váš autorizační API token ze systému fulfillment.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": "OrderStatusChangedToCreated",
    "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;