GraphQL Admin API reference

Autentifikace

Všechny GraphQL API requesty vyžadují autentifikaci pomocí validního access tokenu. Do hlavičky requestu je tedy potřeba vložit header X-Access-Token, jehož hodnotu si můžete vygenerovat v administraci e-shopu u administrátora.

Endpoint

GraphQL endpoint najdete na adrese: https://<domain>/admin/graphql/

Formát datumu

API používá datum ve formátu ISO 8601 (2022-02-01 08:00:00) a je tedy potřeba pracovat s tímto formátem.

Knihovna pro komunikaci s API

Formát dat editoru obsahu pro ContentEditorInput

WPJShop editor ukládá obsah v JSON formátu. Je to stromová struktura která vždy obsahuje seznam elementů (tzv. bloků) a případně vnořené bloky. Každý blok je definován svým typem (type), má globálně unikátní uuid identifikátor (id) a objekt který definuje nastavení daného bloku (settings).

Blok také může volitelně obsahovat seznam vnořených bloků (children). Tímto způsobem se bloky mohou do sebe zanořovat.

Ukázka základní struktury bloků:

[
  {
    "type": "image_map",
    "id": "394f4b86-8562-4fe4-8c6d-a08f474afd41",
    "settings": {
      "photo": {
        "id": 10935,
      }
    },
    "children": [
      {
        "type": "image_map_point",
        "id": "ec5f0c31-4df7-43e0-aedd-bd65b57afd16",
        "settings": {
          "position_x": 40.34,
          "position_y": 9.6,
        },
        "children": [
          {
            "type": "text",
            "id": "ac38bc31-6483-4a33-be4e-f4aebcd0984d",
            "settings": {
              "html": "<p>Bod!<\/p>"
            }
          }
        ]
      }
    ]
  }
]

Jednotlivé typy bloků a jejich nastavení se neustále rozšiřují, není možné spoléhat na konkrétní formát nastavení bloku. Většinou se pouze nové bloky/nastavení přidávají, jen málokdy dochází ke změnám ve struktuře nastavení bloku a nebo k jeho odebrání.

Některá data v nastavení bloku jsou překladatelná. Následuje seznam bloků a jejich překladatelných položek nastavení:

Typ bloku Význam Překladatelné nastavení
text Textový obsah html
heading Nadpis text
button Tlačítko text
image_button Obrázkové tlačítko title, text, button
image Obrázek caption, alt
video Video url

Queries

adminUser

Description
Response

Returns an AdminUser

Example

Query
query adminUser {
  adminUser {
    id
    name
    login
    email
    privilege
    data
  }
}
Response
{
  "data": {
    "adminUser": {
      "id": 987,
      "name": "xyz789",
      "login": "abc123",
      "email": "xyz789",
      "privilege": "abc123",
      "data": "xyz789"
    }
  }
}

checkCouponExists

Use coupon method
Description
Response

Returns a Coupon

Arguments
Name Description
coupon - String!

Example

Query
query checkCouponExists($coupon: String!) {
  checkCouponExists(coupon: $coupon) {
    id
    title
    code
  }
}
Variables
{"coupon": "xyz789"}
Response
{
  "data": {
    "checkCouponExists": {
      "id": "xyz789",
      "title": "xyz789",
      "code": "xyz789"
    }
  }
}

configuration

Description

Konfigurace e-shopu.

Response

Returns a Configuration!

Example

Query
query configuration {
  configuration {
    orderStatuses {
      ...OrderStatusFragment
    }
    orderSources {
      ...OrderSourceFragment
    }
    deliveryTypes {
      ...DeliveryMethodFragment
    }
    paymentTypes {
      ...PaymentMethodFragment
    }
  }
}
Response
{
  "data": {
    "configuration": {
      "orderStatuses": [OrderStatus],
      "orderSources": [OrderSource],
      "deliveryTypes": [DeliveryMethod],
      "paymentTypes": [PaymentMethod]
    }
  }
}

coupon

Description

Informace o generovaném kódu (poukazu).

Response

Returns a DiscountCoupon

Arguments
Name Description
code - String!

Example

Query
query coupon($code: String!) {
  coupon(code: $code) {
    id
    name
    code
    dateActivated
    dateFrom
    dateTo
    isUsed
    isUsable
  }
}
Variables
{"code": "xyz789"}
Response
{
  "data": {
    "coupon": {
      "id": 123,
      "name": "abc123",
      "code": "xyz789",
      "dateActivated": "\"2022-02-01 08:00:00\"",
      "dateFrom": "\"2022-02-01 08:00:00\"",
      "dateTo": "\"2022-02-01 08:00:00\"",
      "isUsed": true,
      "isUsable": false
    }
  }
}

deliveries

Description

Seznam doprav.

Response

Returns a DeliveryCollection!

Example

Query
query deliveries {
  deliveries {
    items {
      ...DeliveryFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "deliveries": {
      "items": [Delivery],
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

order

Description

Načte objednávku podle zadaného ID.

Response

Returns an Order

Arguments
Name Description
id - Int!

Example

Query
query order($id: Int!) {
  order(id: $id) {
    id
    source {
      ...OrderSourceFragment
    }
    dateCreated
    dateAccept
    dateHandle
    dateUpdated
    currency {
      ...CurrencyFragment
    }
    language {
      ...LanguageFragment
    }
    currencyRate
    code
    userId
    user {
      ...UserFragment
    }
    flags
    status {
      ...OrderStatusFragment
    }
    email
    cancelled
    isCancellable
    totalPrice {
      ...TotalPriceFragment
    }
    deliveryType {
      ...DeliveryTypeFragment
    }
    deliveryInfo {
      ...OrderDeliveryInfoFragment
    }
    priceLevel {
      ...PriceLevelFragment
    }
    invoiceAddress {
      ...AddressFragment
    }
    deliveryAddress {
      ...AddressFragment
    }
    packageId
    noteUser
    noteInvoice
    items {
      ...OrderItemFragment
    }
    isPaid
    paidPrice {
      ...TotalPriceFragment
    }
    remainingPayment {
      ...SimplePriceFragment
    }
    paymentUrl
    bankAccount
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "order": {
      "id": 953,
      "source": OrderSource,
      "dateCreated": "\"2022-02-01 08:00:00\"",
      "dateAccept": "\"2022-02-01 08:00:00\"",
      "dateHandle": "\"2022-02-01 08:00:00\"",
      "dateUpdated": "\"2022-02-01 08:00:00\"",
      "currency": Currency,
      "language": Language,
      "currencyRate": 1,
      "code": "2200953",
      "userId": 123,
      "user": User,
      "flags": [],
      "status": 1,
      "email": "wpj@wpj.cz",
      "cancelled": true,
      "isCancellable": true,
      "totalPrice": TotalPrice,
      "deliveryType": DeliveryType,
      "deliveryInfo": OrderDeliveryInfo,
      "priceLevel": PriceLevel,
      "invoiceAddress": Address,
      "deliveryAddress": Address,
      "packageId": "DR1104116859M",
      "noteUser": "abc123",
      "noteInvoice": "xyz789",
      "items": [OrderItem],
      "isPaid": false,
      "paidPrice": TotalPrice,
      "remainingPayment": SimplePrice,
      "paymentUrl": "xyz789",
      "bankAccount": "abc123"
    }
  }
}

orders

Description

Seznam objednávek.

Response

Returns an OrderCollection!

Arguments
Name Description
offset - Int Default = 0
limit - Int Default = 100
sort - OrderSortInput Default = null
filter - OrderFilterInput Default = null

Example

Query
query orders(
  $offset: Int,
  $limit: Int,
  $sort: OrderSortInput,
  $filter: OrderFilterInput
) {
  orders(
    offset: $offset,
    limit: $limit,
    sort: $sort,
    filter: $filter
  ) {
    items {
      ...OrderFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Variables
{"offset": 0, "limit": 100, "sort": null, "filter": null}
Response
{
  "data": {
    "orders": {
      "items": [Order],
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

parameter

Description

Načte parametr podle ID.

Response

Returns a Parameter

Arguments
Name Description
id - Int!

Example

Query
query parameter($id: Int!) {
  parameter(id: $id) {
    id
    name
    visible
    type
    unit
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "parameter": {
      "id": 987,
      "name": "abc123",
      "visible": false,
      "type": "LIST",
      "unit": "xyz789"
    }
  }
}

parameterValues

Description

Hodnoty parametrů - od parametrů typu LIST. Tyto hodnoty mají ID a jsou překladatelné.

Response

Returns a ParameterValuesCollection!

Arguments
Name Description
offset - Int Default = 0
limit - Int Default = 100
filter - ParameterListFilterInput Default = null

Example

Query
query parameterValues(
  $offset: Int,
  $limit: Int,
  $filter: ParameterListFilterInput
) {
  parameterValues(
    offset: $offset,
    limit: $limit,
    filter: $filter
  ) {
    items {
      ...ParameterValueFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Variables
{"offset": 0, "limit": 100, "filter": null}
Response
{
  "data": {
    "parameterValues": {
      "items": [ParameterValue],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

parameters

Description

Seznam parametrů.

Response

Returns a ParameterCollection!

Example

Query
query parameters {
  parameters {
    items {
      ...ParameterFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "parameters": {
      "items": [Parameter],
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

payments

Description

Seznam plateb.

Response

Returns a PaymentCollection!

Example

Query
query payments {
  payments {
    items {
      ...PaymentFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "payments": {
      "items": [Payment],
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

priceList

Description

Načte ceník podle ID.

Response

Returns a PriceList

Arguments
Name Description
id - Int!

Example

Query
query priceList($id: Int!) {
  priceList(id: $id) {
    id
    currency {
      ...CurrencyFragment
    }
    name
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "priceList": {
      "id": 123,
      "currency": Currency,
      "name": "xyz789"
    }
  }
}

priceLists

Description

Seznam ceníků.

Response

Returns a PriceListCollection!

Example

Query
query priceLists {
  priceLists {
    items {
      ...PriceListFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "priceLists": {
      "items": [PriceList],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

producer

Description

Výrobce podle ID.

Response

Returns a Producer

Arguments
Name Description
id - Int!

Example

Query
query producer($id: Int!) {
  producer(id: $id) {
    id
    name
    web
    active
    photo {
      ...PhotoInterfaceFragment
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "producer": {
      "id": 987,
      "name": "xyz789",
      "web": "xyz789",
      "active": false,
      "photo": PhotoInterface
    }
  }
}

producers

Description

Seznam výrobců.

Response

Returns a ProducerCollection!

Example

Query
query producers {
  producers {
    items {
      ...ProducerFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "producers": {
      "items": [Producer],
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

product

Description

Načte produkt podle zadaného ID.

Response

Returns a Product

Arguments
Name Description
id - Int!

Example

Query
query product($id: Int!) {
  product(id: $id) {
    id
    variationId
    url
    code
    ean
    inStore
    inStoreSuppliers
    stores {
      ...StoreItemFragment
    }
    title
    variationTitle
    description
    longDescription
    additionalDescription
    descriptionPlus {
      ...EditableContentFragment
    }
    discount
    producer {
      ...ProducerFragment
    }
    price {
      ...PriceFragment
    }
    priceBuy {
      ...PriceFragment
    }
    visible
    visibility
    weight
    width
    height
    depth
    seo {
      ...SeoFragment
    }
    unit {
      ...ProductUnitFragment
    }
    links {
      ...ProductLinkFragment
    }
    relatedProducts {
      ...ProductFragment
    }
    collectionProducts {
      ...ProductFragment
    }
    parameters {
      ...ProductParameterFragment
    }
    variations {
      ...VariationFragment
    }
    priceLists {
      ...ProductPriceListFragment
    }
    labels {
      ...LabelFragment
    }
    sections {
      ...SectionFragment
    }
    photos {
      ...ProductPhotoFragment
    }
    photo {
      ...ProductPhotoFragment
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "product": {
      "id": 100,
      "variationId": 123,
      "url": "abc123",
      "code": "X100",
      "ean": "0000123456789",
      "inStore": 50,
      "inStoreSuppliers": 987.65,
      "stores": [StoreItem],
      "title": "Tepláky WPJ",
      "variationTitle": "xyz789",
      "description": "Tepláky WPJ",
      "longDescription": "<p>Tepláky WPJ</p>",
      "additionalDescription": "abc123",
      "descriptionPlus": EditableContent,
      "discount": 10,
      "producer": Producer,
      "price": Price,
      "priceBuy": Price,
      "visible": true,
      "visibility": "VISIBLE",
      "weight": 0.2,
      "width": 123.45,
      "height": 987.65,
      "depth": 987.65,
      "seo": Seo,
      "unit": ProductUnit,
      "links": [ProductLink],
      "relatedProducts": [Product],
      "collectionProducts": [Product],
      "parameters": [ProductParameter],
      "variations": [Variation],
      "priceLists": [ProductPriceList],
      "labels": [Label],
      "sections": [Section],
      "photos": [ProductPhoto],
      "photo": ProductPhoto
    }
  }
}

products

Description

Seznam produktů.

Response

Returns a ProductCollection!

Arguments
Name Description
offset - Int Default = 0
limit - Int Default = 100
sort - ProductSortInput Default = null
filter - ProductFilterInput Default = null

Example

Query
query products(
  $offset: Int,
  $limit: Int,
  $sort: ProductSortInput,
  $filter: ProductFilterInput
) {
  products(
    offset: $offset,
    limit: $limit,
    sort: $sort,
    filter: $filter
  ) {
    items {
      ...ProductFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Variables
{"offset": 0, "limit": 100, "sort": null, "filter": null}
Response
{
  "data": {
    "products": {
      "items": [Product],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

purchaseCalculate

Description

Vrátí informace o nákupu - ceny položek, slevy, výslednou cenu. ..

Response

Returns a PurchaseState

Arguments
Name Description
input - PurchaseCalculateInput!

Example

Query
query purchaseCalculate($input: PurchaseCalculateInput!) {
  purchaseCalculate(input: $input) {
    products {
      ...ProductPurchaseItemFragment
    }
    discounts {
      ... on DiscountPurchaseItem {
        ...DiscountPurchaseItemFragment
      }
      ... on ProductPurchaseItem {
        ...ProductPurchaseItemFragment
      }
    }
    totalPrice {
      ...TotalPriceFragment
    }
    totalPriceDiscounts {
      ...TotalPriceFragment
    }
  }
}
Variables
{"input": PurchaseCalculateInput}
Response
{
  "data": {
    "purchaseCalculate": {
      "products": [ProductPurchaseItem],
      "discounts": [DiscountPurchaseItem],
      "totalPrice": TotalPrice,
      "totalPriceDiscounts": TotalPrice
    }
  }
}

sale

Description

Vrací prodejku podle ID.

Response

Returns a Sale

Arguments
Name Description
id - Int!

Example

Query
query sale($id: Int!) {
  sale(id: $id) {
    id
    code
    currency {
      ...CurrencyFragment
    }
    language {
      ...LanguageFragment
    }
    dateCreated
    user {
      ...UserFragment
    }
    deliveryType {
      ...DeliveryTypeFragment
    }
    note
    totalPrice {
      ...TotalPriceFragment
    }
    data
    items {
      ...SaleItemFragment
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "sale": {
      "id": 123,
      "code": "abc123",
      "currency": Currency,
      "language": Language,
      "dateCreated": "\"2022-02-01 08:00:00\"",
      "user": User,
      "deliveryType": DeliveryType,
      "note": "abc123",
      "totalPrice": TotalPrice,
      "data": "abc123",
      "items": [SaleItem]
    }
  }
}

sales

Description

Vrací seznam prodejek.

Response

Returns a SaleCollection!

Arguments
Name Description
offset - Int Default = 0
limit - Int Default = 100
sort - SaleSortInput Default = null
filter - SaleFilterInput Default = null

Example

Query
query sales(
  $offset: Int,
  $limit: Int,
  $sort: SaleSortInput,
  $filter: SaleFilterInput
) {
  sales(
    offset: $offset,
    limit: $limit,
    sort: $sort,
    filter: $filter
  ) {
    items {
      ...SaleFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Variables
{"offset": 0, "limit": 100, "sort": null, "filter": null}
Response
{
  "data": {
    "sales": {
      "items": [Sale],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

section

Description

Načte sekci podle ID.

Response

Returns a Section

Arguments
Name Description
id - Int!

Example

Query
query section($id: Int!) {
  section(id: $id) {
    id
    name
    nameShort
    visible
    url
    photo {
      ...ProductPhotoFragment
    }
    hasChildren
    isVirtual
    parent {
      ...SectionFragment
    }
    parents {
      ...SectionFragment
    }
    children {
      ...SectionFragment
    }
    description {
      ...EditableContentFragment
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "section": {
      "id": 123,
      "name": "xyz789",
      "nameShort": "xyz789",
      "visible": true,
      "url": "abc123",
      "photo": ProductPhoto,
      "hasChildren": false,
      "isVirtual": false,
      "parent": Section,
      "parents": [Section],
      "children": [Section],
      "description": EditableContent
    }
  }
}

sections

Description

Načte sekce ve stromové struktuře.

Response

Returns [Section!]!

Arguments
Name Description
rootId - Int Default = null
filter - SectionFilterInput Default = null

Example

Query
query sections(
  $rootId: Int,
  $filter: SectionFilterInput
) {
  sections(
    rootId: $rootId,
    filter: $filter
  ) {
    id
    name
    nameShort
    visible
    url
    photo {
      ...ProductPhotoFragment
    }
    hasChildren
    isVirtual
    parent {
      ...SectionFragment
    }
    parents {
      ...SectionFragment
    }
    children {
      ...SectionFragment
    }
    description {
      ...EditableContentFragment
    }
  }
}
Variables
{"rootId": null, "filter": null}
Response
{
  "data": {
    "sections": [
      {
        "id": 123,
        "name": "xyz789",
        "nameShort": "abc123",
        "visible": false,
        "url": "abc123",
        "photo": ProductPhoto,
        "hasChildren": true,
        "isVirtual": false,
        "parent": Section,
        "parents": [Section],
        "children": [Section],
        "description": EditableContent
      }
    ]
  }
}

sectionsList

Description

Načte sekce v listové struktuře.

Response

Returns a SectionCollection!

Example

Query
query sectionsList {
  sectionsList {
    items {
      ...SectionFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "sectionsList": {
      "items": [Section],
      "hasNextPage": false,
      "hasPreviousPage": false
    }
  }
}

seller

Description

Načte prodejnu podle ID.

Response

Returns a Seller

Arguments
Name Description
id - Int!

Example

Query
query seller($id: Int!) {
  seller(id: $id) {
    id
    visible
    latitude
    longitude
    store {
      ...StoreFragment
    }
    name
    type
    typeName
    email
    street
    zip
    city
    phone
    country {
      ...CountryFragment
    }
    description
    photos {
      ...PhotoInterfaceFragment
    }
    isOrderingAllowed
    data
    content {
      ...EditableContentFragment
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "seller": {
      "id": 123,
      "visible": false,
      "latitude": 123.45,
      "longitude": 123.45,
      "store": Store,
      "name": "xyz789",
      "type": "xyz789",
      "typeName": "abc123",
      "email": "abc123",
      "street": "xyz789",
      "zip": "abc123",
      "city": "xyz789",
      "phone": "xyz789",
      "country": Country,
      "description": "abc123",
      "photos": [PhotoInterface],
      "isOrderingAllowed": true,
      "data": "xyz789",
      "content": EditableContent
    }
  }
}

sellers

Description

Seznam prodejen.

Response

Returns a SellerCollection!

Example

Query
query sellers {
  sellers {
    items {
      ...SellerFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "sellers": {
      "items": [Seller],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

store

Description

Načte sklad podle ID.

Response

Returns a Store

Arguments
Name Description
id - Int!

Example

Query
query store($id: Int!) {
  store(id: $id) {
    id
    name
    type
    visible
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "store": {
      "id": 123,
      "name": "xyz789",
      "type": "MAIN_STORE",
      "visible": false
    }
  }
}

stores

Description

Seznam skladů.

Response

Returns a StoreCollection!

Example

Query
query stores {
  stores {
    items {
      ...StoreFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Response
{
  "data": {
    "stores": {
      "items": [Store],
      "hasNextPage": false,
      "hasPreviousPage": true
    }
  }
}

user

Description
Response

Returns a User

Arguments
Name Description
id - Int Default = null
email - String Default = null

Example

Query
query user(
  $id: Int,
  $email: String
) {
  user(
    id: $id,
    email: $email
  ) {
    invoiceAddress {
      ...AddressFragment
    }
    deliveryAddress {
      ...AddressFragment
    }
    invoiceDetails {
      ...AddressFragment
    }
    deliveryDetails {
      ...AddressFragment
    }
    gender
    isActive
    newsletterInfo {
      ...UserNewsletterFragment
    }
    dateRegistered
    dateUpdated
    dateLogged
    note
    priceList {
      ...PriceListFragment
    }
    bonusPoints
    dateLastOrder
    priceLevel {
      ...PriceLevelFragment
    }
    birthdate
    newsletter
    subscribeDate
    unsubscribeDate
    registrationDate
    updateDate
    loggedDate
    figure
    id
    email
    name
    surname
    userName
    isB2B
  }
}
Variables
{"id": null, "email": null}
Response
{
  "data": {
    "user": {
      "invoiceAddress": Address,
      "deliveryAddress": Address,
      "invoiceDetails": Address,
      "deliveryDetails": Address,
      "gender": "xyz789",
      "isActive": true,
      "newsletterInfo": UserNewsletter,
      "dateRegistered": "\"2022-02-01 08:00:00\"",
      "dateUpdated": "\"2022-02-01 08:00:00\"",
      "dateLogged": "\"2022-02-01 08:00:00\"",
      "note": "xyz789",
      "priceList": PriceList,
      "bonusPoints": 987,
      "dateLastOrder": "\"2022-02-01 08:00:00\"",
      "priceLevel": PriceLevel,
      "birthdate": "\"2022-02-01 08:00:00\"",
      "newsletter": "abc123",
      "subscribeDate": "abc123",
      "unsubscribeDate": "xyz789",
      "registrationDate": "xyz789",
      "updateDate": "abc123",
      "loggedDate": "xyz789",
      "figure": "abc123",
      "id": 123,
      "email": "abc123",
      "name": "xyz789",
      "surname": "xyz789",
      "userName": "abc123",
      "isB2B": true
    }
  }
}

users

Description

Seznam uživatelů.

Response

Returns a UserCollection!

Arguments
Name Description
offset - Int Default = 0
limit - Int Default = 100
userSort - UserSortInput Default = null
userFilter - UserFilterInput Default = null

Example

Query
query users(
  $offset: Int,
  $limit: Int,
  $userSort: UserSortInput,
  $userFilter: UserFilterInput
) {
  users(
    offset: $offset,
    limit: $limit,
    userSort: $userSort,
    userFilter: $userFilter
  ) {
    items {
      ...UserFragment
    }
    hasNextPage
    hasPreviousPage
  }
}
Variables
{"offset": 0, "limit": 100, "userSort": null, "userFilter": null}
Response
{
  "data": {
    "users": {
      "items": [User],
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

Mutations

couponReactivate

Description

Znovu aktivuje už použitý generovaný kód.

Response

Returns a MutateResponseInterface!

Arguments
Name Description
code - String!

Example

Query
mutation couponReactivate($code: String!) {
  couponReactivate(code: $code) {
    result
  }
}
Variables
{"code": "abc123"}
Response
{"data": {"couponReactivate": {"result": true}}}

couponUse

Description

Nastaví generovaný kód jako použitý.

Response

Returns a MutateResponseInterface!

Arguments
Name Description
code - String!

Example

Query
mutation couponUse($code: String!) {
  couponUse(code: $code) {
    result
  }
}
Variables
{"code": "xyz789"}
Response
{"data": {"couponUse": {"result": false}}}

editableContentTranslate

Description

Provede aktualizaci překladu editovatelného obsahu.

Response

Returns a MutateResponseInterface!

Arguments
Name Description
input - EditableContentTranslationInput!

Example

Query
mutation editableContentTranslate($input: EditableContentTranslationInput!) {
  editableContentTranslate(input: $input) {
    result
  }
}
Variables
{"input": EditableContentTranslationInput}
Response
{"data": {"editableContentTranslate": {"result": true}}}

editableContentUpdate

Description

Provede aktualizaci editovatelného obsahu.

Response

Returns an EditableContentMutateResponse!

Arguments
Name Description
input - EditableContentInput!

Example

Query
mutation editableContentUpdate($input: EditableContentInput!) {
  editableContentUpdate(input: $input) {
    result
    editableContent {
      ...EditableContentFragment
    }
  }
}
Variables
{"input": EditableContentInput}
Response
{
  "data": {
    "editableContentUpdate": {
      "result": true,
      "editableContent": EditableContent
    }
  }
}

orderStorno

Description

Stornuje objednávku.

Response

Returns an OrderMutateResponse!

Arguments
Name Description
input - OrderStornoInput!

Example

Query
mutation orderStorno($input: OrderStornoInput!) {
  orderStorno(input: $input) {
    result
    order {
      ...OrderFragment
    }
  }
}
Variables
{"input": OrderStornoInput}
Response
{
  "data": {
    "orderStorno": {"result": true, "order": Order}
  }
}

orderUpdate

Description

Aktualizuje objednávku.

Response

Returns an OrderMutateResponse!

Arguments
Name Description
input - OrderUpdateInput!

Example

Query
mutation orderUpdate($input: OrderUpdateInput!) {
  orderUpdate(input: $input) {
    result
    order {
      ...OrderFragment
    }
  }
}
Variables
{"input": OrderUpdateInput}
Response
{
  "data": {
    "orderUpdate": {"result": true, "order": Order}
  }
}

parameterCreate

Description

Vytvoří parametr.

Response

Returns a Parameter!

Arguments
Name Description
input - ParameterCreateInput!

Example

Query
mutation parameterCreate($input: ParameterCreateInput!) {
  parameterCreate(input: $input) {
    id
    name
    visible
    type
    unit
  }
}
Variables
{"input": ParameterCreateInput}
Response
{
  "data": {
    "parameterCreate": {
      "id": 123,
      "name": "abc123",
      "visible": false,
      "type": "LIST",
      "unit": "xyz789"
    }
  }
}

parameterTranslate

Description

Aktualizuje překlad parametru.

Arguments
Name Description
input - ParameterTranslationInput!

Example

Query
mutation parameterTranslate($input: ParameterTranslationInput!) {
  parameterTranslate(input: $input) {
    result
  }
}
Variables
{"input": ParameterTranslationInput}
Response
{"data": {"parameterTranslate": {"result": true}}}

parameterValuesTranslate

Description

Aktualizace překladu seznamové hodnoty parametru.

Arguments
Name Description
input - ParameterValuesTranslationInput!

Example

Query
mutation parameterValuesTranslate($input: ParameterValuesTranslationInput!) {
  parameterValuesTranslate(input: $input) {
    result
  }
}
Variables
{"input": ParameterValuesTranslationInput}
Response
{"data": {"parameterValuesTranslate": {"result": true}}}

priceListCreate

Description

Vytvoří ceník.

Response

Returns a PriceListMutateResponse!

Arguments
Name Description
input - PriceListInput!

Example

Query
mutation priceListCreate($input: PriceListInput!) {
  priceListCreate(input: $input) {
    result
    priceList {
      ...PriceListFragment
    }
  }
}
Variables
{"input": PriceListInput}
Response
{
  "data": {
    "priceListCreate": {
      "result": true,
      "priceList": PriceList
    }
  }
}

producerCreateOrUpdate

Description

Vytvoří / aktualizuje výrobce.

Response

Returns a ProducerMutateResponse!

Arguments
Name Description
input - ProducerInput!

Example

Query
mutation producerCreateOrUpdate($input: ProducerInput!) {
  producerCreateOrUpdate(input: $input) {
    result
    producer {
      ...ProducerFragment
    }
  }
}
Variables
{"input": ProducerInput}
Response
{
  "data": {
    "producerCreateOrUpdate": {
      "result": false,
      "producer": Producer
    }
  }
}

productCollectionUpdate

Description

Aktualizace kolekce u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - CollectionProductsInput!

Example

Query
mutation productCollectionUpdate($input: CollectionProductsInput!) {
  productCollectionUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": CollectionProductsInput}
Response
{
  "data": {
    "productCollectionUpdate": {
      "result": false,
      "product": Product
    }
  }
}

productCreateOrUpdate

Description

Vytvoří nebo aktualizuje produkt.

Response

Returns a ProductMutateResponseInterface

Arguments
Name Description
product - ProductModifyInput

Example

Query
mutation productCreateOrUpdate($product: ProductModifyInput) {
  productCreateOrUpdate(product: $product) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"product": ProductModifyInput}
Response
{
  "data": {
    "productCreateOrUpdate": {
      "result": false,
      "product": Product
    }
  }
}

productLinkUpdate

Description

Aktualizace odkazů u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - ProductLinkInput!

Example

Query
mutation productLinkUpdate($input: ProductLinkInput!) {
  productLinkUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": ProductLinkInput}
Response
{
  "data": {
    "productLinkUpdate": {
      "result": true,
      "product": Product
    }
  }
}

productParameterBulkUpdate

Description

Hromadně aktualizuje hodnoty parametru u produktu (doporučeno při aktualizaci více parametrů najednou).

Response

Returns a MutateResponseInterface!

Arguments
Name Description
input - [ProductParameterInput!]!

Example

Query
mutation productParameterBulkUpdate($input: [ProductParameterInput!]!) {
  productParameterBulkUpdate(input: $input) {
    result
  }
}
Variables
{"input": [ProductParameterInput]}
Response
{"data": {"productParameterBulkUpdate": {"result": false}}}

productParameterUpdate

Description

Aktualizuje hodnoty parametru u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - ProductParameterInput!

Example

Query
mutation productParameterUpdate($input: ProductParameterInput!) {
  productParameterUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": ProductParameterInput}
Response
{
  "data": {
    "productParameterUpdate": {
      "result": false,
      "product": Product
    }
  }
}

productPriceListBulkUpdate

Description

Hromadně aktualizuje ceny produktu (doporučeno při aktualizaci více cen najednou).

Response

Returns a MutateResponseInterface!

Arguments
Name Description
input - [ProductPriceListInput!]!

Example

Query
mutation productPriceListBulkUpdate($input: [ProductPriceListInput!]!) {
  productPriceListBulkUpdate(input: $input) {
    result
  }
}
Variables
{"input": [ProductPriceListInput]}
Response
{"data": {"productPriceListBulkUpdate": {"result": false}}}

productPriceListUpdate

Description

Aktualizuje ceny v ceníku u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - ProductPriceListInput!

Example

Query
mutation productPriceListUpdate($input: ProductPriceListInput!) {
  productPriceListUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": ProductPriceListInput}
Response
{
  "data": {
    "productPriceListUpdate": {
      "result": true,
      "product": Product
    }
  }
}

productRelatedUpdate

Description

Aktualizace souvisejícího zboží u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - RelatedProductsInput!

Example

Query
mutation productRelatedUpdate($input: RelatedProductsInput!) {
  productRelatedUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": RelatedProductsInput}
Response
{
  "data": {
    "productRelatedUpdate": {
      "result": false,
      "product": Product
    }
  }
}

productStoreBulkUpdate

Description

Hromadně aktualizuje sklad produktů (doporučeno při aktualizaci více položek najednou).

Response

Returns a MutateResponseInterface!

Arguments
Name Description
input - [ProductStoreInput!]!

Example

Query
mutation productStoreBulkUpdate($input: [ProductStoreInput!]!) {
  productStoreBulkUpdate(input: $input) {
    result
  }
}
Variables
{"input": [ProductStoreInput]}
Response
{"data": {"productStoreBulkUpdate": {"result": false}}}

productStoreUpdate

Description

Aktualizuje stav skladu u produktu.

Response

Returns a ProductMutateResponseInterface!

Arguments
Name Description
input - ProductStoreInput!

Example

Query
mutation productStoreUpdate($input: ProductStoreInput!) {
  productStoreUpdate(input: $input) {
    result
    product {
      ...ProductFragment
    }
  }
}
Variables
{"input": ProductStoreInput}
Response
{
  "data": {
    "productStoreUpdate": {
      "result": false,
      "product": Product
    }
  }
}

productTranslate

Description

Aktualizuje překlady produktu.

Arguments
Name Description
input - ProductTranslationInput!

Example

Query
mutation productTranslate($input: ProductTranslationInput!) {
  productTranslate(input: $input) {
    result
  }
}
Variables
{"input": ProductTranslationInput}
Response
{"data": {"productTranslate": {"result": true}}}

sectionTranslate

Description

Překládá sekci.

Arguments
Name Description
input - SectionTranslationInput!

Example

Query
mutation sectionTranslate($input: SectionTranslationInput!) {
  sectionTranslate(input: $input) {
    result
  }
}
Variables
{"input": SectionTranslationInput}
Response
{"data": {"sectionTranslate": {"result": true}}}

sellerCreateOrUpdate

Description

Vytvoření / aktualizace prodejny.

Response

Returns a SellerMutateResponse!

Arguments
Name Description
input - SellerInput!

Example

Query
mutation sellerCreateOrUpdate($input: SellerInput!) {
  sellerCreateOrUpdate(input: $input) {
    result
    seller {
      ...SellerFragment
    }
  }
}
Variables
{"input": SellerInput}
Response
{
  "data": {
    "sellerCreateOrUpdate": {
      "result": true,
      "seller": Seller
    }
  }
}

storeCreate

Description

Vytvoří sklad.

Response

Returns a Store!

Arguments
Name Description
input - StoreCreateInput!

Example

Query
mutation storeCreate($input: StoreCreateInput!) {
  storeCreate(input: $input) {
    id
    name
    type
    visible
  }
}
Variables
{"input": StoreCreateInput}
Response
{
  "data": {
    "storeCreate": {
      "id": 123,
      "name": "xyz789",
      "type": "MAIN_STORE",
      "visible": true
    }
  }
}

userCreate

Use userCreateOrUpdate
Description

Vytvoří uživatele.

Response

Returns a UserMutateResponse!

Arguments
Name Description
input - UserInput!

Example

Query
mutation userCreate($input: UserInput!) {
  userCreate(input: $input) {
    result
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": UserInput}
Response
{"data": {"userCreate": {"result": true, "user": User}}}

userCreateOrUpdate

Description

Vytvoří / aktualizuje uživatele.

Response

Returns a UserMutateResponse!

Arguments
Name Description
input - UserInput!

Example

Query
mutation userCreateOrUpdate($input: UserInput!) {
  userCreateOrUpdate(input: $input) {
    result
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": UserInput}
Response
{
  "data": {
    "userCreateOrUpdate": {"result": true, "user": User}
  }
}

userUpdate

Use userCreateOrUpdate
Description

Aktualizuje uživatele.

Response

Returns a UserMutateResponse!

Arguments
Name Description
input - UserInput!

Example

Query
mutation userUpdate($input: UserInput!) {
  userUpdate(input: $input) {
    result
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": UserInput}
Response
{"data": {"userUpdate": {"result": false, "user": User}}}

variationCreateOrUpdate

Description

Vytvoří nebo aktualizuje variantu produktu.

Response

Returns a VariationMutateResponse

Arguments
Name Description
variation - VariationModifyInput

Example

Query
mutation variationCreateOrUpdate($variation: VariationModifyInput) {
  variationCreateOrUpdate(variation: $variation) {
    result
    product {
      ...ProductFragment
    }
    variation {
      ...VariationFragment
    }
  }
}
Variables
{"variation": VariationModifyInput}
Response
{
  "data": {
    "variationCreateOrUpdate": {
      "result": false,
      "product": Product,
      "variation": Variation
    }
  }
}

Types

ActionTypeEnum

Values
Enum Value Description

CREATE

UPDATE

REMOVE

Example
"CREATE"

Address

Fields
Field Name Description
name - String! Jméno.
surname - String! Příjmení.
firm - String! Firma.
phone - String! Telefon.
ico - String IČO.
dic - String DIČ.
street - String! Ulice a číslo popisné.
city - String! Město.
zip - String! Poštovní směrovací číslo.
country - Country Země.
customAddress - String! Upřesnění adresy
state - String! Stát/region
Example
{
  "name": "Josef",
  "surname": "Novák",
  "firm": "wpj s.r.o.",
  "phone": "+420712345678",
  "ico": "123456789",
  "dic": "CZ123456789",
  "street": "Lánovská 1475",
  "city": "Vrchlabí",
  "zip": "54341",
  "country": Country,
  "customAddress": "xyz789",
  "state": "abc123"
}

AddressInput

Fields
Input Field Description
name - String Jméno.
surname - String Příjmení.
firm - String Firma.
phone - String Telefon.
street - String Ulice s číslem popisným.
city - String Město.
zip - String PSČ.
country - String Země. ISO kód země.
Example
{
  "name": "abc123",
  "surname": "abc123",
  "firm": "xyz789",
  "phone": "abc123",
  "street": "abc123",
  "city": "abc123",
  "zip": "xyz789",
  "country": "xyz789"
}

AdminUser

Fields
Field Name Description
id - Int!
name - String
login - String!
email - String!
privilege - String!
data - String
Example
{
  "id": 123,
  "name": "xyz789",
  "login": "abc123",
  "email": "xyz789",
  "privilege": "abc123",
  "data": "abc123"
}

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

CollectionItemInput

Fields
Input Field Description
productId - Int! ID produktu.
Example
{"productId": 987}

CollectionProductsInput

Fields
Input Field Description
productId - Int! ID produktu.
products - [CollectionItemInput!]! Produkty, které mají být v kolekci.
append - Boolean
  • Pokud true, tak se u produktu zachovají aktuální produkty v kolekci a k nim se přidají produkty specifikované v products.
  • Pokud false, tak u produktu smažou aktuální produkty v kolekci a přidá produkty, které jsou specifikované v products. Default = false
Example
{
  "productId": 987,
  "products": [CollectionItemInput],
  "append": true
}

Configuration

Fields
Field Name Description
orderStatuses - [OrderStatus!]! Seznam stavů objednávek.
orderSources - [OrderSource!]! Seznam zdrojů objednávek.
deliveryTypes - [DeliveryMethod!]! Seznam typů doprav.
paymentTypes - [PaymentMethod!]! Seznam typů plateb.
Example
{
  "orderStatuses": [OrderStatus],
  "orderSources": [OrderSource],
  "deliveryTypes": [DeliveryMethod],
  "paymentTypes": [PaymentMethod]
}

Country

Fields
Field Name Description
code - String Kód.
name - String Název.
Example
{"code": "CZ", "name": "Česká republika"}

Coupon

Fields
Field Name Description
id - String
title - String
code - String!
Example
{
  "id": "xyz789",
  "title": "xyz789",
  "code": "abc123"
}

Currency

Fields
Field Name Description
code - String! Kód.
name - String! Název.
symbol - String! Symbol.
rate - Float! Kurz.
roundType - Int! Zaokrouhlování (0=nezaokrouhlovat, 1=haléře, 5=5 haléřů, 100=celá čísla, -5=5 korun, -10=10 korun).
roundDirection - String! Směr zaokrouhlování (up, down, math).
precision - Int! Počet desetinných míst pro zobrazení (0, 2, -1=dynamicky).
decimalMark - String! Oddělovač desetinných míst.
Example
{
  "code": "CZK",
  "name": "Česká koruna",
  "symbol": "Kč",
  "rate": "1.0000",
  "roundType": 987,
  "roundDirection": "xyz789",
  "precision": 123,
  "decimalMark": "abc123"
}

DateFilterInput

Fields
Input Field Description
eq - DateTime Rovno. Default = null
lt - DateTime Menší než. Default = null
le - DateTime Menší nebo rovno. Default = null
gt - DateTime Větší než. Default = null
ge - DateTime Větší nebo rovno. Default = null
Example
{
  "eq": "\"2022-02-01 08:00:00\"",
  "lt": "\"2022-02-01 08:00:00\"",
  "le": "\"2022-02-01 08:00:00\"",
  "gt": "\"2022-02-01 08:00:00\"",
  "ge": "\"2022-02-01 08:00:00\""
}

DateTime

Description

The DateTime scalar type represents time data, represented as an ISO-8601 encoded UTC date string.

Example
""2022-02-01 08:00:00""

Delivery

Fields
Field Name Description
id - Int! ID dopravy.
type - String! Typ dopravy.
name - String! Název dopravy.
isInPerson - Boolean! Zda je doprava osobní odběr.
Example
{
  "id": 123,
  "type": "xyz789",
  "name": "abc123",
  "isInPerson": false
}

DeliveryCollection

Fields
Field Name Description
items - [Delivery!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Delivery],
  "hasNextPage": true,
  "hasPreviousPage": false
}

DeliveryMethod

Fields
Field Name Description
type - String! Typ.
name - String! Název.
Example
{
  "type": "abc123",
  "name": "xyz789"
}

DeliveryType

Fields
Field Name Description
id - Int! ID způsobu doručení.
delivery - Delivery Informace o dopravě.
payment - Payment Informace o platbě.
Example
{
  "id": 987,
  "delivery": Delivery,
  "payment": Payment
}

DiscountCoupon

Fields
Field Name Description
id - Int! ID.
name - String! Název.
code - String! Kód.
dateActivated - DateTime Datum, kdy byl kupón aktivován. Pokud je null, tak není aktivní.
dateFrom - DateTime Datum, od kdy je kupón platný. Pokud je null, tak nemá počáteční platnost.
dateTo - DateTime Datum, do kdy je kupón platný. Pokud je null, tak nemá konečnou platnost.
isUsed - Boolean! Informace, zda je kupón použit.
isUsable - Boolean! Informace, zda je kupón možné použít.
Example
{
  "id": 123,
  "name": "xyz789",
  "code": "abc123",
  "dateActivated": "\"2022-02-01 08:00:00\"",
  "dateFrom": "\"2022-02-01 08:00:00\"",
  "dateTo": "\"2022-02-01 08:00:00\"",
  "isUsed": false,
  "isUsable": true
}

DiscountPurchaseItem

Fields
Field Name Description
name - String! Název.
totalPrice - Price! Celková sleva.
Example
{
  "name": "abc123",
  "totalPrice": Price
}

EditableArea

Fields
Field Name Description
id - Int! ID.
position - Int! Pozice.
name - String Název.
content - String! Obsah ve formátu HTML. Vyrenderovaný z JSON dat z pole data.
data - String! JSON data obsahu.
dataPortable - String! Přenosná JSON data obsahu. Např. místo ID fotek se v datech nachází URL adresa vedoucí k fotce.
Example
{
  "id": 123,
  "position": 987,
  "name": "abc123",
  "content": "xyz789",
  "data": "abc123",
  "dataPortable": "abc123"
}

EditableAreaInput

Fields
Input Field Description
id - Int ID. Pokud bude vyplněno null, tak bude vytvořená nová editovatelná oblast
name - String Název.
data - String JSON data obsahu.
dataPortable - String JSON data obsahu v přenosném formátu. Pokud jsou vyplněny, tak se upřednostní před polem data.
Example
{
  "id": 987,
  "name": "abc123",
  "data": "abc123",
  "dataPortable": "abc123"
}

EditableContent

Fields
Field Name Description
id - Int! ID editovatelné obsahu.
areas - [EditableArea!]! Oblasti obsahující popisek a jeho data.
Example
{"id": 987, "areas": [EditableArea]}

EditableContentInput

Fields
Input Field Description
id - Int! ID editovatelného obsahu.
areas - [EditableAreaInput!]! Oblasti obsahující popisek a jeho data.
overwrite - Boolean Pokud je nastaveno true, tak před aktualizací provede nejdřív smazání všech oblastí u aktualního objekta. Default = null
Example
{
  "id": 123,
  "areas": [EditableAreaInput],
  "overwrite": false
}

EditableContentMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
editableContent - EditableContent! Aktualizovaný editovatelný obsah.
Example
{"result": false, "editableContent": EditableContent}

EditableContentTranslationInput

Fields
Input Field Description
language - String! Jazyk.
id - Int! ID editovatelného obsahu.
areas - [EditableAreaInput!]! Oblasti obsahující popisek a jeho data.
overwrite - Boolean Pokud je nastaveno true, tak před aktualizací provede nejdřív smazání všech oblastí u aktualního objekta. Default = null
Example
{
  "language": "xyz789",
  "id": 123,
  "areas": [EditableAreaInput],
  "overwrite": true
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123

Label

Fields
Field Name Description
id - Int! ID.
name - String! Název.
nameShort - String Krátký název.
isActive - Boolean! Je aktivní.
dateFrom - DateTime Zobrazovat od
dateTo - DateTime Zobrazovat do
Example
{
  "id": 987,
  "name": "xyz789",
  "nameShort": "abc123",
  "isActive": false,
  "dateFrom": "\"2022-02-01 08:00:00\"",
  "dateTo": "\"2022-02-01 08:00:00\""
}

Language

Fields
Field Name Description
code - String! Kód (ISO 639-1).
name - String! Název.
isActive - Boolean!
Example
{"code": "cs", "name": "čeština", "isActive": false}

LinkItemInput

Fields
Input Field Description
name - String! Název.
link - String! Odkaz.
type - String Typ odkazu (link, youtube). Default = "link"
Example
{
  "name": "abc123",
  "link": "xyz789",
  "type": "abc123"
}

MutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
Example
{"result": false}

MutateResponseInterface

Order

Fields
Field Name Description
id - Int! Interní ID.
source - OrderSource! Zdroj objednávky.
dateCreated - DateTime! Datum vytvoření.
dateAccept - DateTime Datum přijetí.
dateHandle - DateTime Datum vyřízení.
dateUpdated - DateTime Datum poslední změny.
currency - Currency! Měna.
language - Language! Jazyk.
currencyRate - Float! Kurz měny.
code - String! Číslo objednávky.
userId - Int Interní ID uživatele.
user - User Uživatel.
flags - [String!]! Příznaky objednávky.
status - OrderStatus! Stav objednávky.
email - String! E-mail zákazníka.
cancelled - Boolean! Storno.
isCancellable - Boolean! Zda je možné provést storno.
totalPrice - TotalPrice! Celková cena.
deliveryType - DeliveryType Způsob doručení. Kombinace dopravy a platby, která obsahuje informace o dopravě a platbě.
deliveryInfo - OrderDeliveryInfo! Informace o dopravě vázané k objednávce. Například ID odběrného místa.
priceLevel - PriceLevel Cenová hladina použitá v objednávce.
invoiceAddress - Address! Fakturační adresa.
deliveryAddress - Address! Doručovací adresa.
packageId - String Číslo balíku. Use deliveryInfo.packageId
noteUser - String Poznámka od uživatele.
noteInvoice - String Poznámka na faktuře.
items - [OrderItem!]! Položky.
isPaid - Boolean! Stav zaplacení.
paidPrice - TotalPrice! Již zaplacená cena. Použijte remainingPayment
remainingPayment - SimplePrice! Zbývající částka k zaplacení.
paymentUrl - String! Odkaz s informacemi pro zaplacení objednávky.
bankAccount - String! Bankovní účet pro zaslání platby (v případě platby převodem).
Example
{
  "id": 953,
  "source": OrderSource,
  "dateCreated": "\"2022-02-01 08:00:00\"",
  "dateAccept": "\"2022-02-01 08:00:00\"",
  "dateHandle": "\"2022-02-01 08:00:00\"",
  "dateUpdated": "\"2022-02-01 08:00:00\"",
  "currency": Currency,
  "language": Language,
  "currencyRate": 1,
  "code": "2200953",
  "userId": 123,
  "user": User,
  "flags": [],
  "status": 1,
  "email": "wpj@wpj.cz",
  "cancelled": true,
  "isCancellable": false,
  "totalPrice": TotalPrice,
  "deliveryType": DeliveryType,
  "deliveryInfo": OrderDeliveryInfo,
  "priceLevel": PriceLevel,
  "invoiceAddress": Address,
  "deliveryAddress": Address,
  "packageId": "DR1104116859M",
  "noteUser": "xyz789",
  "noteInvoice": "abc123",
  "items": [OrderItem],
  "isPaid": false,
  "paidPrice": TotalPrice,
  "remainingPayment": SimplePrice,
  "paymentUrl": "xyz789",
  "bankAccount": "xyz789"
}

OrderCollection

Fields
Field Name Description
items - [Order!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Order],
  "hasNextPage": true,
  "hasPreviousPage": false
}

OrderDeliveryInfo

Fields
Field Name Description
pointId - String ID zvoleného odběrného místa.
packageId - String Číslo balíku.
trackingUrl - String URL pro trasovování balíku.
Example
{
  "pointId": "abc123",
  "packageId": "abc123",
  "trackingUrl": "abc123"
}

OrderDocumentInput

Fields
Input Field Description
type - OrderDocumentType Typ dokumentu.
url - String Odkaz na dokument ve formátu PDF.
Example
{"type": "INVOICE", "url": "xyz789"}

OrderDocumentType

Values
Enum Value Description

INVOICE

PROFORMA

Example
"INVOICE"

OrderDropshipmentInfo

Fields
Field Name Description
externalId - String Externí ID objednávky.
data - String! Data týkající se konkrétní objednávky v JSON formátu
Example
{
  "externalId": "abc123",
  "data": "abc123"
}

OrderFilterInput

Fields
Input Field Description
id - [Int!] Filtr podle pole ID objednávek. Default = null
code - [String!] Filtr podle pole kódů objednávek. Default = null
status - [Int!] Filtr podle pole stavů objednávek. Default = null
userId - [Int!] Filtr podle ID uživatele. Default = null
deliveryId - [Int!] Filtr podle ID dopravy. Default = null
paymentId - [Int!] Filtr podle ID platby. Default = null
sellerId - [Int!] Filtr podle ID prodejny, na které objednávka vznikla. Default = null
dateCreated - DateFilterInput Filtr podle data vytvoření. Default = null
dateUpdated - DateFilterInput Filtr podle data poslední změny. Default = null
dateFrom - DateTime
dateTo - DateTime
Example
{
  "id": [987],
  "code": ["abc123"],
  "status": [987],
  "userId": [123],
  "deliveryId": [987],
  "paymentId": [987],
  "sellerId": [123],
  "dateCreated": DateFilterInput,
  "dateUpdated": DateFilterInput,
  "dateFrom": "\"2022-02-01 08:00:00\"",
  "dateTo": "\"2022-02-01 08:00:00\""
}

OrderItem

Fields
Field Name Description
id - Int! Interní ID položky objednávky.
productId - Int Interní ID produktu.
variationId - Int Interní ID varianty.
pieces - Float! Počet objednaných kusů.
piecePrice - Price! Cena za kus.
totalPrice - Price! Celková cena.
vat - Float! DPH v %.
code - String Kod položky.
product - Product Produkt.
type - String!

Typ položky. Možné typy:

  • product - řádek obsahuje produkt
  • discount - řádek se slevou
  • delivery - řádek s cenou způsobu doručení (doprava + platba).
  • gift - dárek
  • coupon - uplatněný kupón (neproduktová položka, která ponižuje objednávku o danou částku)
  • text - textová položka (neproduktová položka)
  • orders_charge - příplatek k objednávce.
chargeId - Int
name - String! Název položky.
data - String! JSON data položky, která mohou obsahovat různé dodatečné informace o položce.
Example
{
  "id": 123,
  "productId": 100,
  "variationId": 25,
  "pieces": 2,
  "piecePrice": Price,
  "totalPrice": Price,
  "vat": 21,
  "code": "X100-01",
  "product": Product,
  "type": "xyz789",
  "chargeId": 987,
  "name": "Tepláky WPJ (Velikost: M)",
  "data": "xyz789"
}

OrderMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
order - Order! Zaktualizovaný objekt objednávky.
Example
{"result": false, "order": Order}

OrderSortInput

Fields
Input Field Description
id - SortEnum
code - SortEnum
dateCreated - SortEnum
dateHandle - SortEnum
dateUpdated - SortEnum
Example
{
  "id": "ASC",
  "code": "ASC",
  "dateCreated": "ASC",
  "dateHandle": "ASC",
  "dateUpdated": "ASC"
}

OrderSource

Fields
Field Name Description
source - String! Zdroj objednávky.
name - String! Název zdroje objednávky.
info - OrderDropshipmentInfo Dodatečné informace o objednávce, které se týkají konkrétního zdroje.
Example
{
  "source": "abc123",
  "name": "abc123",
  "info": OrderDropshipmentInfo
}

OrderStatus

Fields
Field Name Description
id - Int! ID.
name - String! Název.
Example
{"id": 123, "name": "abc123"}

OrderStornoInput

Fields
Input Field Description
id - Int! ID objednávky.
message - String Důvod storna. Default = null
sendMail - Boolean Zda se má uživateli odeslat mail o stornovaní objednávky. Pokud nebude vyplněno, tak bude odesláno na základě nastavení e-shopu. Default = null
Example
{
  "id": 987,
  "message": "abc123",
  "sendMail": false
}

OrderUpdateInput

Fields
Input Field Description
id - Int ID objednávky.
status - StatusModifyInput Stav objednávky.
packageId - String Číslo balíku. Více čísel balíků je potřeba oddělit čárkou.
invoiceUrl - String Odkaz na fakturu ve formátu PDF. Při nastavení bude použita místo standartní e-shopové faktury.
documents - [OrderDocumentInput!] Nastavení vlastních PDF dokladů.
Example
{
  "id": 123,
  "status": StatusModifyInput,
  "packageId": "xyz789",
  "invoiceUrl": "xyz789",
  "documents": [OrderDocumentInput]
}

Parameter

Fields
Field Name Description
id - Int! ID.
name - String! Název.
visible - Boolean! Viditelnost
type - ParameterTypeEnum! Typ.
unit - String Jednotka.
Example
{
  "id": 987,
  "name": "abc123",
  "visible": false,
  "type": "LIST",
  "unit": "xyz789"
}

ParameterCollection

Fields
Field Name Description
items - [Parameter!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Parameter],
  "hasNextPage": false,
  "hasPreviousPage": false
}

ParameterCreateInput

Fields
Input Field Description
name - String! Název.
type - ParameterTypeEnum!

Typ.

  • LIST - seznam - používá se pokud se jedná o menší počet hodnot, které se furt opakují. Například pro parametr barva.
  • TEXT - text - textový parametr, delší text, který může být pro každý produkt úplně jiný.
  • NUMBER - číslo - číslený parametr.
unit - String Jednotka (například: g). Default = null
Example
{
  "name": "xyz789",
  "type": "LIST",
  "unit": "xyz789"
}

ParameterListFilterInput

Fields
Input Field Description
parameterId - [Int!] Filtr podle ID parametru. Default = null
Example
{"parameterId": [123]}

ParameterTranslationInput

Fields
Input Field Description
parameterId - Int ID parametru.
language - String Jazyk.
name - String Název.
Example
{
  "parameterId": 987,
  "language": "abc123",
  "name": "abc123"
}

ParameterTranslationMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
Example
{"result": true}

ParameterTypeEnum

Values
Enum Value Description

LIST

TEXT

NUMBER

Example
"LIST"

ParameterValue

Fields
Field Name Description
parameter - Parameter! Parametr, ke kterému hodnota patří.
id - Int ID hodnoty parametru. Vrací null v případě, že se nejedná o parametr typu LIST.
description - String Rozšiřující popis hodnoty parametru.
value - String Hodnota parametru.
text - String Textová hodnota. Pokud je parametr typu TEXT.
list - String Textová hodnota. Pokud je parametr typu LIST.
number - Float Číslená hodnota. Pokud je parametr typu NUMBER.
Example
{
  "parameter": Parameter,
  "id": 123,
  "description": "abc123",
  "value": "abc123",
  "text": "xyz789",
  "list": "abc123",
  "number": 123.45
}

ParameterValueInput

Fields
Input Field Description
text - String Textová hodnota. Default = null
list - String Seznamová hodnota. Default = null
number - Float Číselná hodnota. Default = null
Example
{
  "text": "xyz789",
  "list": "xyz789",
  "number": 123.45
}

ParameterValuesCollection

Fields
Field Name Description
items - [ParameterValue!]! Hodnoty parametrů
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [ParameterValue],
  "hasNextPage": true,
  "hasPreviousPage": true
}

ParameterValuesTranslationInput

Fields
Input Field Description
valueId - Int ID hodnoty parametru.
language - String Jazyk.
value - String Hodnota.
Example
{
  "valueId": 987,
  "language": "abc123",
  "value": "xyz789"
}

ParameterValuesTranslationMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
Example
{"result": true}

Payment

Fields
Field Name Description
id - Int! ID platby.
type - String! Typ platby.
name - String! Název platby.
Example
{
  "id": 987,
  "type": "abc123",
  "name": "xyz789"
}

PaymentCollection

Fields
Field Name Description
items - [Payment!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Payment],
  "hasNextPage": false,
  "hasPreviousPage": false
}

PaymentMethod

Fields
Field Name Description
type - String!
name - String!
Example
{
  "type": "abc123",
  "name": "xyz789"
}

Photo

Fields
Field Name Description
id - Int! Interní ID.
source - String! URL cesta.
sourceOriginal - String! URL cesta k originálnímu souboru.
width - Int Šířka.
height - Int Výška.
Example
{
  "id": 123,
  "source": "https://<domain>/data/photo.png",
  "sourceOriginal": "xyz789",
  "width": 123,
  "height": 123
}

PhotoInput

Fields
Input Field Description
url - String! URL cesta k obrázku.
description - String Popis obrázku. Default = null
Example
{
  "url": "xyz789",
  "description": "abc123"
}

PhotoInterface

Fields
Field Name Description
id - Int! Interní ID.
source - String! URL cesta.
sourceOriginal - String! URL cesta k originálnímu souboru.
width - Int Šířka.
height - Int Výška.
Possible Types
PhotoInterface Types

ProductPhoto

Photo

Example
{
  "id": 987,
  "source": "abc123",
  "sourceOriginal": "abc123",
  "width": 123,
  "height": 123
}

PhotoModifyInput

Fields
Input Field Description
action - ActionTypeEnum!
idPhoto - Int
showInLead - Boolean
active - Boolean
position - Int
Example
{
  "action": "CREATE",
  "idPhoto": 123,
  "showInLead": true,
  "active": false,
  "position": 123
}

PhotoSizeEnum

Values
Enum Value Description

PHOTO_DETAIL

PHOTO_CATALOG

PHOTO_CART

Example
"PHOTO_DETAIL"

Price

Fields
Field Name Description
withVat - Float! Cena s DPH.
withoutVat - Float! Cena bez DPH.
vatValue - Float! Hodnota DPH.
vat - Float! DPH v %.
currency - Currency! Měna.
Example
{
  "withVat": 121,
  "withoutVat": 100,
  "vatValue": 21,
  "vat": 21,
  "currency": Currency
}

PriceLevel

Fields
Field Name Description
id - Int! ID.
name - String! Název.
discount - PriceLevelDiscount! Sleva pro veškeré zboží.
Example
{
  "id": 987,
  "name": "xyz789",
  "discount": PriceLevelDiscount
}

PriceLevelDiscount

Fields
Field Name Description
value - Float! Hodnota slevy.
unit - String! Jednotka slevy. Může být: %, CZK, EUR...
Example
{"value": 987.65, "unit": "abc123"}

PriceList

Fields
Field Name Description
id - Int! ID.
currency - Currency! Měna, ve kteté jsou ceny v ceníku.
name - String! Název ceníku.
Example
{
  "id": 123,
  "currency": Currency,
  "name": "xyz789"
}

PriceListCollection

Fields
Field Name Description
items - [PriceList!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [PriceList],
  "hasNextPage": false,
  "hasPreviousPage": true
}

PriceListInput

Fields
Input Field Description
name - String! Název.
currency - String! Měna, ve které budou ceny v ceníku uložené.
Example
{
  "name": "xyz789",
  "currency": "abc123"
}

PriceListMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
priceList - PriceList! Vytvořený ceník.
Example
{"result": true, "priceList": PriceList}

PriceModifyInput

Fields
Input Field Description
priceWithoutVat - Float Cena bez DPH. Je potřeba vyplnit buď cenu bez DPH, a nebo cenu s DPH. Není potřeba vyplnit obě. Pokud budou vyplněny obě, tak se upřednostní cena bez DPH. Default = null
priceWithVat - Float Cena s DPH. Je potřeba vyplnit buď cenu bez DPH, a nebo cenu s DPH. Není potřeba vyplnit obě. Pokud budou vyplněny obě, tak se upřednostní cena bez DPH. Default = null
Example
{"priceWithoutVat": 987.65, "priceWithVat": 123.45}

Producer

Fields
Field Name Description
id - Int!
name - String!
web - String!
active - Boolean!
photo - PhotoInterface
Example
{
  "id": 123,
  "name": "abc123",
  "web": "xyz789",
  "active": false,
  "photo": PhotoInterface
}

ProducerCollection

Fields
Field Name Description
items - [Producer!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Producer],
  "hasNextPage": false,
  "hasPreviousPage": false
}

ProducerInput

Fields
Input Field Description
id - Int ID výrobce. Povinné při aktualizaci výrobce.
name - String Název.
web - String URL na web výrobce.
active - Boolean Aktivní / neaktivní.
Example
{
  "id": 987,
  "name": "abc123",
  "web": "xyz789",
  "active": false
}

ProducerMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
producer - Producer! Vytvořený / aktualizovaný výrobce.
Example
{"result": true, "producer": Producer}

Product

Fields
Field Name Description
id - Int! Interní ID.
variationId - Int ID varianty.
url - String! URL adresa.
code - String Kód.
ean - String EAN.
inStore - Float! Počet kusů skladem.
inStoreSuppliers - Float! Počet kusů skladem u dodavatele.
stores - [StoreItem!]! Skladovost na jednotlivých skladech.
title - String! Název produktu.
variationTitle - String Název varianty.
description - String! Krátký popis produktu.
longDescription - String! Dlouhý popis produktu (HTML).
additionalDescription - String! Rozšiřující popis.
descriptionPlus - EditableContent! Popis+ - editovatelný obsah.
discount - Float! Sleva.
producer - Producer Výrobce.
price - Price! Cena.
priceBuy - Price Nákupní cena
visible - Boolean! Viditelný.
visibility - ProductVisibilityEnum! Viditelnost.
weight - Float Váha v kg.
width - Float Šířka v cm.
height - Float Výška v cm.
depth - Float Hloubka v cm.
seo - Seo! SEO.
unit - ProductUnit! Jednotka produktu.
links - [ProductLink!]! Odkazy k produktu.
relatedProducts - [Product!]! Související produkty.
collectionProducts - [Product!]! Kolekce.
parameters - [ProductParameter!]! Parametry.
variations - [Variation!]! Varianty.
priceLists - [ProductPriceList!]! Ceníky.
labels - [Label!]! Štítky.
sections - [Section!]! Sekce, ve kterých je produkt zařazen.
Arguments
photos - [ProductPhoto!]! Obrázky.
Arguments
size - PhotoSizeEnum
photo - ProductPhoto! Hlavní obrázek produktu.
Arguments
size - PhotoSizeEnum
Example
{
  "id": 100,
  "variationId": 987,
  "url": "xyz789",
  "code": "X100",
  "ean": "0000123456789",
  "inStore": 50,
  "inStoreSuppliers": 987.65,
  "stores": [StoreItem],
  "title": "Tepláky WPJ",
  "variationTitle": "abc123",
  "description": "Tepláky WPJ",
  "longDescription": "<p>Tepláky WPJ</p>",
  "additionalDescription": "abc123",
  "descriptionPlus": EditableContent,
  "discount": 10,
  "producer": Producer,
  "price": Price,
  "priceBuy": Price,
  "visible": true,
  "visibility": "VISIBLE",
  "weight": 0.2,
  "width": 123.45,
  "height": 987.65,
  "depth": 987.65,
  "seo": Seo,
  "unit": ProductUnit,
  "links": [ProductLink],
  "relatedProducts": [Product],
  "collectionProducts": [Product],
  "parameters": [ProductParameter],
  "variations": [Variation],
  "priceLists": [ProductPriceList],
  "labels": [Label],
  "sections": [Section],
  "photos": [ProductPhoto],
  "photo": ProductPhoto
}

ProductBaseInterface

Fields
Field Name Description
id - Int! Interní ID.
variationId - Int ID varianty.
url - String! URL adresa.
code - String Kód.
ean - String EAN.
inStore - Float! Počet kusů skladem.
inStoreSuppliers - Float! Počet kusů skladem u dodavatele.
stores - [StoreItem!]! Skladovost na jednotlivých skladech.
title - String! Název produktu.
variationTitle - String Název varianty.
description - String! Krátký popis produktu.
longDescription - String! Dlouhý popis produktu (HTML).
additionalDescription - String! Rozšiřující popis.
descriptionPlus - EditableContent! Popis+ - editovatelný obsah.
discount - Float! Sleva.
producer - Producer Výrobce.
price - Price! Cena.
priceBuy - Price Nákupní cena
visible - Boolean! Viditelný.
visibility - ProductVisibilityEnum! Viditelnost.
weight - Float Váha v kg.
width - Float Šířka v cm.
height - Float Výška v cm.
depth - Float Hloubka v cm.
seo - Seo! SEO.
unit - ProductUnit! Jednotka produktu.
links - [ProductLink!]! Odkazy k produktu.
relatedProducts - [Product!]! Související produkty.
collectionProducts - [Product!]! Kolekce.
parameters - [ProductParameter!]! Parametry.
variations - [Variation!]! Varianty.
priceLists - [ProductPriceList!]! Ceníky.
labels - [Label!]! Štítky.
sections - [Section!]! Sekce, ve kterých je produkt zařazen.
Arguments
photos - [ProductPhoto!]! Obrázky.
Arguments
size - PhotoSizeEnum
Possible Types
ProductBaseInterface Types

Product

Example
{
  "id": 123,
  "variationId": 123,
  "url": "xyz789",
  "code": "xyz789",
  "ean": "xyz789",
  "inStore": 123.45,
  "inStoreSuppliers": 123.45,
  "stores": [StoreItem],
  "title": "xyz789",
  "variationTitle": "abc123",
  "description": "abc123",
  "longDescription": "xyz789",
  "additionalDescription": "xyz789",
  "descriptionPlus": EditableContent,
  "discount": 123.45,
  "producer": Producer,
  "price": Price,
  "priceBuy": Price,
  "visible": true,
  "visibility": "VISIBLE",
  "weight": 987.65,
  "width": 987.65,
  "height": 123.45,
  "depth": 123.45,
  "seo": Seo,
  "unit": ProductUnit,
  "links": [ProductLink],
  "relatedProducts": [Product],
  "collectionProducts": [Product],
  "parameters": [ProductParameter],
  "variations": [Variation],
  "priceLists": [ProductPriceList],
  "labels": [Label],
  "sections": [Section],
  "photos": [ProductPhoto]
}

ProductCollection

Fields
Field Name Description
items - [Product!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Product],
  "hasNextPage": false,
  "hasPreviousPage": true
}

ProductFilterInput

Fields
Input Field Description
id - [Int]
ean - [String]
code - [String]
producer - [Int]
section - [Int]
sectionRecursive - [Int]
dateCreated - DateFilterInput
dateUpdated - DateFilterInput
Example
{
  "id": [987],
  "ean": ["xyz789"],
  "code": ["xyz789"],
  "producer": [987],
  "section": [987],
  "sectionRecursive": [987],
  "dateCreated": DateFilterInput,
  "dateUpdated": DateFilterInput
}

ProductLinkInput

Fields
Input Field Description
productId - Int! ID produktu.
links - [LinkItemInput!]! Odkazy.
append - Boolean
  • Pokud true, tak se u produktu zachovají aktuální odkazy a k nim se přidají odkazy specifikované v links.
  • Pokud false, tak u produktu smaže aktuální odkazy a přidá odkazy, které jsou specifikované ve links. Default = false
Example
{
  "productId": 987,
  "links": [LinkItemInput],
  "append": false
}

ProductModifyInput

Fields
Input Field Description
id - Int ID. Vyplňuje se pouze v případě aktualizace, pokud chceme založit nový produkt, tak ID nevyplňujeme.
code - String Kód.
ean - String EAN.
inStore - Float Počet kusů skladem.
title - String Název. Povinný pokud vytváříme nový produkt.
description - String Anotace.
longDescription - String Popis. Může obsahovat i HTML tagy.
additionalDescription - String Rozšiřující popis.
discount - Float Sleva v procentech.
price - PriceModifyInput Cena.
priceBuy - PriceModifyInput Nákupní cena
vat - Float Sazba DPH.
visibility - ProductVisibilityEnum Viditelnost.
visible - Boolean Viditelnost.
sections - [Int!] Sekce produktu. Je potřeba poslat ID sekcí.
producerId - Int ID výrobce.
photos - [PhotoModifyInput!] Obrázky produktu.
weight - Float Váha.
ossCategory - String OSS kategorie. Potřeba vyplnit CN kód dané kategorie.
width - Float Šířka v cm.
height - Float Výška v cm.
depth - Float Hloubka v cm.
seo - SeoInput SEO.
Example
{
  "id": 987,
  "code": "xyz789",
  "ean": "xyz789",
  "inStore": 987.65,
  "title": "xyz789",
  "description": "xyz789",
  "longDescription": "xyz789",
  "additionalDescription": "abc123",
  "discount": 123.45,
  "price": PriceModifyInput,
  "priceBuy": PriceModifyInput,
  "vat": 123.45,
  "visibility": "VISIBLE",
  "visible": true,
  "sections": [987],
  "producerId": 987,
  "photos": [PhotoModifyInput],
  "weight": 987.65,
  "ossCategory": "abc123",
  "width": 123.45,
  "height": 987.65,
  "depth": 987.65,
  "seo": SeoInput
}

ProductMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
product - Product! Zaktualizovaný objekt produktu.
Example
{"result": true, "product": Product}

ProductMutateResponseInterface

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
product - Product! Zaktualizovaný objekt produktu.
Possible Types
ProductMutateResponseInterface Types

VariationMutateResponse

ProductMutateResponse

Example
{"result": true, "product": Product}

ProductParameter

Fields
Field Name Description
values - [ParameterValue!]!
parameter - Parameter!
Example
{
  "values": [ParameterValue],
  "parameter": Parameter
}

ProductParameterInput

Fields
Input Field Description
productId - Int! ID produktu.
parameterId - Int! ID parametru.
values - [ParameterValueInput]! Hodnota parametru.
append - Boolean
  • Pokud true, tak se u produktu zachovají aktuální hodnoty a k nim se přidají hodnoty specifikované ve values.
  • Pokud false, tak u produktu smaže aktuální hodnoty a přidá pouze nové, které jsou specifikované ve values. Default = false
Example
{
  "productId": 123,
  "parameterId": 123,
  "values": [ParameterValueInput],
  "append": false
}

ProductPhoto

Fields
Field Name Description
id - Int! Interní ID.
source - String! URL cesta.
sourceOriginal - String! URL cesta k originálnímu souboru.
width - Int Šířka.
height - Int Výška.
showInLead - String

Typ

  • Y = hlavní obrázek
  • N = vedlejší obrázek.
Example
{
  "id": 987,
  "source": "abc123",
  "sourceOriginal": "xyz789",
  "width": 123,
  "height": 123,
  "showInLead": "xyz789"
}

ProductPriceList

Fields
Field Name Description
priceList - PriceList! Ceník.
price - Price! Cena.
Example
{
  "priceList": PriceList,
  "price": Price
}

ProductPriceListInput

Fields
Input Field Description
productId - Int ID produktu.
variationId - Int ID varianty.
priceListId - Int ID ceníku. Pokud nastavíte null, tak se bude provádět aktualizace výchozího skladu.
price - PriceModifyInput Cena. Pokud se vyplní null, tak se cena z ceníku smaže.
discount - Float Sleva v procentech.
Example
{
  "productId": 123,
  "variationId": 123,
  "priceListId": 987,
  "price": PriceModifyInput,
  "discount": 123.45
}

ProductPurchaseItem

Fields
Field Name Description
productId - Int! ID produktu.
variationId - Int ID varianty.
name - String! Název.
pieces - Float! Počet kusů.
piecePrice - Price! Jednotková cena.
totalPrice - Price! Celková cena.
Example
{
  "productId": 987,
  "variationId": 123,
  "name": "xyz789",
  "pieces": 987.65,
  "piecePrice": Price,
  "totalPrice": Price
}

ProductSortInput

Fields
Input Field Description
id - SortEnum
title - SortEnum
ean - SortEnum
Example
{"id": "ASC", "title": "ASC", "ean": "ASC"}

ProductStoreInput

Fields
Input Field Description
productId - Int! ID produktu.
variationId - Int ID varianty. Default = null
storeId - Int! ID skladu.
quantity - Float! Počet kusů skladem.
Example
{"productId": 987, "variationId": 123, "storeId": 987, "quantity": 123.45}

ProductTranslationInput

Fields
Input Field Description
productId - Int ID produktu.
language - String Jazyk.
title - String Název produktu.
description - String Anotace.
longDescription - String Popis. Může obsahovat i HTML tagy.
additionalDescription - String Rozšiřující popis.
visibility - ProductVisibilityEnum Viditelnost.
seo - SeoInput SEO.
Example
{
  "productId": 123,
  "language": "abc123",
  "title": "xyz789",
  "description": "xyz789",
  "longDescription": "xyz789",
  "additionalDescription": "xyz789",
  "visibility": "VISIBLE",
  "seo": SeoInput
}

ProductTranslationMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
Example
{"result": true}

ProductUnit

Fields
Field Name Description
name - String! Název jednotky.
longName - String Dlouhý název jednotky.
Example
{
  "name": "abc123",
  "longName": "abc123"
}

ProductVisibilityEnum

Values
Enum Value Description

VISIBLE

CLOSED

HIDDEN

Example
"VISIBLE"

PurchaseCalculateInput

Fields
Input Field Description
items - [PurchaseItemInput!]! Položky nákupu.
coupons - [String!] Poukazy, které se mají při cenění nákupu použít. Default = null
userId - Int ID uživatele, který se má při cenění nákupu aktivovat. Default = null
Example
{
  "items": [PurchaseItemInput],
  "coupons": ["abc123"],
  "userId": 987
}

PurchaseItemInput

Fields
Input Field Description
productId - Int ID produktu. Default = null
variationId - Int ID varianty. Default = null
code - String Kód produktu/varianty. Může se vyplnit místo ID produktu a ID varianty. Default = null
pieces - Float! Počet kusů.
price - Float Cena. Celková cena za všechny kusy s DPH. Pokud nebude vyplněna, tak se převezme cena z e-shopu. Default = null
Example
{
  "productId": 123,
  "variationId": 123,
  "code": "xyz789",
  "pieces": 987.65,
  "price": 987.65
}

PurchaseState

Fields
Field Name Description
products - [ProductPurchaseItem!]! Produkty.
discounts - [UnionDiscountPurchaseItemProductPurchaseItem!]! Slevy.
totalPrice - TotalPrice! Celková cena nákupu.
totalPriceDiscounts - TotalPrice! Celková sleva uplatněná na nákup.
Example
{
  "products": [ProductPurchaseItem],
  "discounts": [DiscountPurchaseItem],
  "totalPrice": TotalPrice,
  "totalPriceDiscounts": TotalPrice
}

RelatedItemInput

Fields
Input Field Description
productId - Int! ID produktu.
Example
{"productId": 987}

RelatedProductsInput

Fields
Input Field Description
productId - Int! ID produktu.
products - [RelatedItemInput!]! Produkty, které mají být v souvisejícím zboží.
append - Boolean
  • Pokud true, tak se u produktu zachovají aktuální související produkty a k nim se přidají související produktu specifikované v products.
  • Pokud false, tak u produktu smažou aktuální související produkty a přidá související produkty, které jsou specifikované v products. Default = false
type - Int ID z listu souvisejícího typu produktu. Default = null
Example
{
  "productId": 123,
  "products": [RelatedItemInput],
  "append": true,
  "type": 987
}

Sale

Fields
Field Name Description
id - Int! ID
code - String! Kód
currency - Currency! Měna
language - Language! Jazyk
dateCreated - DateTime! Datum vytvoření
user - User Uživatel
deliveryType - DeliveryType Způsob doručení
note - String Poznámka
totalPrice - TotalPrice! Celková cena
data - String! JSON data
items - [SaleItem!]! Položky
Example
{
  "id": 123,
  "code": "xyz789",
  "currency": Currency,
  "language": Language,
  "dateCreated": "\"2022-02-01 08:00:00\"",
  "user": User,
  "deliveryType": DeliveryType,
  "note": "abc123",
  "totalPrice": TotalPrice,
  "data": "abc123",
  "items": [SaleItem]
}

SaleCollection

Fields
Field Name Description
items - [Sale!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Sale],
  "hasNextPage": true,
  "hasPreviousPage": true
}

SaleFilterInput

Fields
Input Field Description
id - [Int!] Filtr podle ID prodejek. Default = null
code - [String!] Filtr podle kódu prodejek. Default = null
dateCreated - DateFilterInput Filtr podle data vytvoření. Default = null
Example
{
  "id": [123],
  "code": ["xyz789"],
  "dateCreated": DateFilterInput
}

SaleItem

Fields
Field Name Description
id - Int! ID
productId - Int Interní ID produktu.
variationId - Int Interní ID varianty.
pieces - Float! Počet objednaných kusů.
piecePrice - Price! Cena za kus.
totalPrice - Price! Celková cena.
name - String! Název položky.
product - Product Produkt.
Example
{
  "id": 123,
  "productId": 987,
  "variationId": 987,
  "pieces": 123.45,
  "piecePrice": Price,
  "totalPrice": Price,
  "name": "abc123",
  "product": Product
}

SaleSortInput

Fields
Input Field Description
id - SortEnum
code - SortEnum
dateCreated - SortEnum
Example
{"id": "ASC", "code": "ASC", "dateCreated": "ASC"}

Section

Fields
Field Name Description
id - Int! ID.
name - String! Název.
nameShort - String! Krátký název.
visible - Boolean! Viditelnost.
url - String! URL adresa.
photo - ProductPhoto Obrázek.
hasChildren - Boolean! Sekce má nebo nemá podsekce.
isVirtual - Boolean! Sekce je virtuální.
parent - Section Nadřazená sekce.
parents - [Section!]! Nadřazené sekce.
children - [Section!]! Podsekce.
description - EditableContent! Popis.
Example
{
  "id": 987,
  "name": "abc123",
  "nameShort": "xyz789",
  "visible": true,
  "url": "xyz789",
  "photo": ProductPhoto,
  "hasChildren": true,
  "isVirtual": true,
  "parent": Section,
  "parents": [Section],
  "children": [Section],
  "description": EditableContent
}

SectionCollection

Fields
Field Name Description
items - [Section!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Section],
  "hasNextPage": false,
  "hasPreviousPage": false
}

SectionFilterInput

Fields
Input Field Description
visible - Boolean Filtruje jen viditelné nebo jen skryté sekce. Default = null
isVirtual - Boolean Filtruje pouze nevirtuálních/virtuálních sekcí. Default = null
Example
{"visible": false, "isVirtual": true}

SectionTranslationInput

Fields
Input Field Description
sectionId - Int ID sekce.
language - String Jazyk.
name - String Název.
nameShort - String Krátký název.
Example
{
  "sectionId": 123,
  "language": "abc123",
  "name": "abc123",
  "nameShort": "xyz789"
}

SectionTranslationMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
Example
{"result": false}

Seller

Fields
Field Name Description
id - Int! ID prodejny.
visible - Boolean! Viditelnost.
latitude - Float Zeměpisná šířka.
longitude - Float Zeměpisná délka.
store - Store Sklad prodejny.
name - String! Název prodejny.
type - String! Typ prodejny.
typeName - String! Název typu prodejny.
email - String! E-mail prodejny.
street - String! Ulice.
zip - String! PSČ.
city - String! Město.
phone - String! Telefon prodejny.
country - Country! Země.
description - String HTML popis.
photos - [PhotoInterface!]! Obrázky.
isOrderingAllowed - Boolean! Informace, zda je možné na danou prodejnu vytvořit objednávku.
data - String JSON řetězec obsahující dodatečná data.
content - EditableContent! Editovatelný obsah.
Example
{
  "id": 123,
  "visible": false,
  "latitude": 123.45,
  "longitude": 987.65,
  "store": Store,
  "name": "abc123",
  "type": "xyz789",
  "typeName": "abc123",
  "email": "abc123",
  "street": "xyz789",
  "zip": "abc123",
  "city": "xyz789",
  "phone": "abc123",
  "country": Country,
  "description": "xyz789",
  "photos": [PhotoInterface],
  "isOrderingAllowed": true,
  "data": "abc123",
  "content": EditableContent
}

SellerCollection

Fields
Field Name Description
items - [Seller!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Seller],
  "hasNextPage": false,
  "hasPreviousPage": false
}

SellerInput

Fields
Input Field Description
id - Int ID.
visible - Boolean ID prodejny.
storeId - Int ID skladu, který se má prodejně nastavit.
name - String Název.
latitude - Float Zeměpisná šířka.
longitude - Float Zeměpisná délka.
description - String HTML popis.
type - String Typ prodejny.
email - String E-mail.
street - String Ulice prodejny.
city - String Město.
zip - String PSČ.
phone - String Telefon.
country - String Země - ISO kód země.
photos - [PhotoInput!] Obrázky.
data - String JSON řetězec obsahující dodatečná data.
deletePhotos - Boolean Pokud true, tak smaže obrázky prodejny.
Example
{
  "id": 987,
  "visible": true,
  "storeId": 987,
  "name": "xyz789",
  "latitude": 987.65,
  "longitude": 123.45,
  "description": "xyz789",
  "type": "abc123",
  "email": "abc123",
  "street": "abc123",
  "city": "abc123",
  "zip": "abc123",
  "phone": "xyz789",
  "country": "xyz789",
  "photos": [PhotoInput],
  "data": "xyz789",
  "deletePhotos": false
}

SellerMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
seller - Seller! Vytvořená / aktualizovaná prodejna.
Example
{"result": true, "seller": Seller}

Seo

Fields
Field Name Description
title - String SEO název.
description - String SEO popis.
keywords - String SEO klíčová slova.
Example
{
  "title": "abc123",
  "description": "abc123",
  "keywords": "xyz789"
}

SeoInput

Fields
Input Field Description
title - String SEO název.
description - String SEO popisek.
keywords - String SEO klíčová slova.
Example
{
  "title": "abc123",
  "description": "abc123",
  "keywords": "xyz789"
}

SimplePrice

Fields
Field Name Description
price - Float! Cena.
currency - Currency! Měna.
Example
{"price": 123.45, "currency": Currency}

SortEnum

Values
Enum Value Description

ASC

DESC

Example
"ASC"

StatusModifyInput

Fields
Input Field Description
id - Int! ID stavu.
comment - String Interní komentář změny stavu. Default = null
userMessage - String Název e-mailu ze zpráv uživatelům, který se při změně stavu má odeslat. Default = null
Example
{
  "id": 987,
  "comment": "xyz789",
  "userMessage": "xyz789"
}

Store

Fields
Field Name Description
id - Int! ID.
name - String! Název.
type - StoreType!

Typ skladu.

  • MAIN_STORE - hlavní sklad
  • STORE - sklad
  • EXTERNAL_STORE - externí sklad.
visible - Boolean! Viditelný.
Example
{
  "id": 987,
  "name": "xyz789",
  "type": "MAIN_STORE",
  "visible": true
}

StoreCollection

Fields
Field Name Description
items - [Store!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [Store],
  "hasNextPage": true,
  "hasPreviousPage": false
}

StoreCreateInput

Fields
Input Field Description
name - String! Název.
type - StoreType

Typ skladu.

  • STORE - sklad
  • EXTERNAL_STORE - externí sklad.

Pokud se nevyplní, tak se nastaví typ skladu na "STORE". Default = null

visible - Boolean Viditelný. Default = true
Example
{
  "name": "abc123",
  "type": "MAIN_STORE",
  "visible": true
}

StoreItem

Fields
Field Name Description
inStore - Float! Počet kusů na skladu.
store - Store! Sklad.
Example
{"inStore": 987.65, "store": Store}

StoreType

Values
Enum Value Description

MAIN_STORE

STORE

EXTERNAL_STORE

Example
"MAIN_STORE"

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

TotalPrice

Fields
Field Name Description
withVat - Float! Cena s DPH.
withoutVat - Float! Cena bez DPH.
currency - Currency! Měna.
Example
{
  "withVat": 987.65,
  "withoutVat": 123.45,
  "currency": Currency
}

UnionDiscountPurchaseItemProductPurchaseItem

Example
DiscountPurchaseItem

User

Fields
Field Name Description
invoiceAddress - Address! Fakturační adresa.
deliveryAddress - Address! Dodací adresa.
invoiceDetails - Address! Fakturační údaje. use invoiceAddress field
deliveryDetails - Address! Dodací údaje. use deliveryAddress field
gender - String Pohlaví.
isActive - Boolean! Vrací, zda je uživatel aktivní.
newsletterInfo - UserNewsletter! Informace o odběru newsletteru.
dateRegistered - DateTime Datum registrace. Pokud je datum registrace null, tak to znamená, že uživatel není registrovaný, ale je např. přihlášený pouze k newsletteru.
dateUpdated - DateTime Datum poslední změny.
dateLogged - DateTime Datum posledního přihlášení.
note - String Poznámka nastavená administrátorem u uživatele.
priceList - PriceList Ceník nastavený u uživatele.
bonusPoints - Int Počet bodů v bonusovém programu.
dateLastOrder - DateTime Datum poslední objednávky.
priceLevel - PriceLevel Cenová hladina.
birthdate - DateTime Datum narození.
newsletter - String Odběr newslettru. Use newsletterInfo field
subscribeDate - String Datum přihlášení k newsletteru. Use newsletterInfo field
unsubscribeDate - String Datum odhlášení od newsletteru. Use newsletterInfo field
registrationDate - String Datum registrace. Use dateRegistered field
updateDate - String Datum aktualizace. Use dateUpdated field
loggedDate - String Datum posledního přihlášení. Use dateLogged field
figure - String Figure. Use isActive field
id - Int! ID uživatele.
email - String! E-mail.
name - String! Jméno.
surname - String! Příjmení.
userName - String! Celé jméno.
isB2B - Boolean! Vrací, zda je uživatel B2B.
Example
{
  "invoiceAddress": Address,
  "deliveryAddress": Address,
  "invoiceDetails": Address,
  "deliveryDetails": Address,
  "gender": "abc123",
  "isActive": true,
  "newsletterInfo": UserNewsletter,
  "dateRegistered": "\"2022-02-01 08:00:00\"",
  "dateUpdated": "\"2022-02-01 08:00:00\"",
  "dateLogged": "\"2022-02-01 08:00:00\"",
  "note": "xyz789",
  "priceList": PriceList,
  "bonusPoints": 987,
  "dateLastOrder": "\"2022-02-01 08:00:00\"",
  "priceLevel": PriceLevel,
  "birthdate": "\"2022-02-01 08:00:00\"",
  "newsletter": "abc123",
  "subscribeDate": "xyz789",
  "unsubscribeDate": "abc123",
  "registrationDate": "xyz789",
  "updateDate": "abc123",
  "loggedDate": "abc123",
  "figure": "abc123",
  "id": 123,
  "email": "xyz789",
  "name": "abc123",
  "surname": "abc123",
  "userName": "xyz789",
  "isB2B": false
}

UserCollection

Fields
Field Name Description
items - [User!]!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "items": [User],
  "hasNextPage": true,
  "hasPreviousPage": true
}

UserFilterInput

Fields
Input Field Description
id - [Int!]
emails - [String!]
phone - String
dateRegistered - DateFilterInput
dateUpdated - DateFilterInput
Example
{
  "id": [987],
  "emails": ["xyz789"],
  "phone": "xyz789",
  "dateRegistered": DateFilterInput,
  "dateUpdated": DateFilterInput
}

UserInput

Fields
Input Field Description
id - Int ID uživatele. Povinné při aktualizaci uživatele.
email - String E-mail.
isActive - Boolean Aktivní.
priceListId - Int Ceník.
ico - String IČO.
dic - String DIČ.
invoiceAddress - AddressInput Fakturační adresa.
deliveryAddress - AddressInput Dodací adresa.
Example
{
  "id": 987,
  "email": "abc123",
  "isActive": false,
  "priceListId": 123,
  "ico": "abc123",
  "dic": "xyz789",
  "invoiceAddress": AddressInput,
  "deliveryAddress": AddressInput
}

UserMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
user - User! Vytvořený / aktualizovaný uživatel.
Example
{"result": false, "user": User}

UserNewsletter

Fields
Field Name Description
isSubscribed - Boolean! Vrací, zda je uživatel přihlášen k newsletteru.
dateSubscribe - DateTime Datum přihlášení k newsletteru.
dateUnsubscribe - DateTime Datum odhlášení od newsletteru.
Example
{
  "isSubscribed": true,
  "dateSubscribe": "\"2022-02-01 08:00:00\"",
  "dateUnsubscribe": "\"2022-02-01 08:00:00\""
}

UserSortInput

Fields
Input Field Description
id - SortEnum
email - SortEnum
name - SortEnum
surname - SortEnum
Example
{"id": "ASC", "email": "ASC", "name": "ASC", "surname": "ASC"}

Variation

Fields
Field Name Description
id - Int! Interní ID.
code - String Kód.
ean - String EAN.
title - String! Název.
values - [VariationValue!]! Jmenovky a jejich hodnoty přiřazené u varianty
inStore - Float! Počet kusů skladem.
visible - Boolean! Viditelný.
weight - Float Váha v kg.
price - Price! Cena.
priceBuy - Price Nákupní cena.
stores - [StoreItem!]! Skladovost na jednotlivých skladech.
priceLists - [ProductPriceList!]! Ceníky.
Example
{
  "id": 21,
  "code": "X100-01",
  "ean": "0000123456789",
  "title": "Velikost: M",
  "values": [VariationValue],
  "inStore": 50,
  "visible": false,
  "weight": 0.2,
  "price": Price,
  "priceBuy": Price,
  "stores": [StoreItem],
  "priceLists": [ProductPriceList]
}

VariationLabel

Fields
Field Name Description
id - Int! ID jmenovky.
name - String! Název jmenovky.
Example
{"id": 987, "name": "xyz789"}

VariationLabelInput

Fields
Input Field Description
label - String! Jmenovka varianty (např. Velikost, Barva, Velikost bot...).
value - String! Hodnota jmenovky varianty. (např. M, L, XL, červená, modrá...).
Example
{
  "label": "xyz789",
  "value": "xyz789"
}

VariationModifyInput

Fields
Input Field Description
id - Int ID. Vyplňuje se pouze v případě aktualizace, pokud chceme založit nový produkt, tak ID nevyplňujeme. Default = null
productId - Int ID produktu. Default = null
code - String Kód. Default = null
ean - String EAN. Default = null
inStore - Float Počet kusů skladem. Default = null
labels - [VariationLabelInput!] Jmenovka a hodnota varianty, kterou je potřeba vyplnit při vytváření varianty. Default = null
title - String
price - PriceModifyInput Cena. Default = null
visible - Boolean Viditelnost. Default = null
weight - Float Váha. Default = null
photos - [PhotoModifyInput!] Obrázky varianty. Default = []
Example
{
  "id": 123,
  "productId": 123,
  "code": "xyz789",
  "ean": "xyz789",
  "inStore": 123.45,
  "labels": [VariationLabelInput],
  "title": "xyz789",
  "price": PriceModifyInput,
  "visible": false,
  "weight": 123.45,
  "photos": [PhotoModifyInput]
}

VariationMutateResponse

Fields
Field Name Description
result - Boolean! Vrací true / false podle toho, zda byla aktualizace úspěšná nebo nebyla.
product - Product! Zaktualizovaný objekt produktu.
variation - Variation! Zaktualizovaná varianta.
Example
{
  "result": true,
  "product": Product,
  "variation": Variation
}

VariationValue

Fields
Field Name Description
label - VariationLabel! Jmenovka.
value - String! Hodnota jmenovky.
Example
{
  "label": VariationLabel,
  "value": "xyz789"
}