Vlastní pole

více o vlastních polích v Upgates e-shopech naleznete zde.

Seznam vlastních polí

GET

/api/v2/metas

Seznam je dostupný po jednotlivých stranách, výstup je omezen na 100 položek na stránku.

Seznam vlastních polí › query Parameters

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$

klíč vlastního pole

category

MetaCategory · enum

kategorie obsahu

kategorie vlastního pole

advices - rádce
articles - články
category - kategorie
customers - zákazníci
homepage - hlavní stránka
news - aktuality
orders - objednávky
payment - platby
products - produkty
shipment - dopravy

Enum values:

advices

articles

Seznam vlastních polí › 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/metas

curl --request GET \
  --url /api/v2/metas

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "metas": [
    {
      "id": 0,
      "category": "advices",
      "type": "checkbox",
      "key": "key",
      "label": "label",
      "active": true,
      "active_from": "2026-04-28",
      "active_to": "2026-04-28T13:57:48+02:00",
      "help": "help",
      "items": [
        "string"
      ],
      "value": "value",
      "common_languages_value_yn": true,
      "searchable_yn": true,
      "searchable_value_for_bool": "searchable_value_for_bool",
      "values": [
        {
          "language": "cz",
          "items": [
            "string"
          ],
          "value": "value",
          "searchable_value_for_bool": "searchable_value_for_bool"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření vlastních polí

POST

/api/v2/metas

Vytvoření vlastních polí › Request Body

object[] · required

pole objektů

Vytvoření vlastních polí › Responses

200

object[]

pole objektů

POST/api/v2/metas

curl --request POST \
  --url /api/v2/metas \
  --header 'Content-Type: application/json' \
  --data '
{
  "metas": [
    {
      "category": "advices",
      "type": "checkbox",
      "key": "key",
      "label": "label",
      "active": true,
      "active_from": "2026-04-28",
      "active_to": "2026-04-28",
      "help": "help",
      "items": [
        "string"
      ],
      "value": "value",
      "common_languages_value_yn": true,
      "searchable_yn": true,
      "searchable_value_for_bool": "searchable_value_for_bool",
      "values": [
        {
          "language": "cz",
          "items": [
            "string"
          ],
          "value": "value",
          "searchable_value_for_bool": "searchable_value_for_bool"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "metas": [
    {
      "category": "advices",
      "type": "checkbox",
      "key": "key",
      "label": "label",
      "active": true,
      "active_from": "2026-04-28",
      "active_to": "2026-04-28",
      "help": "help",
      "items": [
        "string"
      ],
      "value": "value",
      "common_languages_value_yn": true,
      "searchable_yn": true,
      "searchable_value_for_bool": "searchable_value_for_bool",
      "values": [
        {
          "language": "cz",
          "items": [
            "string"
          ],
          "value": "value",
          "searchable_value_for_bool": "searchable_value_for_bool"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "metas": [
    {
      "category": "advices",
      "type": "checkbox",
      "key": "key",
      "created_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání vlastních polí

DELETE

/api/v2/metas

Smazání vlastních polí › query Parameters

ids

QueryParameterArrayInt · required

ID vlastních polí oddělená středníkem ; nebo jako pole

Smazání vlastních polí › Responses

200

object[]

Štítky Výrobci

Seznam vlastních polí

GET

/api/v2/metas

Seznam je dostupný po jednotlivých stranách, výstup je omezen na 100 položek na stránku.

Seznam vlastních polí › query Parameters

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$

klíč vlastního pole

category

MetaCategory · enum

kategorie obsahu

kategorie vlastního pole

advices - rádce
articles - články
category - kategorie
customers - zákazníci
homepage - hlavní stránka
news - aktuality
orders - objednávky
payment - platby
products - produkty
shipment - dopravy

Enum values:

advices

articles

Seznam vlastních polí › 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[]