1. Strona główna
  2. Dokumentacja
  3. REST API xSale
  4. Obsługa integracji z włas...
  5. Definiowanie parametrów

Definiowanie parametrów

Do ofert tworzonych w xSale możesz przypisać cechy i atrybuty, oparte na parametrach. Parametry są definiowane oddzielnie dla każdej integracji. Ten zasób jest również dostępny dla integracji z własnym sklepem. W tym artykule znajdziesz opis definiowania parametrów i ich przypisywania do kategorii.

Tworzenie definicji parametrów

Parametrów możesz używać do przypisania cech i atrybutów produktów, a także do tworzenia wariantów w obrębie tworzonych ofert. Aby zdefiniować dostępne do wykorzystania parametry oraz ich zastosowanie, użyj endpointu:

POST /{organizationName}/integrations/{id}/categories/{categoryId}/parameters

Prześlij zapytanie na wykorzystując id integracji (id) i id kategorii (categoryId), dla której definiujesz parametry. Podaj nazwę parametru (Name) i zewnętrzne id (ForeigId) oraz wskaż typ tworzonego parametru (Type) (szczegóły poniżej). Zdefiniuj, czy parametr ma być dostępny do wyboru przy tworzeniu ofert wielowariantowych (IsVariantsAllowed), a jeśli tak, to czy ma być dostępny wyłącznie na potrzeby tworzenia wariantów (IsUsedOnlyOnVariantstyp). Powiąż parametr z zewnętrznym id kategorii (ForeignCategoryId), dla której ma być dostępny i określ, czy jego podanie w ofertach tworzonych w obrębie tej kategorii będzie wymagane (IsRequired).

Przykładowe body zapytanie może wyglądać następująco:

{
  „Name”: „Kolor”,
  „Type”: 6,
  „IsVariantsAllowed”: true,
  „ForeignId”: „Kolor”,
  „IsUsedOnlyOnVariants”: false,
  „CategoryRequirements”: [
  {
    „ForeignCategoryId”: „53”,
    „IsRequired”: true
  }
  ] }

Dostępne typy parametrów

Tworząc parametr, wskaż w polu Type odpowiednią wartość liczbową. Wybierz z dostępnych wartości:

  • 1-  String
  • 2 – Decimal
  • 3 – Integer
  • 4 – Datetime
  • 5 – Boolean
  • 6 – List
  • 7 – LocalizedString

Jeśli tworzysz parametr o typie 6 (Lista), musisz dodatkowo określić predefiniowane wartości (PredefinedValues), spośród których można dokonać wyboru przy tworzeniu oferty. Prześlij w zapytaniu tablicę zewnętrznych identyfikatorów wartości (ForeignId) oraz same wartości (Value), na przykład:

„PredefinedValues”: [
  {
    „ForeignId”: „745”,
    „Value”: „Czerwony”
  },
  {
    „ForeignId”: „746”,
    „Value”: „Zielony”
  }
]