Parametry

více o produktech v Upgates e-shopech naleznete zde.
názvy parametrů a hodnot parametrů a musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.

Detail parametru

GET

/api/v2/parameters/{id}

Detail parametru › path Parameters

id

integer · required

ID parametru

Detail parametru › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

GET/api/v2/parameters/{id}

curl /api/v2/parameters/:id

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "parameters": [
    {
      "id": 0,
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "image": {
            "id": 0,
            "url": "https://www.example.com/path/to/resource"
          },
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}

json

application/json

Seznam parametrů

GET

/api/v2/parameters

Seznam parametrů › query Parameters

ids

QueryParameterArrayInt

ID parametru oddělené středníkem ; nebo jako pole

without_values_yn

string

Pokud TRUE nevrací hodnoty parametrů. Možné použí při velkém množství hodnot parametrů. Hodnoty lze stahovat přes samostatný endpoint

language

Language

Vrací popisky pouze v jazyku

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam parametrů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

GET/api/v2/parameters

curl /api/v2/parameters

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "parameters": [
    {
      "id": 0,
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "image": {
            "id": 0,
            "url": "https://www.example.com/path/to/resource"
          },
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}

json

application/json

Aktualizace parametrů

PUT

/api/v2/parameters

Aktualizace parametrů › Request Body

object[]

pole objektů s parametry

Aktualizace parametrů › Responses

200

object[]

PUT/api/v2/parameters

curl /api/v2/parameters \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "parameters": [
    {
      "id": 0,
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}'

Example Request Body

{
  "parameters": [
    {
      "id": 0,
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}

json

Example Responses

{
  "parameters": [
    {
      "id": 0,
      "created_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření parametrů

POST

/api/v2/parameters

Názvy parametrů a hodnot parametrů musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.

Vytvoření parametrů › Request Body

object[]

pole objektů s parametry

Vytvoření parametrů › Responses

200

object[]

POST/api/v2/parameters

curl /api/v2/parameters \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "parameters": [
    {
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}'

Example Request Body

{
  "parameters": [
    {
      "descriptions": [
        {
          "language": "cs",
          "name": "name"
        }
      ],
      "values": [
        {
          "descriptions": [
            {
              "language": "cs",
              "value": "value"
            }
          ],
          "position": 0
        }
      ],
      "position": 0,
      "display_type": "select",
      "display_in_product_list_yn": true,
      "display_in_product_detail_yn": true,
      "display_in_filters_as_slider_yn": true
    }
  ]
}

json

Example Responses

{
  "parameters": [
    {
      "id": 0,
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání parametrů

DELETE

/api/v2/parameters

Smazání parametrů › query Parameters

id

integer

ID parametru

ids

QueryParameterArrayInt

ID parametru oddělené středníkem ; nebo jako pole

Smazání parametrů › Responses

200

object[]

Seznam hodnot parametrů

GET

/api/v2/parameters/values

Seznam hodnot parametrů › query Parameters

ids

QueryParameterArrayInt

ID hodnot parametrů oddělené středníkem ; nebo jako pole

attribute_ids

QueryParameterArrayInt

ID parametrů oddělené středníkem ; nebo jako pole

language

Language

Vrací popisky pouze v jazyku

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam hodnot parametrů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

hodnoty parametrů

Smazání hodnot parametrů

DELETE

/api/v2/parameters/values

Smazání hodnot parametrů › query Parameters

ids

QueryParameterArrayInt

ID hodnoty parametru oddělené středníkem ; nebo jako pole

Smazání hodnot parametrů › Responses

200

object[]

Objednávky - přílohy Platby

Detail parametru

GET

/api/v2/parameters/{id}

Detail parametru › path Parameters

id

integer · required

ID parametru

Detail parametru › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

Seznam parametrů

GET

/api/v2/parameters

Seznam parametrů › query Parameters

ids

QueryParameterArrayInt

ID parametru oddělené středníkem ; nebo jako pole

without_values_yn

string

Pokud TRUE nevrací hodnoty parametrů. Možné použí při velkém množství hodnot parametrů. Hodnoty lze stahovat přes samostatný endpoint

language

Language

Vrací popisky pouze v jazyku

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam parametrů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

Vytvoření parametrů

POST

/api/v2/parameters

Názvy parametrů a hodnot parametrů musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.

Vytvoření parametrů › Request Body

object[]

pole objektů s parametry

Vytvoření parametrů › Responses

200

object[]

Seznam hodnot parametrů

GET

/api/v2/parameters/values

Seznam hodnot parametrů › query Parameters

ids

QueryParameterArrayInt

ID hodnot parametrů oddělené středníkem ; nebo jako pole

attribute_ids

QueryParameterArrayInt

ID parametrů oddělené středníkem ; nebo jako pole

language

Language

Vrací popisky pouze v jazyku

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam hodnot parametrů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

hodnoty parametrů