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ý token
3. 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/json
Chyba 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 disponibleCount
7.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut (float) shipmentValue
9.4.2024 - GET Detail výdejky - doplnění response o atribut (int) stockStatus - číselník statusů níže
20.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut (string) stateOrProvinceCode
22.4.2024 - POST Product import - doplnění response o atributy parametrů pro celní řízení (string) duty_code (string) title_en (string) description_en
24.4.2024 - POST Zakázky expedice import - doplnění requestu o atribut (bool) moveToDispatch
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 (string) pickupPointCarrierId
14.5.2024 - POST Product (import, update) - doplnění requestu o atribut (array) dutyCodes. Náhrada za původní parametr dutyCode
24.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
AL Albania
AT Austria
AU Australia
BY Belarus
BE Belgium
BA Bosnia and Herzegovina
BG Bulgaria
CA Canada
HR Croatia
CY Cyprus
DK Denmark
FI Finland
FR France
DE Germany
EE Estonia
GR Greece
IE Ireland
IL Israel
IT Italy
LI Liechtenstein
LT Lithuania
LU Luxembourg
LV Latvia
MT Malta
MC Monaco
NL Netherlands
NO Norway
PL Poland
PT Portugal
RO Romania
RU Russian Federation
SM San Marino
SI Slovenia
ES Spain
SE Sweden
CH Switzerland
TR Turkey
UA Ukraine
GB United Kingdom
US United States

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