API Dokumentace pro dodavatele

Webhooky

Pokud chcete použít propojení pomocí webhooků, kontaktujte prosím naši technickou podporu: pomocnik@dropshipping.cz tel: 601 550 371

Popis:

vytvoření objednávky v systému dropshipping.cz

Požadavek webhooku:

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

1 URL endpoint, který jste nám předali při aktivaci webhooků

2 Autorizační token, který jste nám předali při aktivaci webhooků

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": "OrderCreated",
    "data": {
        "id": 1,
        "hash": "5y7p7hszrrsr229wy28c6zkokj16y14ytpaznw6nqu37d1xrs5yeu55czoj8gpzc",
        "number": "10-0001",
        "paid": false,
        "recipient": {
            "firstname": "John",
            "surname": "Doe"
        },
        "products": [
            {
                "id": "123",
                "code": "xyz",
                "quantity": 3,
                "price": 19.99
            }
        ],
        "note": "",
    }
}
Parametry eventu:
Klíč Typ Komentář
id int ID objednávky ze systému dropshipping.cz
hash string Hash objednávky ze systému dropshipping.cz, nutný ke komunikaci s Open API (viz níže)
number string Číslo objednávky ze systému dropshipping.cz
paid bool Byla objednávka zaplacena nebo čeká na zaplacení?
recipient.firstname string Jméno zákazníka objednávky
recipient.surname string Příjmení zákazníka objednávky
products.id string ID produktu ze systému dodavatele
products.code string Kód produktu ze systému dodavatele
products.quantity int Počet kusů produktu
products.price float Cena produktu bez DPH
note string Poznámka objednávky
Popis:

Informace o zaplacení objednávky v případě objednávky s platbou předem

Požadavek webhooku:

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

1 URL endpoint, který jste nám předali při aktivaci webhooků

2 Autorizační token, který jste nám předali při aktivaci webhooků

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": "OrderCreated",
    "data": {
        "id": 1,
        "hash": "5y7p7hszrrsr229wy28c6zkokj16y14ytpaznw6nqu37d1xrs5yeu55czoj8gpzc",
        "number": "10-0001"
    }
}
Parametry eventu:
Klíč Typ Komentář
id int ID objednávky ze systému dropshipping.cz
hash string Hash objednávky ze systému dropshipping.cz, nutný ke komunikaci s Open API (viz níže)
number string Číslo objednávky ze systému dropshipping.cz
Popis:

Informace o zrušení objednávky v systému dropshipping.cz. Objednávka může být v budoucnu opět přepnuta k expedici a dojde k opětovnému eventu OrderCreated.

Požadavek webhooku:

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

1 URL endpoint, který jste nám předali při aktivaci webhooků

2 Autorizační token, který jste nám předali při aktivaci webhooků

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": "OrderCreated",
    "data": {
        "id": 1,
        "hash": "5y7p7hszrrsr229wy28c6zkokj16y14ytpaznw6nqu37d1xrs5yeu55czoj8gpzc",
        "number": "10-0001"
    }
}
Parametry eventu:
Klíč Typ Komentář
id int ID objednávky ze systému dropshipping.cz
hash string Hash objednávky ze systému dropshipping.cz, nutný ke komunikaci s Open API (viz níže)
number string Číslo objednávky ze systému dropshipping.cz

API

Popis:

potvrzení objednávky

Úplná adresa:

https://partner.api.dropshipping.cz/open/orders/<id>/accept?hash=<hash>

JSON požadavek:

POST https://partner.api.dropshipping.cz/open/orders/<id>/accept?hash=<hash> HTTP/1.1
Accept: application/json

Popis parametrů požadavku:
Klíč Typ Povinné Komentář
id int ANO ID objednávky za systému dropshipping.cz
hash string ANO Hash objednávky za systému dropshipping.cz
JSON odpověď:

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

{
    "message": "",
    "data": {
        "shipping": {
            "number": "88750593175",
            "ticket": "https://partner.api.dropshipping.cz/open/orders/27/ticket?hash=jc6k2djo5nalmewp0kwbzhthqheh0nloxnp30yy8yum82gpe4da57utvsh0sh499"
        }
    }
}
Popis polí odpovědi:
Klíč Typ Komentář
shipping.number string Sledovací číslo zásilky
shipping.ticket string Odkaz pro stažení PDF štítku
Popis:

zamítnutí v případě, kdy některý z produktů objednávky není aktuálně skladem

Úplná adresa:

https://partner.api.dropshipping.cz/open/orders/<id>/deny?hash=<hash>

JSON požadavek:

POST https://partner.api.dropshipping.cz/open/orders/<id>/deny?hash=<hash> HTTP/1.1
Accept: application/json

Popis parametrů požadavku:
Klíč Typ Povinné Komentář
id int ANO ID objednávky za systému dropshipping.cz
hash string ANO Hash objednávky za systému dropshipping.cz
Popis polí požadavku: 
{
    "products": [
        {
            "code": "17702605",
            "quantity": 1,
            "delivery_date": "2024-31-12"
        }
    ],
    "note": "Poznámka"
}

Klíč Typ Povinné Komentář
products.code string ANO Kód produktu ze systémá dodavatele
products.quantity int ANO Počet kusů aktuálně skladem
products.delivery_date string|NULL ANO Datum naskladnění chybějích kusů produktů ve formátu "yyyy-mm-dd"
note string NE Poznámka, upřesňující informace k zamitnutí objednávky
JSON odpověď:

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

Popis:

získání spedičních štítků objednávky v PDF formátu

Úplná adresa:

https://partner.api.dropshipping.cz/open/orders/<id>/ticket?hash=<hash>

JSON požadavek:

POST https://partner.api.dropshipping.cz/open/orders/<id>/ticket?hash=<hash> HTTP/1.1
Accept: application/json

Popis parametrů požadavku:
Klíč Typ Povinné Komentář
id int ANO ID objednávky za systému dropshipping.cz
hash string ANO Hash objednávky za systému dropshipping.cz
format string NE Formát PDF štítku. "default" pro tisk na formát A4. "single" pro tisk štítků na kotouč
JSON odpověď:

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

{
    "message": "",
    "data": {
        "number": "88750593175",
        "pdf": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago..."
    }
}
Popis polí odpovědi:
Klíč Typ Komentář
number string Sledovací číslo zásilky
pdf string PDF štítku jako base64 encode string.