Storefront API
Veřejné API pro web e-shopu napojeného na invo.space: katalog, košík, doprava, platba a vytvoření objednávky s tokenem X-Storefront-Token.
Storefront API slouží webu vašeho e-shopu. Načte katalog, spravuje košík, nabídne dopravu a platby a vytvoří objednávku. Základní adresa je https://invo.space/api/storefront/v1 a každý požadavek posílá hlavičku X-Storefront-Token.
Token vytvoříte v E-shop > API tokeny, viz API tokeny pro e-shop. Účet musí mít zapnutý modul E-shop.
Podrobnou referenci endpointů připravujeme. Než bude hotová, celý nákup si vyzkoušíte ve Storefront testeru v E-shop > API tokeny.
Hlavičky
| Hlavička | Kdy |
|---|---|
X-Storefront-Token | Vždy. Identifikuje e-shop a účet. |
X-Cart-Token | U všech požadavků na konkrétní košík (/carts/{id}...). Hodnotu dostanete při založení košíku jako secretToken. |
Průběh nákupu
- Načtěte katalog:
GET /catalog,GET /categories,GET /products(stránkovánílimitaoffset, filtrmainCategoryId),GET /products/{id},GET /skus. - Založte košík:
POST /carts. Odpověď obsahujesecretTokenpro hlavičkuX-Cart-Token. - Přidejte zboží:
POST /carts/{id}/items, upravtePATCH /carts/{id}/items/{itemId}, odeberteDELETE /carts/{id}/items/{itemId}. - Uložte zákazníka:
PATCH /carts/{id}/customer. - Nabídněte dopravu:
GET /delivery-methods, výdejní místaGET /delivery-methods/{type}/pickup-points. Vybranou dopravu uložtePATCH /carts/{id}/delivery. - Nabídněte platbu:
GET /payment-methods, vybranou uložtePATCH /carts/{id}/payment. - Vytvořte objednávku:
POST /carts/{id}/promotion. VrátíorderId,orderUuida číslo objednávkysymbol. Když něco chybí, vrátí400se seznamem chybějících polí, nebo informaci o nedostatku zboží. - U platby kartou získáte adresu platební brány:
POST /orders/{uuid}/card-paymentvrátíredirectUrl.
Aktuální stav košíku včetně součtů načtete GET /carts/{id}.
Objednávka se v invo.space objeví ve Výzvách k platbě. Ceny v košíku se řídí nastavením e-shopu.
Chyby
Chyby mají stejný formát application/problem+json jako hlavní API, viz API pro vývojáře. Chybějící nebo zneplatněný token vrátí 401, vypnutý modul E-shop 403.