Dodawanie rodziny produktowej

Sposób działania

Import rodzin produktowych korzysta z tego samego dwuetapowego endpointu co produkty pojedyncze:

1. POST /import/products/v2/load_data — wgrywa definicje (plik JSON) do bufora danych. continueUpload=1 doklejam kolejne paczki, continueUpload=0 czyści bufor przed wgraniem.

2. POST /import/products/v2/run — przenosi bufor do bazy produkcyjnej.

Podczas przenoszenia system sprawdza, czy dany kod (code wariantu) już istnieje. Jeśli istnieje — zostaje pominięty (import nie nadpisuje istniejących produktów).

Jak wysłać request

Endpoint load_data przyjmuje dane jako multipart/form-data — NIE jako surowe body JSON. Tablica obiektów (definicja rodziny + warianty) jest wysyłana jako plik w polu formularza file. {instancja} = adres API Twojej instancji Saly (np. https://twoja-domena/api).

Krok 1 — token. Wyślij POST na /user/token w formacie application/x-www-form-urlencoded z polami username oraz hasłem. W odpowiedzi otrzymasz access_token — wstaw go do nagłówka autoryzacji (typ Bearer) w kolejnych żądaniach.

Krok 2 — load_data (POST /import/products/v2/load_data), żądanie typu multipart/form-data:

Krok 3 — run (POST /import/products/v2/run): nagłówek Bearer, parametry w query string: truncate_all_products oraz truncate_all_categories (zwykle oba 0). Odpowiedź zawiera report (patrz „Odpowiedź i raport").

Rodzina produktów — dwa obiekty

Rodzinę opisują dwa rodzaje obiektów:

• Definicja rodziny — „parasol": nazwa, cechy różnicujące (col1–col15), kategorie, atrybuty. Nie jest osobno sprzedawanym produktem — nie ma własnej ceny, stanu ani jednostek.

• Wariant rodziny — właściwy, sprzedawalny produkt (ma code, cenę, stan i jednostki sprzedażowe), powiązany z definicją przez family_id i opisany wartościami cech (col1–col15).

Definicja rodziny — dokumentacja pól

Legenda kolumny typ: * wymagane · X znaki · [0-1] 0/1 · [0-9] liczby · R2 liczba z 2 miejscami · JSON · (x) limit znaków.

family

information

metadata

categories

manufacturer

collective_packages (opakowania zbiorcze)

attributes / multimedia

Przykładowy plik — definicja rodziny

[
  {
    "family": {
      "family_id": "IMPORT-RODZIN-1",
      "col1": { "pl": "Kolor", "en": "Color" },
      "col2": { "pl": "Materiał", "en": "Material" },
      "col3": { "pl": "Rozmiar", "en": "Size" }
    },
    "information": {
      "name": { "pl": "MacBook Air 13", "en": "MacBook Air 13" },
      "description": { "pl": "<p>opis rodziny</p>" },
      "is_active": "1",
      "is_promoted": "0"
    },
    "metadata": {
      "metatitle": { "pl": "MacBook Air 13" },
      "keywords": { "pl": "MacBook,Air,13" },
      "metadescription": { "pl": "MacBook Air 13 - najlepsza cena" },
      "slug": { "pl": "MacBook_Air_13" }
    },
    "categories": { "paths": [ { "pl": "Laptopy/Apple/MacBook Air 13" } ] },
    "manufacturer": { "name": "Apple", "logo": "https://www.apple.com/logo.png" },
    "collective_packages": {
      "is_active": "0",
      "is_only_packages": "0",
      "price": { "discount": "10", "is_includes_the_charge": "0" }
    },
    "attributes": { "pl": [ { "Dane techniczne": [ ["Kolor", "czerwony"] ] } ] },
    "multimedia": { "photos": [ "https://example.com/photo1.jpg" ], "files": [] }
  }
]

Wariant rodziny — dokumentacja pól

Wariant to sprzedawalny produkt. Poza polami family ma te same sekcje co produkt pojedynczy: code, price, stock, units itd.

family

code wymagane

additional_code

price

energy_class

stock — stany magazynowe i flaga "stock impact" (na wariancie)

delivery_date — czas dostawy per magazyn (tablica):

package

units — jednostki sprzedażowe i ich ceny (na wariancie)

Sekcja units to tablica jednostek wariantu. Każda jednostka odwołuje się (przez external_id) do jednostki zdefiniowanej w Słownikach → Jednostki sprzedażowe.

Model i ceny jednostek

• Jednostka podstawowa (primary) — baza przeliczeń i jednostka stanu magazynowego; jej rate = 1 (niezmienny).

• rate — ile jednostek podstawowych mieści jedna ta jednostka. Cena jednostki = cena katalogowa (srp_netto) × rate.

• discount — rabat (%) dla tej jednostki.

• minimum_sales_quantity — minimalna ilość zamówienia w tej jednostce (całkowita > 0).

• Jednostka domyślna (default) — wstępnie wybrana; musi być aktywna.

• active — czy jednostka widoczna/wybieralna.

Brak sekcji units — zachowanie słownikowe

Sekcja units jest opcjonalna. Bez niej jednostki wariantu ustawiane są wg flag domyślności w Słowniku, honorowanych niezależnie:

Np. jednostka z Domyślnie aktywna = ON i Domyślnie prezentowana = OFF będzie aktywna, ale NIE domyślna.

Pola jednostki

Przykładowy plik — wariant rodziny

[
  {
    "family": {
      "family_id": "IMPORT-RODZIN-1",
      "variant_name": "IMPORT-RODZIN-1-1",
      "variant_is_active": "1",
      "variant_position": "1",
      "col1": { "pl": "Czarny", "en": "Black" },
      "col2": { "pl": "Tworzywo sztuczne", "en": "Plastic" },
      "col3": { "pl": "M", "en": "M" }
    },
    "code": "5907595646406",
    "additional_code": {
      "ean": "5907595646406",
      "sku": "Mac Book Air 13,3",
      "supplier_product_code": "5907595646406"
    },
    "price": {
      "base_netto": "4000.00",
      "purchase_netto": "3300.99",
      "srp_netto": "4499.99",
      "vat": "23"
    },
    "manufacturer": { "name": "Apple", "logo": "https://www.apple.com/logo.png" },
    "energy_class": {
      "energy_class": "A",
      "energy_label_link": "https://link.pdf",
      "energy_card_information_link": "https://link.pdf"
    },
    "stock": {
      "stock_enabled": "1",
      "delivery_date": [
        { "delivery_format": {"pl": "7 dni"}, "delivery_hour": "168", "warehouse_external_id": "1", "restocking_date": "2025-02-02" }
      ]
    },
    "package": {
      "name": "Euro-pallet",
      "dimensions": { "height": "100.00", "width": "100.00", "length": "100.00", "weight": "10.00" }
    },
    "units": [
      { "external_id": "szt.", "primary_unit": "1", "default_unit": "1", "active": "1", "rate": "1.0",  "discount": "0",  "minimum_sales_quantity": "1" },
      { "external_id": "opk",  "primary_unit": "0", "default_unit": "0", "active": "1", "rate": "10.0", "discount": "10", "minimum_sales_quantity": "1" }
    ]
  }
]

Odpowiedź i raport importu

Import jest nieblokujący — poprawne warianty są importowane, a o problemach z jednostkami dowiesz się z odpowiedzi (batch nie jest odrzucany).

• /load_data zwraca liczniki wgranych wierszy oraz stock_unit_ignored — listę kodów, które przysłały nieobsługiwane pole stock.unit.

• /run zwraca {"status":"ok","report":{...}}, gdzie report zawiera:

  • invalid_units — {product_code, external_id, reason} jednostek odrzuconych (nieznany external_id, nie-całkowite/ujemne minimum_sales_quantity, ujemny rate/discount, wiele jednostek domyślnych);

  • products_without_primary_fallback_applied — warianty, dla których importer automatycznie ustalił jednostkę podstawową;

  • proc_errors — błędy procedury.

Aktualizacja istniejących produktów

Endpoint /import/products/v2/* tylko dodaje. Aby zmienić dane istniejącego wariantu — stock_enabled, ceny, jednostki sprzedażowe — użyj POST /import/product/update:

• Aktualizuje wskazane pola istniejących produktów/wariantów (po code).

• Jednostki — tryb przez units_increase: 0 = zastąp komplet jednostek; 1 = aktualizacja częściowa. Pusta tablica units → istniejące jednostki bez zmian.

• Obowiązują te same reguły integralności jednostek (dokładnie 1 primary, 1 aktywna default).