Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace

Seznam košíků

  • URI: /api/v2/carts
  • HTTP metoda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametry - slouží pro filtrování výstupu:
    • datetime_from (date) - datum od kterého se košíky vrátí
    • language_id (language) - jazyk
    • filled_delivery_info_yn (bool) - pouze košíky s vyplněnými dodacími údaji
    • customer_logged_in_yn (bool) - pouze košíky s přihlášenými zákazníky
    • id (int) - id konkrétního košíku
    • page (int) - stránka, pokud není definováno, vrací vždy stranu 1

Odpověď

Seznam košíků je dostupný po jednotlivých stranách. Výstup je omezen na 100 položek na stránku.

  • tělo:
    • current_page (int) - aktuální strana
    • current_page_items (int) - počet položek na aktuální straně
    • number_of_pages (int) - celkový počet stran
    • number_of_items (int) - celkový počet položek
    • carts (array) - pole objektů s košíky
      • id (int) - ID košíku
      • language (language) - jazyk košíku (identifikuje na jaké jazykové mutaci košík vznikl)
      • datetime (date) - čas poslední aktualizace
      • customer (object) - zákazník
        • email (email) - email zákazníka. Vyplněno pouze pokud má nepřihlášený zákazník již účet, nebo je zákazník přihlášený.
        • voucher_code (string) - kód slevového kuponu zadaného v košíku
        • voucher_type (string) - typ slevového kuponu zadaného v košíku
        • points (int) - body věrnostního systému uplatněné zákazníkem v košíku
        • customer_logged_in_yn (bool) - příznak jestli je zákazník přihlášený
        • filled_delivery_info_yn (bool) - příznak jestli zákazník vyplnil dodací údaje
      • shipment (object) - doprava
        • name (string) - název dopravy
      • payment (object) - platba
        • name (string) - název platby
      • produkty (array) - pole objektů s produkty v košíku
        • id (int) - ID produktu v košíku (nesouhlasí s ID produktu)
        • code (string) - kód produktu
        • variant_code (string) - kód varianty
        • length (string) - metráž
        • quantity (float) - počet jednotek
        • gift_code (string) - kód dárku k produktu
        • gift_variant_code (string) - kód varianty dárku k produktu
        • invoice_info (string) - poznámka k produktu která se propisuje do faktury
        • related_id (int) - vazba na jiný produkt v košíku, viz. funkce Doplňky

Nepomohla Vám tato nápověda?

Požádejte o radu zkušené eshopery v UPgates poradně.

UPgates poradna