Produkty i zdjęcia

Produkty

GET https://{amper_ws}/external/v1/products/
GET https://{amper_ws}/external/v1/products/{id}/

Lista zawiera produkty, które klient może kupić w sklepie B2B: opublikowane, aktywne, dostępne w B2B i w sprzedaży, z asortymentu przypisanego klientowi. Każdy produkt ma cenę netto z cennika klienta. Produkt spoza asortymentu klienta daje przy odczycie pojedynczym odpowiedź 404.

Filtry

Parametr	Przykład	Działanie
ids	?ids=101,205,317	tylko wskazane produkty (ID w AMPER)
category_id	?category_id=12	produkty przypisane bezpośrednio do kategorii
category_ids	?category_ids=12,15	produkty z kategorii i wszystkich ich podkategorii
name__icontains	?name__icontains=bahama	nazwa albo nazwa handlowa zawiera tekst (bez względu na wielkość liter)
short_code__icontains	?short_code__icontains=8502	kod produktu zawiera tekst
isAvailable	?isAvailable=true	tylko produkty, które są na stanie
ordering	?ordering=id	kolejność: id, name, ean, sku, short_code; minus odwraca kolejność (-id)

Filtry łączysz ze sobą i ze stronicowaniem: ?category_ids=12&limit=500&offset=0&ordering=id. Stronicowanie i limity: Stronicowanie, limity i kody odpowiedzi.

Odpowiedź

{
  "id": 1037,
  "name": "BAHAMA zapach samochodowy NASZYJNIK Wild Hibiskus /1szt",
  "friendly_name": "Zapach samochodowy Bahama Wild Hibiskus",
  "short_code": "850267",
  "description": "Zapachy inspirowane wakacjami oraz trendami konsumenckimi.",
  "short_description": "",
  "ean": "5904000850267",
  "sku": "850267",
  "cn_code": "33074900",
  "vat": 23,
  "default_unit_of_measure": "szt.",
  "weight": "0.20",
  "default_price": 25.43,
  "currency_code": "PLN",
  "product_external_id": "850267",
  "list_price": 29.90,
  "cumulative_unit_of_measure": "karton",
  "cumulative_converter": "24.00",
  "can_be_split": true,
  "cumulative_unit_ratio_splitter": "6.00",
  "unit_roundup": false,
  "capacity": null,
  "stock_availability_customer": 1,
  "brand": "Bahama & Co.",
  "manufacturer": "Bahama",
  "attributes": [
    {
      "id": 4,
      "slug": "zapach",
      "name": "Zapach",
      "values": [
        { "id": 31, "name": "Hibiskus", "slug": "hibiskus-31", "selected": true, "icon": null }
      ],
      "color": null,
      "show_on_tile": false
    }
  ],
  "deposit_pack_multiplier": null,
  "deposit_pack_price": null,
  "deposit_pack_type": null
}

Pole	Opis
id	ID produktu w AMPER – używasz go w promocjach (product_id) i w zamówieniu
name, friendly_name	nazwa pełna i nazwa handlowa (krótsza, „przyjazna”)
short_code, sku, ean	kod produktu, SKU, kod EAN
description, short_description	opis i krótki opis
cn_code	kod CN (Nomenklatura scalona)
vat	stawka VAT w procentach
default_unit_of_measure	podstawowa jednostka miary – w niej podajesz ilość w zamówieniu
weight	waga
default_price	cena netto dla klienta – uwzględnia jego cennik i rabaty, bez promocji
currency_code	waluta ceny klienta
list_price	cena katalogowa netto (przed rabatami klienta)
product_external_id	ID produktu w systemie ERP
cumulative_unit_of_measure, cumulative_converter	jednostka zbiorcza (np. karton) i liczba jednostek podstawowych w niej
can_be_split, cumulative_unit_ratio_splitter	czy jednostkę zbiorczą można dzielić i na ile części
unit_roundup	czy zamawiana ilość jest zaokrąglana w górę do kroku jednostki
capacity	pojemność
stock_availability_customer	dostępność dla klienta: ilość na stanie minus rezerwacje, gdy klient ma włączoną opcję Zwracaj rzeczywistą wartość stanów w API i ofertach; 1 (jest na stanie) lub 0, gdy opcja jest wyłączona; zawsze 0, gdy nie jest ustawiona – patrz Stany magazynowe
brand, manufacturer	nazwa marki i producenta
attributes	atrybuty produktu oznaczone w panelu jako widoczne w B2B (opis niżej)
deposit_pack_multiplier, deposit_pack_price, deposit_pack_type	opakowanie zwrotne (kaucja): mnożnik, cena, rodzaj

Pola atrybutu:

Pole	Opis
id, slug, name	ID, identyfikator tekstowy i nazwa atrybutu (np. Zapach)
values	wartości atrybutu dla tego produktu: id, name, slug, selected (zawsze true), icon (adres ikony albo null)
color	kolor etykiety atrybutu albo null
show_on_tile	czy sklep B2B pokazuje atrybut na kafelku produktu

Nazwy atrybutów i ich wartości są tłumaczone według nagłówka Accept-Language.

Ceny, jednostki i promocje

• default_price to cena, którą klient płaci bez promocji. Ceny promocyjne opisują promocje – produkt w promocji wskazuje pole product_id w ich warunkach i nagrodach.
• Ilości (w zamówieniu, w progach promocji) są w jednostce podstawowej (default_unit_of_measure). Jednostka zbiorcza przelicza się przez cumulative_converter: przy cumulative_converter = 24 jeden karton to 24 sztuki.
• Gdy unit_roundup = true, AMPER zaokrągla zamawianą ilość w górę do kroku jednostki – np. przy kroku 6 zamówienie 7 sztuk zmieni się w 12.

Zdjęcia produktów

GET https://{amper_ws}/external/v1/product-files/

Lista zdjęć produktów dostępnych dla klienta.

Parametr	Przykład	Działanie
product	?product=1037	zdjęcia jednego produktu (ID w AMPER)
product_external_id	?product_external_id=850267	zdjęcia jednego produktu (ID w ERP)

Odpowiedź:

{ "product_id": 1037, "image": "https://.../products/850267.jpg", "order": 1, "product_external_id": "850267" }

Pole	Opis
product_id	ID produktu w AMPER
image	adres pliku zdjęcia
order	kolejność – zdjęcie z najniższą wartością jest główne
product_external_id	ID produktu w systemie ERP

Zdjęcia zmieniają się rzadko. Pobieraj pełną listę stronami raz dziennie, a pliki zdjęć ściągaj tylko wtedy, gdy zmienił się adres w image.