Zastaralé (deprecated). API V1 je určené jen pro stávající napojení. Nové integrace stavte na kompletním XML exportu, nebo se ozvěte podpoře.

Každý řádek NDJSON souboru je jeden záznam. Číselné hodnoty přicházejí jako řetězce ("count":"219", "tax":"23.00"), příznaky jako "1" / "0", chybějící hodnota jako null. Klíčem záznamu napříč sekcemi data a business je id (číslo karty v DataDepu) a code (kód karty, pod kterým ji zná váš e-shop).

Sekce data

Produktové údaje spárované karty.

Pole Význam
id id karty v DataDepu
project kód projektu, ke kterému karta patří
code kód karty (kód produktu pro e-shop)
name, nameSub název a podnázev
pairValue párovací hodnota karty (typicky EAN nebo kód výrobce)
ean, isbn EAN a ISBN
description, description_short popis a krátký popis (HTML); krátký popis chybí, když je prázdný
manufacturer výrobce
categoryId, categoryPath, categoryExternalId hlavní kategorie e-shopu: id, textová cesta, externí id z e-shopu
categoriesAll všechny kategorie karty jako pole objektů id, name, path, externalid
categoriesOther id dalších kategorií mimo hlavní (jen když existují)
allowed, allowed_date schválení karty a datum schválení
active, isExportable karta je aktivní a splňuje podmínky exportu
optional volitelné hodnoty 1 až 7 z nastavení projektu (jen když jsou vyplněné)
images obrázky jako objekt image{id} → url, urlOriginal, main, name, size, width, height, hash
parameters parametry jako objekt param{id} → groupName (volitelně), titleName, value, mj (jednotka, volitelně)
related související produkty dodavatele (jen když existují)

Zkrácený záznam. Když karta zanikne, přijde v sekci data jen se třemi poli id, code a codeMoved:

  • codeMoved vyplněné = karta byla sloučena do jiné a codeMoved je kód, pod kterým produkt dál žije; přesměrujte na něj,
  • codeMoved je null = karta je vyřazená nebo nemá žádný produkt; produkt z nabídky odeberte.

Sekce business

Obchodní údaje karty, po dodavatelích.

Pole Význam
id, code id a kód karty, stejné jako v sekci data
supplierSet kód dodavatele, který je pro kartu vybraný jako hlavní (podle priorit a dostupnosti)
allowed, active, isExportable stejné příznaky jako v sekci data
suppliers objekt klíčovaný kódem dodavatele (idName ze sekce suppliers), pro každého dodavatele prices, store a volitelně variants

Ceny dodavatele suppliers.{dodavatel}.prices.czk (klíč je vždy czk, hodnoty jsou v měně projektu):

Pole Význam
tax sazba DPH v procentech (21.00, ne 0.21)
price, priceTax nákupní cena bez DPH a s DPH
priceRetail, priceRetailTax doporučená prodejní cena dodavatele bez DPH a s DPH
priceSale, priceSaleTax prodejní cena vypočtená DataDepem podle vaší cenotvorby, bez DPH a s DPH
priceMin, priceMinTax minimální prodejní cena, pokud ji dodavatel stanovuje; jinak null
pricePhe, pricePheTax recyklační poplatek (PHE), pokud existuje; jinak null
rabat rabat dodavatele v procentech
margin marže výsledné prodejní ceny v procentech

Sklad dodavatele suppliers.{dodavatel}.store:

Pole Význam
supplier_code kód produktu u dodavatele
state store = skladem, upcoming = předobjednávka, not = nedostupný
count počet kusů skladem, null když dodavatel počty neposílá
upcomingDate datum naskladnění u předobjednávky
availability, availabilityText, availabilityMin, availabilityMax dostupnost tak, jak ji posílá dodavatel (dny, text, rozsah)
wasAvailable, dateFirstAvailable, dateLastAvailable zda a kdy byl produkt dostupný
note poznámka ke skladu (JSON)

Pokud má produkt varianty, je u dodavatele navíc pole variants se stejnou strukturou prices a store pro každou variantu.

Sekce categories

Strom kategorií e-shopu v DataDepu (ne kategorie dodavatelů).

Pole Význam
id, parentId id kategorie a nadřazené kategorie
project kód projektu
name, namePath, urlPath název, textová cesta a URL cesta
position pořadí v rámci rodiče
active kategorie je aktivní a zařazená
deleted 1 = kategorie byla smazána; záznam přijde v přírůstku, abyste ji odebrali i u sebe

Sekce suppliers

Dodavatelé projektu.

Pole Význam
id, idName id a kód dodavatele; idName je klíč v business.suppliers
project kód projektu
name název
rabat výchozí rabat dodavatele v procentech
invoiceCompany, invoiceStreet, invoiceCity, invoiceZipCode, invoiceIco, invoiceDic, invoiceVat fakturační údaje
persons kontaktní osoby (name, position, email a další)
bankAccounts bankovní účty
note poznámka
deleted 1 = dodavatel byl odstraněn