LOCO API - GraphQL

Základní informace o API neleznete zde

Contact

API Support

loco@expan.do

https://loco.expan.do

Terms of Service

https://www.example.com/terms

API Endpoints
# Production:
https://loco-app.expan.do/api/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

articles

Response

Returns an ArticleConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
articleId - Int Filter by article ID
identifier - String Filter by identifier
articleIds - [Int] Filter by array article ID
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Articles(
  $connectionIdExport: Int!,
  $articleId: Int,
  $identifier: String,
  $articleIds: [Int],
  $first: Int!,
  $after: String
) {
  articles(
    connectionIdExport: $connectionIdExport,
    articleId: $articleId,
    identifier: $identifier,
    articleIds: $articleIds,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...ArticleFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 987,
  "articleId": 987,
  "identifier": "abc123",
  "articleIds": [987],
  "first": 987,
  "after": "xyz789"
}
Response
{
  "data": {
    "articles": {
      "pageInfo": PageInfo,
      "edges": [ArticleEdge]
    }
  }
}
Queries

brands

Response

Returns a BrandConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
brandId - Int Filter by brand ID
identifier - String Filter by identifier
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Brands(
  $connectionIdExport: Int!,
  $brandId: Int,
  $identifier: String,
  $first: Int!,
  $after: String
) {
  brands(
    connectionIdExport: $connectionIdExport,
    brandId: $brandId,
    identifier: $identifier,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...BrandFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 123,
  "brandId": 987,
  "identifier": "abc123",
  "first": 987,
  "after": "xyz789"
}
Response
{
  "data": {
    "brands": {
      "pageInfo": PageInfo,
      "edges": [BrandEdge]
    }
  }
}
Queries

categories

Response

Returns a CategoryConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
categoryId - Int Filter by category ID
identifier - String Filter by identifier
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Categories(
  $connectionIdExport: Int!,
  $categoryId: Int,
  $identifier: String,
  $first: Int!,
  $after: String
) {
  categories(
    connectionIdExport: $connectionIdExport,
    categoryId: $categoryId,
    identifier: $identifier,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...CategoryFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 987,
  "categoryId": 987,
  "identifier": "abc123",
  "first": 123,
  "after": "abc123"
}
Response
{
  "data": {
    "categories": {
      "pageInfo": PageInfo,
      "edges": [CategoryEdge]
    }
  }
}
Queries

languages

Description

Return all languages

Response

Returns [Language!]!

Example

Query
query Languages {
  languages {
    languageId
    icu
  }
}
Response
{
  "data": {
    "languages": [
      {"languageId": 123, "icu": "xyz789"}
    ]
  }
}
Queries

options

Response

Returns an OptionConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
optionId - Int Filter by option ID
identifier - String Filter by identifier
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Options(
  $connectionIdExport: Int!,
  $optionId: Int,
  $identifier: String,
  $first: Int!,
  $after: String
) {
  options(
    connectionIdExport: $connectionIdExport,
    optionId: $optionId,
    identifier: $identifier,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...OptionFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 987,
  "optionId": 123,
  "identifier": "abc123",
  "first": 987,
  "after": "abc123"
}
Response
{
  "data": {
    "options": {
      "pageInfo": PageInfo,
      "edges": [OptionEdge]
    }
  }
}
Queries

products

Description

Returns all products marked for export to the desired export connection.

Response

Returns a ProductConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
identifier - String Filter by identifier
productId - Int Filter by product ID
productIds - [Int] Filter by array product ID
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Products(
  $connectionIdExport: Int!,
  $identifier: String,
  $productId: Int,
  $productIds: [Int],
  $first: Int!,
  $after: String
) {
  products(
    connectionIdExport: $connectionIdExport,
    identifier: $identifier,
    productId: $productId,
    productIds: $productIds,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...ProductFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 987,
  "identifier": "xyz789",
  "productId": 987,
  "productIds": [123],
  "first": 123,
  "after": "abc123"
}
Response
{
  "data": {
    "products": {
      "pageInfo": PageInfo,
      "edges": [ProductEdge]
    }
  }
}
Queries

reviews

Response

Returns a ReviewConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
reviewId - Int Filter by category ID
identifier - String Filter by identifier
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Reviews(
  $connectionIdExport: Int!,
  $reviewId: Int,
  $identifier: String,
  $first: Int!,
  $after: String
) {
  reviews(
    connectionIdExport: $connectionIdExport,
    reviewId: $reviewId,
    identifier: $identifier,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...ReviewFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 123,
  "reviewId": 987,
  "identifier": "xyz789",
  "first": 123,
  "after": "xyz789"
}
Response
{
  "data": {
    "reviews": {
      "pageInfo": PageInfo,
      "edges": [ReviewEdge]
    }
  }
}
Queries

tags

Response

Returns a TagConnection!

Arguments
Name Description
connectionIdExport - Int! Export connection id (required)
tagId - Int Filter by tag ID
identifier - String Filter by identifier
first - Int! Limits number of fetched items.
after - String A cursor after which elements are returned.

Example

Query
query Tags(
  $connectionIdExport: Int!,
  $tagId: Int,
  $identifier: String,
  $first: Int!,
  $after: String
) {
  tags(
    connectionIdExport: $connectionIdExport,
    tagId: $tagId,
    identifier: $identifier,
    first: $first,
    after: $after
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
      total
      count
      currentPage
      lastPage
    }
    edges {
      node {
        ...TagFragment
      }
      cursor
    }
  }
}
Variables
{
  "connectionIdExport": 123,
  "tagId": 987,
  "identifier": "xyz789",
  "first": 123,
  "after": "xyz789"
}
Response
{
  "data": {
    "tags": {
      "pageInfo": PageInfo,
      "edges": [TagEdge]
    }
  }
}

Mutations

createOrUpdateArticle

Description

Creates or updates a article, depending on whether it exists in the database. The existence of the article is determined by the identifier.

Response

Returns an Articles

Arguments
Name Description
connectionIdImport - Int! Import connection id (required)
input - [ArticleInput!]

Example

Query
mutation CreateOrUpdateArticle(
  $connectionIdImport: Int!,
  $input: [ArticleInput!]
) {
  createOrUpdateArticle(
    connectionIdImport: $connectionIdImport,
    input: $input
  ) {
    articles {
      articleId
      identifier
    }
  }
}
Variables
{"connectionIdImport": 987, "input": [ArticleInput]}
Response
{
  "data": {
    "createOrUpdateArticle": {"articles": [ArticleOutput]}
  }
}
Mutations

createOrUpdateProduct

Description

Creates or updates a product, depending on whether it exists in the database. The existence of the product is determined by the identifier.

Response

Returns a Products

Arguments
Name Description
connectionIdImport - Int! Import connection id (required)
input - [ProductInput!]

Example

Query
mutation CreateOrUpdateProduct(
  $connectionIdImport: Int!,
  $input: [ProductInput!]
) {
  createOrUpdateProduct(
    connectionIdImport: $connectionIdImport,
    input: $input
  ) {
    products {
      productId
      identifier
    }
  }
}
Variables
{"connectionIdImport": 123, "input": [ProductInput]}
Response
{
  "data": {
    "createOrUpdateProduct": {"products": [ProductOutput]}
  }
}
Mutations

createOrUpdateReview

Description

Creates or updates a review, depending on whether it exists in the database. The existence of the review is determined by the identifier.

Response

Returns a Reviews

Arguments
Name Description
connectionIdImport - Int! Import connection id (required)
input - [ReviewInput!]

Example

Query
mutation CreateOrUpdateReview(
  $connectionIdImport: Int!,
  $input: [ReviewInput!]
) {
  createOrUpdateReview(
    connectionIdImport: $connectionIdImport,
    input: $input
  ) {
    reviews {
      identifier
    }
    errors {
      message
      code
    }
  }
}
Variables
{"connectionIdImport": 123, "input": [ReviewInput]}
Response
{
  "data": {
    "createOrUpdateReview": {
      "reviews": [ReviewOutput],
      "errors": [ErrorOutput]
    }
  }
}

Types

Article

Fields
Field Name Description
articleId - Int
identifier - String!
status - ProductStatus
translation - ArticleTranslation
customData - [CustomData]
Example
{
  "articleId": 123,
  "identifier": "xyz789",
  "status": "TRANSLATION_WAITING",
  "translation": ArticleTranslation,
  "customData": [CustomData]
}
Types

ArticleConnection

Description

A paginated list of Article edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [ArticleEdge!]! A list of Article edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ArticleEdge]
}
Types

ArticleEdge

Description

An edge that contains a node of type Article and a cursor.

Fields
Field Name Description
node - Article! The Article node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Article,
  "cursor": "abc123"
}
Types

ArticleInput

Fields
Input Field Description
identifier - String!
sourceUrl - String
sourceText - ArticleSourceTextInput!
customData - [CustomDataInput!]
Example
{
  "identifier": "abc123",
  "sourceUrl": "abc123",
  "sourceText": ArticleSourceTextInput,
  "customData": [CustomDataInput]
}
Types

ArticleOutput

Fields
Field Name Description
articleId - Int
identifier - String
Example
{"articleId": 123, "identifier": "abc123"}
Types

ArticleSourceTextInput

Fields
Input Field Description
title - String!
perex - String
text - String
seoTitle - String
seoPerex - String
seoUrl - String
seoKeywords - String
Example
{
  "title": "abc123",
  "perex": "xyz789",
  "text": "xyz789",
  "seoTitle": "xyz789",
  "seoPerex": "abc123",
  "seoUrl": "xyz789",
  "seoKeywords": "xyz789"
}
Types

ArticleTranslation

Fields
Field Name Description
language - LanguageEnum
title - String
perex - String
text - String
seoTitle - String
seoPerex - String
seoUrl - String
seoKeywords - String
Example
{
  "language": "cs_CZ",
  "title": "abc123",
  "perex": "abc123",
  "text": "xyz789",
  "seoTitle": "abc123",
  "seoPerex": "abc123",
  "seoUrl": "xyz789",
  "seoKeywords": "abc123"
}
Types

Articles

Fields
Field Name Description
articles - [ArticleOutput]
Example
{"articles": [ArticleOutput]}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Brand

Fields
Field Name Description
brandId - Int
identifier - String!
brand - String!
translation - BrandTranslation
Example
{
  "brandId": 987,
  "identifier": "abc123",
  "brand": "xyz789",
  "translation": BrandTranslation
}
Types

BrandConnection

Description

A paginated list of Brand edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [BrandEdge!]! A list of Brand edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BrandEdge]
}
Types

BrandEdge

Description

An edge that contains a node of type Brand and a cursor.

Fields
Field Name Description
node - Brand! The Brand node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Brand,
  "cursor": "xyz789"
}
Types

BrandProductInput

Fields
Input Field Description
identifier - String!
brand - String!
sourceText - BrandSourceTextInput
Example
{
  "identifier": "abc123",
  "brand": "abc123",
  "sourceText": BrandSourceTextInput
}
Types

BrandSourceTextInput

Fields
Input Field Description
description - String
seoTitle - String
seoDescription - String
seoKeywords - String
Example
{
  "description": "xyz789",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoKeywords": "xyz789"
}
Types

BrandTranslation

Fields
Field Name Description
language - LanguageEnum
description - String
seoTitle - String
seoDescription - String
seoKeywords - String
Example
{
  "language": "cs_CZ",
  "description": "abc123",
  "seoTitle": "xyz789",
  "seoDescription": "abc123",
  "seoKeywords": "xyz789"
}
Types

Category

Fields
Field Name Description
categoryId - Int
identifier - String!
translation - CategoryTranslation
Example
{
  "categoryId": 987,
  "identifier": "xyz789",
  "translation": CategoryTranslation
}
Types

CategoryConnection

Description

A paginated list of Category edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [CategoryEdge!]! A list of Category edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CategoryEdge]
}
Types

CategoryEdge

Description

An edge that contains a node of type Category and a cursor.

Fields
Field Name Description
node - Category! The Category node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Category,
  "cursor": "abc123"
}
Types

CategoryProductInput

Fields
Input Field Description
identifier - String!
parentIdentifier - String
sourceText - CategorySourceTextInput!
Example
{
  "identifier": "xyz789",
  "parentIdentifier": "abc123",
  "sourceText": CategorySourceTextInput
}
Types

CategorySourceTextInput

Fields
Input Field Description
title - String!
description - String
description2 - String
seoTitle - String
seoDescription - String
seoKeywords - String
menuTitle - String
Example
{
  "title": "xyz789",
  "description": "abc123",
  "description2": "xyz789",
  "seoTitle": "abc123",
  "seoDescription": "abc123",
  "seoKeywords": "abc123",
  "menuTitle": "abc123"
}
Types

CategoryTranslation

Fields
Field Name Description
language - LanguageEnum
title - String!
description - String
description2 - String
seoTitle - String
seoDescription - String
seoKeywords - String
menuTitle - String
Example
{
  "language": "cs_CZ",
  "title": "abc123",
  "description": "abc123",
  "description2": "abc123",
  "seoTitle": "abc123",
  "seoDescription": "abc123",
  "seoKeywords": "abc123",
  "menuTitle": "xyz789"
}
Types

CurrencyEnum

Values
Enum Value Description

CZK

EUR

PLN

USD

HRK

HUF

GBP

RON

UAH

RUB

CAD

BGN
Example
"CZK"
Types

CustomData

Fields
Field Name Description
key - String!
value - String!
Example
{
  "key": "xyz789",
  "value": "abc123"
}
Types

CustomDataInput

Fields
Input Field Description
key - String!
value - String
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

ErrorOutput

Fields
Field Name Description
message - String!
code - Int
Example
{"message": "abc123", "code": 123}
Types

Float

Description

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

Example
123.45
Types

Image

Fields
Field Name Description
imageId - Int
url - String!
translation - ImageTranslation
Example
{
  "imageId": 123,
  "url": "xyz789",
  "translation": ImageTranslation
}
Types

ImageProductInput

Fields
Input Field Description
identifier - String!
src - String!
position - Int
sourceText - ImageSourceTextInput
Example
{
  "identifier": "xyz789",
  "src": "abc123",
  "position": 123,
  "sourceText": ImageSourceTextInput
}
Types

ImageSourceTextInput

Fields
Input Field Description
alt - String!
Example
{"alt": "xyz789"}
Types

ImageTranslation

Fields
Field Name Description
language - LanguageEnum
alt - String!
Example
{"language": "cs_CZ", "alt": "abc123"}
Types

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
987
Types

Language

Fields
Field Name Description
languageId - Int
icu - String!
Example
{"languageId": 987, "icu": "abc123"}
Types

LanguageEnum

Values
Enum Value Description

cs_CZ

sk_SK

pl_PL

en_GB

de_DE

hr_HR

hu_HU

fr_FR

it_IT

ro_RO

sl_SI

de_AT

uk_UA

lt_LT

en_US

ru_RU

es_ES

nl_NL

da_DK

bg_BG

pt_PT

el_GR

lv_LV

et_EE
Example
"cs_CZ"
Types

Option

Fields
Field Name Description
optionId - Int
variant - Int
type - String
identifier - String!
translation - OptionTranslation
values - [OptionValue!]
Example
{
  "optionId": 987,
  "variant": 123,
  "type": "xyz789",
  "identifier": "xyz789",
  "translation": OptionTranslation,
  "values": [OptionValue]
}
Types

OptionConnection

Description

A paginated list of Option edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [OptionEdge!]! A list of Option edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [OptionEdge]
}
Types

OptionEdge

Description

An edge that contains a node of type Option and a cursor.

Fields
Field Name Description
node - Option! The Option node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Option,
  "cursor": "xyz789"
}
Types

OptionProductInput

Fields
Input Field Description
identifier - String!
sourceText - OptionSourceTextInput!
values - [OptionValueInput!]!
Example
{
  "identifier": "xyz789",
  "sourceText": OptionSourceTextInput,
  "values": [OptionValueInput]
}
Types

OptionSourceTextInput

Fields
Input Field Description
name - String!
description - String
displayName - String
Example
{
  "name": "abc123",
  "description": "abc123",
  "displayName": "abc123"
}
Types

OptionTranslation

Fields
Field Name Description
language - LanguageEnum
name - String!
description - String
displayName - String
Example
{
  "language": "cs_CZ",
  "name": "abc123",
  "description": "abc123",
  "displayName": "abc123"
}
Types

OptionValue

Fields
Field Name Description
valueId - Int
identifier - String
translation - OptionValueTranslation
Example
{
  "valueId": 987,
  "identifier": "abc123",
  "translation": OptionValueTranslation
}
Types

OptionValueInput

Fields
Input Field Description
identifier - String!
sourceText - OptionValueSourceTextInput!
Example
{
  "identifier": "xyz789",
  "sourceText": OptionValueSourceTextInput
}
Types

OptionValueSourceTextInput

Fields
Input Field Description
name - String!
description - String
Example
{
  "name": "abc123",
  "description": "abc123"
}
Types

OptionValueTranslation

Fields
Field Name Description
language - LanguageEnum
name - String
description - String
Example
{
  "language": "cs_CZ",
  "name": "xyz789",
  "description": "abc123"
}
Types

PageInfo

Description

Information about pagination using a Relay style cursor connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String The cursor to continue paginating backwards.
endCursor - String The cursor to continue paginating forwards.
total - Int! Total number of nodes in the paginated connection.
count - Int! Number of nodes in the current page.
currentPage - Int! Index of the current page.
lastPage - Int! Index of the last available page.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123",
  "endCursor": "abc123",
  "total": 987,
  "count": 987,
  "currentPage": 987,
  "lastPage": 123
}
Types

Product

Fields
Field Name Description
productId - Int Unique LOCO product ID
status - ProductStatus Product status
identifier - String Unique client product ID
code - String Client product CODE
url - String Product source URL
imageId - Int Product default image ID
translation - ProductTranslation Product texts for translation
variants - [Variant!]!
categories - [Category!]!
reviews - [Review!]!
options - [Option!]!
tags - [Tag!]!
brands - [Brand!]!
images - [Image!]!
Example
{
  "productId": 123,
  "status": "TRANSLATION_WAITING",
  "identifier": "xyz789",
  "code": "abc123",
  "url": "abc123",
  "imageId": 123,
  "translation": ProductTranslation,
  "variants": [Variant],
  "categories": [Category],
  "reviews": [Review],
  "options": [Option],
  "tags": [Tag],
  "brands": [Brand],
  "images": [Image]
}
Types

ProductConnection

Description

A paginated list of Product edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [ProductEdge!]! A list of Product edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductEdge]
}
Types

ProductEdge

Description

An edge that contains a node of type Product and a cursor.

Fields
Field Name Description
node - Product! The Product node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Product,
  "cursor": "abc123"
}
Types

ProductInput

Fields
Input Field Description
identifier - String!
code - String
sourceUrl - String
imageIdentifier - String
sourceText - ProductSourceTextInput!
variants - [ProductVariantInput!]!
categories - [CategoryProductInput!]
reviews - [ReviewProductInput!]
options - [OptionProductInput!]
tags - [TagProductInput!]
brands - [BrandProductInput!]
images - [ImageProductInput!]
Example
{
  "identifier": "abc123",
  "code": "xyz789",
  "sourceUrl": "xyz789",
  "imageIdentifier": "abc123",
  "sourceText": ProductSourceTextInput,
  "variants": [ProductVariantInput],
  "categories": [CategoryProductInput],
  "reviews": [ReviewProductInput],
  "options": [OptionProductInput],
  "tags": [TagProductInput],
  "brands": [BrandProductInput],
  "images": [ImageProductInput]
}
Types

ProductOutput

Fields
Field Name Description
productId - Int
identifier - String
Example
{"productId": 123, "identifier": "xyz789"}
Types

ProductSourceTextInput

Fields
Input Field Description
title - String!
description - String
description2 - String
descriptionShort - String
seoTitle - String
seoDescription - String
seoUrl - String
Example
{
  "title": "xyz789",
  "description": "xyz789",
  "description2": "abc123",
  "descriptionShort": "abc123",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoUrl": "xyz789"
}
Types

ProductStatus

Values
Enum Value Description

TRANSLATION_WAITING

 Product is waiting for translation

TRANSLATION_ERROR

 The translation ended with an error

TRANSLATED

 The product is translated

EXPORT_WAITING

 The product is awaiting export

EXPORT_ERROR

 Product export error

EXPORTED

 The product is exported
Example
"TRANSLATION_WAITING"
Types

ProductTranslation

Fields
Field Name Description
language - LanguageEnum
title - String!
description - String
description2 - String
descriptionShort - String
seoTitle - String
seoDescription - String
seoUrl - String
Example
{
  "language": "cs_CZ",
  "title": "abc123",
  "description": "abc123",
  "description2": "abc123",
  "descriptionShort": "abc123",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoUrl": "abc123"
}
Types

ProductVariantInput

Fields
Input Field Description
identifier - String!
sku - String
ean - String
stock - Float
imageIdentifier - String
price - Float
currency - CurrencyEnum
sourceText - ProductVariantSourceTextInput
options - [OptionProductInput!]
Example
{
  "identifier": "xyz789",
  "sku": "abc123",
  "ean": "abc123",
  "stock": 987.65,
  "imageIdentifier": "xyz789",
  "price": 123.45,
  "currency": "CZK",
  "sourceText": ProductVariantSourceTextInput,
  "options": [OptionProductInput]
}
Types

ProductVariantSourceTextInput

Fields
Input Field Description
title - String!
description - String
description2 - String
descriptionShort - String
Example
{
  "title": "xyz789",
  "description": "xyz789",
  "description2": "xyz789",
  "descriptionShort": "abc123"
}
Types

Products

Fields
Field Name Description
products - [ProductOutput]
Example
{"products": [ProductOutput]}
Types

Review

Fields
Field Name Description
reviewId - Int
identifier - String!
translation - ReviewTranslation
Example
{
  "reviewId": 123,
  "identifier": "abc123",
  "translation": ReviewTranslation
}
Types

ReviewConnection

Description

A paginated list of Review edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [ReviewEdge!]! A list of Review edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ReviewEdge]
}
Types

ReviewEdge

Description

An edge that contains a node of type Review and a cursor.

Fields
Field Name Description
node - Review! The Review node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Review,
  "cursor": "abc123"
}
Types

ReviewInput

Fields
Input Field Description
identifier - String!
productIdentifier - String!
rating - Int
sourceText - ReviewSourceTextInput!
customData - [CustomDataInput!]
Example
{
  "identifier": "xyz789",
  "productIdentifier": "xyz789",
  "rating": 123,
  "sourceText": ReviewSourceTextInput,
  "customData": [CustomDataInput]
}
Types

ReviewOutput

Fields
Field Name Description
identifier - String
Example
{"identifier": "xyz789"}
Types

ReviewProductInput

Fields
Input Field Description
identifier - String!
rating - Int
sourceText - ReviewSourceTextInput!
customData - [CustomDataInput!]
Example
{
  "identifier": "xyz789",
  "rating": 123,
  "sourceText": ReviewSourceTextInput,
  "customData": [CustomDataInput]
}
Types

ReviewSourceTextInput

Fields
Input Field Description
title - String
description - String
reply - String
pros - String
cons - String
Example
{
  "title": "xyz789",
  "description": "abc123",
  "reply": "abc123",
  "pros": "xyz789",
  "cons": "abc123"
}
Types

ReviewTranslation

Fields
Field Name Description
language - LanguageEnum
title - String
description - String!
reply - String
pros - String
cons - String
Example
{
  "language": "cs_CZ",
  "title": "abc123",
  "description": "abc123",
  "reply": "abc123",
  "pros": "abc123",
  "cons": "abc123"
}
Types

Reviews

Fields
Field Name Description
reviews - [ReviewOutput]
errors - [ErrorOutput]
Example
{
  "reviews": [ReviewOutput],
  "errors": [ErrorOutput]
}
Types

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"
Types

Tag

Fields
Field Name Description
tagId - Int
identifier - String!
translation - TagTranslation
Example
{
  "tagId": 123,
  "identifier": "xyz789",
  "translation": TagTranslation
}
Types

TagConnection

Description

A paginated list of Tag edges.

Fields
Field Name Description
pageInfo - PageInfo! Pagination information about the list of edges.
edges - [TagEdge!]! A list of Tag edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [TagEdge]
}
Types

TagEdge

Description

An edge that contains a node of type Tag and a cursor.

Fields
Field Name Description
node - Tag! The Tag node.
cursor - String! A unique cursor that can be used for pagination.
Example
{
  "node": Tag,
  "cursor": "abc123"
}
Types

TagProductInput

Fields
Input Field Description
identifier - String!
sourceText - TagTranslationInput!
Example
{
  "identifier": "xyz789",
  "sourceText": TagTranslationInput
}
Types

TagTranslation

Fields
Field Name Description
language - LanguageEnum
name - String!
description - String
seoTitle - String
seoDescription - String
seoKeywords - String
Example
{
  "language": "cs_CZ",
  "name": "abc123",
  "description": "xyz789",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoKeywords": "abc123"
}
Types

TagTranslationInput

Fields
Input Field Description
name - String!
description - String
seoTitle - String
seoDescription - String
seoKeywords - String
Example
{
  "name": "xyz789",
  "description": "abc123",
  "seoTitle": "xyz789",
  "seoDescription": "abc123",
  "seoKeywords": "xyz789"
}
Types

Variant

Fields
Field Name Description
variantId - Int
identifier - String!
price - Float
currency - CurrencyEnum
sku - String
ean - String
stock - Float
imageId - Int
options - [Option!]!
translation - VariantTranslation
Example
{
  "variantId": 987,
  "identifier": "xyz789",
  "price": 987.65,
  "currency": "CZK",
  "sku": "xyz789",
  "ean": "xyz789",
  "stock": 123.45,
  "imageId": 123,
  "options": [Option],
  "translation": VariantTranslation
}
Types

VariantTranslation

Fields
Field Name Description
language - LanguageEnum
title - String!
description - String
description2 - String
descriptionShort - String
Example
{
  "language": "cs_CZ",
  "title": "xyz789",
  "description": "xyz789",
  "description2": "xyz789",
  "descriptionShort": "abc123"
}
Documentation by Anvil SpectaQL