Všeobecné informace
API
REST API zabezpečeno protokolem HTTPS
HTTP Metody
- GET - vrací data - neprovádí žádné změny
- POST - odesílá nová data
- PUT - aktuazlizace data
- DELETE - odstraňuje data
HTTP Kódy
- 200 - OK
- 400 - Bad Request
- 401 - Unauthorized
- 404 - Not Found
- 409 - Conflict
- 422 - Unprocessable Entity - Data validation error
- 500 - Server Error
Ukázka response 422 - Unprocessable Entity
{
"status": "error",
"code": 422,
"message": "Request body contains an error. See context for details.",
"context": {
"validation": {
"productBarcodes": [
"This value should not be blank."
],
"productImagesUrl": [
"This value should not be blank."
]
}
}
}
Data JSON
Všechna data formátu JSON a kódování UTF-8. Header Content-Type: application/json
Datové typy
Datové typy jednotlivých atributů těla requestu zjistíte v popisu každého EP, v části Request Body, odkaz Schema. Nepovinné atributy jsou označeny příznakem nullable
API EP
Produkce: https://app.log4u.cz/
Autorizace request
Každý request musí obsahovat 3 povinné hlavičky:1. Header
Client-Key, jejiž hodnota musí obsahovat řetězec poskytnutého API klíče partnera 2. Header
Authorization-Token, která musí obsahovat vypočtený token3. Header
Content-Type, s hodnotou application/json.Výpočet tokenu
base64_encode(hash_hmac('sha1',
API_SECRET,
API_KEY . REQUEST_METHOD[GET, POST, DELETE ...] . date('Y-m-d H:i')));
Hlavička
Accept s hodnotou application/jsonChyba autorizace requestu je oznámena návratovým status kódem
401 se zprávou: Invalid request token or headers
Změny
4.4.2024 - GET Product - doplnění response o atribut
7.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
9.4.2024 - GET Detail výdejky - doplnění response o atribut
20.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
22.4.2024 - POST Product import - doplnění response o atributy parametrů pro celní řízení
24.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
24.4.2024 - PATCH Předání k expedici - doplněn nový EP
09.5.2024 - GET Product List - doplněn nový EP
14.5.2024 - POST Zakázky expedice import - doplnění requestu o atribut
14.5.2024 - POST Product (import, update) - doplnění requestu o atribut
24.6.2024 - GET Detail výdejky - doplnění response o atribut
27.9.2024 - POST Import drop data - doplněn nový EP pro potřeby vyskladňování DROP zakázek.
14.10.2024 - GET Detail výdejky - doplnění response o pole objektů[]
disponibleCount7.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
(float) shipmentValue9.4.2024 - GET Detail výdejky - doplnění response o atribut
(int) stockStatus - číselník statusů níže20.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
(string) stateOrProvinceCode22.4.2024 - POST Product import - doplnění response o atributy parametrů pro celní řízení
(string) duty_code (string) title_en (string) description_en24.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut
(bool) moveToDispatch24.4.2024 - PATCH Předání k expedici - doplněn nový EP
09.5.2024 - GET Product List - doplněn nový EP
14.5.2024 - POST Zakázky expedice import - doplnění requestu o atribut
(string) pickupPointCarrierId14.5.2024 - POST Product (import, update) - doplnění requestu o atribut
(array) dutyCodes. Náhrada za původní parametr dutyCode24.6.2024 - GET Detail výdejky - doplnění response o atribut
(object) shipmentStatus.27.9.2024 - POST Import drop data - doplněn nový EP pro potřeby vyskladňování DROP zakázek.
14.10.2024 - GET Detail výdejky - doplnění response o pole objektů[]
(array) attachments.ČÍSELNÍKY
Výdejky - Číselník důvodů
| ID | DESCRIPTION |
|---|---|
| prodej | vzniká na základě objednávky přijaté |
| reklamace | vzniká na základě vyřízené reklamace |
Výdejka - Číselník skladových stavů [stockStatus]
| ID | STAV | INFO |
|---|---|---|
| 0 | Vytvořená | |
| 1 | Čeká na vyskladnění | |
| 2 | Vyskladňuje se | |
| 3 | Čeká na balení | |
| 4 | Probíhá balení | |
| 5 | Chyba balení | |
| 6 | Zabalená |
Výdejka - Číselník stavů zásilky [shipmentStatus::status]
| STATUS | INFO |
|---|---|
| delivered | Zásilka doručená příjemci |
| returned | Zásilka vrácená na sklad |
Kódy států
| KÓD | STÁT |
|---|---|
| CZ | Czech Republic |
| SK | Slovakia |
| HU | Hungary |
| AX | Åland Islands |
| AL | Albania |
| AD | AndorrA |
| AT | Austria |
| BY | Belarus |
| BE | Belgium |
| BA | Bosnia and Herzegovina |
| BG | Bulgaria |
| HR | Croatia |
| CY | Cyprus |
| DK | Denmark |
| EE | Estonia |
| FO | Faroe Islands |
| FI | Finland |
| FR | France |
| DE | Germany |
| GI | Gibraltar |
| GR | Greece |
| GG | Guernsey |
| VA | Holy See (Vatican City State) |
| IS | Iceland |
| IE | Ireland |
| IM | Isle of Man |
| IT | Italy |
| JE | Jersey |
| LV | Latvia |
| LI | Liechtenstein |
| LT | Lithuania |
| LU | Luxembourg |
| MK | Macedonia, The Former Yugoslav Republic of |
| MT | Malta |
| MD | Moldova, Republic of |
| MC | Monaco |
| NL | Netherlands |
| NO | Norway |
| PL | Poland |
| PT | Portugal |
| RO | Romania |
| RU | Russian Federation |
| SM | San Marino |
| CS | Serbia and Montenegro |
| SI | Slovenia |
| ES | Spain |
| SJ | Svalbard and Jan Mayen |
| SE | Sweden |
| CH | Switzerland |
| TR | Turkey |
| UA | Ukraine |
| GB | United Kingdom |
| AF | Afghanistan |
| DZ | Algeria |
| AS | American Samoa |
| AO | Angola |
| AI | Anguilla |
| AQ | Antarctica |
| AG | Antigua and Barbuda |
| AR | Argentina |
| AM | Armenia |
| AW | Aruba |
| AU | Australia |
| AZ | Azerbaijan |
| BS | Bahamas |
| BH | Bahrain |
| BD | Bangladesh |
| BB | Barbados |
| BZ | Belize |
| BJ | Benin |
| BM | Bermuda |
| BT | Bhutan |
| BO | Bolivia |
| BW | Botswana |
| BV | Bouvet Island |
| BR | Brazil |
| IO | British Indian Ocean Territory |
| BN | Brunei Darussalam |
| BF | Burkina Faso |
| BI | Burundi |
| KH | Cambodia |
| CM | Cameroon |
| CA | Canada |
| CV | Cape Verde |
| KY | Cayman Islands |
| CF | Central African Republic |
| TD | Chad |
| CL | Chile |
| CN | China |
| CX | Christmas Island |
| CC | Cocos (Keeling) Islands |
| CO | Colombia |
| KM | Comoros |
| CG | Congo |
| CD | Congo, The Democratic Republic of the |
| CK | Cook Islands |
| CR | Costa Rica |
| CI | Cote D'Ivoire |
| CU | Cuba |
| DJ | Djibouti |
| DM | Dominica |
| DO | Dominican Republic |
| EC | Ecuador |
| EG | Egypt |
| SV | El Salvador |
| GQ | Equatorial Guinea |
| ER | Eritrea |
| ET | Ethiopia |
| FK | Falkland Islands (Malvinas) |
| FJ | Fiji |
| GF | French Guiana |
| PF | French Polynesia |
| TF | French Southern Territories |
| GA | Gabon |
| GM | Gambia |
| GE | Georgia |
| GH | Ghana |
| GL | Greenland |
| GD | Grenada |
| GP | Guadeloupe |
| GU | Guam |
| GT | Guatemala |
| GN | Guinea |
| GW | Guinea-Bissau |
| GY | Guyana |
| HT | Haiti |
| HM | Heard Island and Mcdonald Islands |
| HN | Honduras |
| HK | Hong Kong |
| IN | India |
| ID | Indonesia |
| IR | Iran, Islamic Republic Of |
| IQ | Iraq |
| IL | Israel |
| JM | Jamaica |
| JP | Japan |
| JO | Jordan |
| KZ | Kazakhstan |
| KE | Kenya |
| KI | Kiribati |
| KP | Korea, Democratic People'S Republic of |
| KR | Korea, Republic of |
| KW | Kuwait |
| KG | Kyrgyzstan |
| LA | Lao People'S Democratic Republic |
| LB | Lebanon |
| LS | Lesotho |
| LR | Liberia |
| LY | Libyan Arab Jamahiriya |
| MO | Macao |
| MG | Madagascar |
| MW | Malawi |
| MY | Malaysia |
| MV | Maldives |
| ML | Mali |
| MH | Marshall Islands |
| MQ | Martinique |
| MR | Mauritania |
| MU | Mauritius |
| YT | Mayotte |
| MX | Mexico |
| FM | Micronesia, Federated States of |
| MN | Mongolia |
| MS | Montserrat |
| MA | Morocco |
| MZ | Mozambique |
| MM | Myanmar |
| NA | Namibia |
| NR | Nauru |
| NP | Nepal |
| AN | Netherlands Antilles |
| NC | New Caledonia |
| NZ | New Zealand |
| NI | Nicaragua |
| NE | Niger |
| NG | Nigeria |
| NU | Niue |
| NF | Norfolk Island |
| MP | Northern Mariana Islands |
| OM | Oman |
| PK | Pakistan |
| PW | Palau |
| PS | Palestinian Territory, Occupied |
| PA | Panama |
| PG | Papua New Guinea |
| PY | Paraguay |
| PE | Peru |
| PH | Philippines |
| PN | Pitcairn |
| PR | Puerto Rico |
| QA | Qatar |
| RE | Reunion |
| RW | RWANDA |
| SH | Saint Helena |
| KN | Saint Kitts and Nevis |
| LC | Saint Lucia |
| PM | Saint Pierre and Miquelon |
| VC | Saint Vincent and the Grenadines |
| WS | Samoa |
| ST | Sao Tome and Principe |
| SA | Saudi Arabia |
| SN | Senegal |
| SC | Seychelles |
| SL | Sierra Leone |
| SG | Singapore |
| SB | Solomon Islands |
| SO | Somalia |
| ZA | South Africa |
| GS | South Georgia and the South Sandwich Islands |
| LK | Sri Lanka |
| SD | Sudan |
| SR | Suriname |
| SZ | Swaziland |
| SY | Syrian Arab Republic |
| TW | Taiwan, Province of China |
| TJ | Tajikistan |
| TZ | Tanzania, United Republic of |
| TH | Thailand |
| TL | Timor-Leste |
| TG | Togo |
| TK | Tokelau |
| TO | Tonga |
| TT | Trinidad and Tobago |
| TN | Tunisia |
| TM | Turkmenistan |
| TC | Turks and Caicos Islands |
| TV | Tuvalu |
| UG | Uganda |
| AE | United Arab Emirates |
| US | United States |
| UM | United States Minor Outlying Islands |
| UY | Uruguay |
| UZ | Uzbekistan |
| VU | Vanuatu |
| VE | Venezuela |
| VN | Viet Nam |
| VG | Virgin Islands, British |
| VI | Virgin Islands, U.S. |
| WF | Wallis and Futuna |
| EH | Western Sahara |
| YE | Yemen |
| ZM | Zambia |
| ZW | Zimbabwe |
Typy dokumentů
| TYP | DESCRIPTION |
|---|---|
| pick_invoice | Faktura k vyskladňovací zakázce |
Typy souborů
| TYP |
|---|
| application/pdf |
| application/x-pdf |
| image/gif |
| image/png |
| image/jpeg |
| image/jpg |
Typy dropshipmentu
| dropType |
|---|
| alza |
Atributy položek dropshipmentu
| productAttribute NAME |
|---|
| BCX |
| ITEM_ID |