Referenced Schema Types
LIST
name | STRING | REQUIRED |
|
value | REPEATED |
|
LOCALIZED
language | STRING | REQUIRED |
|
value | STRING/ | REQUIRED |
|
MAP
type | STRING | NULLABLE |
|
name | STRING | REQUIRED |
|
values | STRING/ | REPEATED |
|
VISIBILITY
customer_groups | STRING | REPEATED |
|
values | RECORD | REPEATED |
|
values. language | STRING | REQUIRED |
|
values. value | INTEGER | REQUIRED |
|
STATUS
language | STRING | REQUIRED |
|
value | INTEGER | REQUIRED |
|
PERIOD
LABEL
type | STRING | REQUIRED |
|
name | STRING | REQUIRED |
|
value | STRING | REQUIRED |
|
loc_values | REPEATED |
|
TAG
type | STRING | REQUIRED |
|
value | STRING | REQUIRED |
|
loc_values | REPEATED |
|
PRICING
PRICE
customer_groups | STRING | REPEATED |
|
periods | REPEATED |
| |
list_price | RECORD | REPEATED | price before any discount |
list_price. language | STRING | REQUIRED |
|
list_price. value | STRING | REQUIRED |
|
list_price. currency | STRING | REQUIRED |
|
list_price. region | STRING | REQUIRED |
|
sales_price | RECORD | REPEATED | price displayed to the customer after discounts |
sales_price. language | STRING | REQUIRED |
|
sales_price. value | STRING | REQUIRED |
|
sales_price. currency | STRING | REQUIRED |
|
sales_price. region | STRING | REQUIRED |
|
gross_margin | RECORD | REPEATED | the sales gross margin as an absolute value |
gross_margin. language | STRING | REQUIRED |
|
gross_margin. value | STRING | REQUIRED |
|
gross_margin. currency | STRING | REQUIRED |
|
gross_margin. region | STRING | REQUIRED |
|
other_prices | RECORD | REPEATED | other sales price numbers |
other_prices. type | STRING | REQUIRED |
|
other_prices. language | STRING | REQUIRED |
|
other_prices. value | STRING | REQUIRED |
|
other_prices. currency | STRING | REQUIRED |
|
other_prices. region | STRING | REQUIRED |
|
PRODUCT
type | STRING | NULLABLE |
|
name | STRING | NULLABLE |
|
product_line | STRING | NULLABLE |
|
product_group | STRING | NULLABLE |
|
sku | STRING | NULLABLE |
|
value | NUMERIC | NULLABLE |
|
CONTENT
type | STRING | NULLABLE |
|
name | STRING | NULLABLE |
|
content_type | STRING | NULLABLE |
|
content_id | STRING | NULLABLE |
|
value | NUMERIC | NULLABLE |
|
CUSTOMER
type | STRING | NULLABLE |
|
name | STRING | NULLABLE |
|
persona_id | STRING | NULLABLE |
|
customer_id | STRING | NULLABLE |
|
value | NUMERIC | NULLABLE |
|
CONTACT
type | STRING | NULLABLE | the type of contact |
persona_id | STRING | REQUIRED | the persona_id as referenced in other tables |
persona_type | STRING | NULLABLE | the type of persona (user, guest, ...) |
internal_id | STRING | NULLABLE | an additional internal id (optional) |
external_id | STRING | NULLABLE | the external identifier of the user (can be the same as the internal identifier) |
title | STRING | NULLABLE |
|
prefix | STRING | NULLABLE | Salutation, supported values (other values will be considered as OTHER):
|
firstname | STRING | NULLABLE |
|
middlename | STRING | NULLABLE |
|
lastname | STRING | NULLABLE |
|
suffix | STRING | NULLABLE |
|
gender | STRING | NULLABLE |
|
date_of_birth | DATETIME | NULLABLE |
|
account_creation | DATETIME | NULLABLE |
|
creation_label | STRING | NULLABLE |
|
auto_group | STRING | NULLABLE |
|
invoice_status | STRING | NULLABLE |
|
status | STRING | NULLABLE |
|
spouse_id | STRING | NULLABLE |
|
children_ids | STRING | REPEATED |
|
customer_groups | STRING | REPEATED |
|
stores | STRING | REPEATED | the stores |
websites | STRING | REPEATED | the stores |
company | STRING | NULLABLE |
|
vat | STRING | NULLABLE |
|
vat_is_valid | BOOLEAN | NULLABLE |
|
vat_request_id | STRING | NULLABLE |
|
vat_request_date | DATETIME | NULLABLE |
|
vat_request_success | BOOLEAN | NULLABLE |
|
street | STRING | NULLABLE |
|
additional_address_line | STRING | NULLABLE |
|
city | STRING | NULLABLE |
|
zipcode | STRING | NULLABLE |
|
stateID | STRING | NULLABLE |
|
department | STRING | NULLABLE |
|
statename | STRING | NULLABLE |
|
countryiso | STRING | NULLABLE |
|
countryID | STRING | NULLABLE | country identifier, can be one of possible values (others wil be considered as OTHER):
|
phone | STRING | NULLABLE |
|
STRING | NULLABLE |
| |
mobile_phone | STRING | NULLABLE |
|
fax | STRING | NULLABLE |
|
giftregistry_item_id | STRING | NULLABLE |
|
string_attributes | REPEATED | additional string (not localized) attributes of the product line | |
localized_string_attributes | REPEATED | additional localized string attributes | |
numeric_attributes | REPEATED | additional numeric (not localized) attributes | |
localized_numeric_attributes | REPEATED | additional localized numeric attributes | |
datetime_attributes | REPEATED | additional datetime (not localized) attributes | |
localized_datetime_attributes | REPEATED | additional localized datetime attributes | |
subscriptions | REPEATED | the state of the subscriptions (e-mails and others) | |
notifications | REPEATED | the state of the notofications (e-mails and others) | |
voucher_states | REPEATED | the state of the vouchers (used and others) |
STATE
type | STRING | NULLABLE |
|
name | STRING | REQUIRED |
|
status | INTEGER | REQUIRED |
|
periods | REPEATED |
|
COMMENT
created | DATETIME | NULLABLE |
|
persona_type | STRING | NULLABLE |
|
persona_id | STRING | NULLABLE |
|
comment | STRING | NULLABLE |
|
STOCK
The naming of the generated product properties for stock:
if only one entry with available not set or set to the label "available": property_name = "stock"
if the delivery center is defined, then "stock_[DELIVERY_CENTER]"
if availability is defined with something else than "stock", then "stock_[AVAILABILITY]"
if both availability and delivery center are defined then: "stock_[AVAILABILITY]_[DELIVERY_CENTER]"
availability | STRING | NULLABLE | default is null or “available” |
delivery_center | STRING | NULLABLE | default is null, delivery center is only used when defined |
value | INTEGER | NULLABLE | the stock amount |
COMMUNICATION_CONTENT
id | STRING | NULLABLE | the unique id of the content as provided in doc_content |
type | STRING | NULLABLE | the type of content as provided in doc_content: 'blog', 'magazin', 'page', ... |
language | STRING | NULLABLE | the language of the communication |
title | STRING | NULLABLE | the title of the content |
short_description | STRING | NULLABLE | the short description of the content |
description | STRING | NULLABLE | the description of the content |
parent_content_ids | STRING | REPEATED | the parent contents related to this content (e.g.: rating of themost helpful customer review / comments) |
products | REPEATED | connections to products | |
contents | REPEATED | relations to other contents | |
topics | REPEATED | the topics of the content | |
brands | REPEATED | the brands of the content | |
suppliers | REPEATED | the suppliers of the content | |
categories | REPEATED | the categories of the content | |
images | REPEATED | the images of the content | |
link | REPEATED | the link of the content | |
tags | REPEATED | the tags of the product line, e.g.: [STRUCT('tag', 'hello world', [STRUCT('de', 'hello world')])] | |
labels | REPEATED | the labels of the content, e.g.: [STRUCT('symbol', 'helpful', 'very', [STRUCT('de', 'sehr hilfreich')])] | |
widgets | REPEATED | widgets of the api request | |
filters | REPEATED | filters of the api request | |
context_parameters | REPEATED | parameters of the api request | |
string_attributes | REPEATED | additional string (not localized) attributes of the content | |
localized_string_attributes | REPEATED | additional localized string attributes of the content | |
numeric_attributes | REPEATED | additional numeric (not localized) attributes of the content | |
localized_numeric_attributes | REPEATED | additional localized numeric attributes of the content | |
datetime_attributes | REPEATED | additional datetime (not localized) attributes of the content | |
localized_datetime_attributes | REPEATED | additional localized datetime attributes of the content |
THREAD_CONDITION
condition_id | STRING | NULLABLE | the unique id of the condition |
type | STRING | NULLABLE |
|
source | STRING | NULLABLE |
|
name | STRING | NULLABLE |
|
operator | STRING | NULLABLE |
|
values | STRING | REPEATED |
|
any_value | BOOLEAN | NULLABLE |
|
filters | THREAD_CONDITION (without filter parameter) | REPEATED |
|
filters_or | BOOLEAN | NULLABLE | are the filter conditions and or or to be true |
string_attributes | REPEATED | additional string (not localized) attributes of the content | |
localized_string_attributes | REPEATED | additional localized string attributes of the content | |
numeric_attributes | REPEATED | additional numeric (not localized) attributes of the content | |
localized_numeric_attributes | REPEATED | additional localized numeric attributes of the content | |
datetime_attributes | REPEATED | additional datetime (not localized) attributes of the content | |
localized_datetime_attributes | REPEATED | additional localized datetime attributes of the content |
NARRATIVE_REQUEST
sessionId | STRING | NULLABLE | indicates if a specific sessionId must be provided, typically it is not indicated and you should set it with the value of the cems cookie if you have one |
profileId | STRING | NULLABLE | indicates if a specific profileId must be provided, typically it is not indicated and you should set it with the value of the cemv cookie if you have one |
customerId | STRING | NULLABLE | indicates if a specific customerId must be provided, typically it is not indicated and you should use the user account persona_id |
widget | STRING | NULLABLE | indicates the name of your configured widget |
language | STRING | NULLABLE | the language |
hitCount | INTEGER | NULLABLE | the number of hit to be returned per page |
offset | INTEGER | NULLABLE | the offset to be requested, by default 0 |
groupBy | STRING | NULLABLE | the group by field, by default 'products_group_id' |
returnFields | STRING | REPEATED | The list of fields that should be returned for each bx-hit in the response |
filters | RECORD | REPEATED | The list of filters to apply in the request |
filters.field | STRING | NULLABLE |
|
filters.negative | BOOLEAN | NULLABLE |
|
filters.values | STRING | REPEATED |
|
filters.from | FLOAT | NULLABLE |
|
filters.to | FLOAT | NULLABLE |
|
filters.fromInclusive | BOOLEAN | NULLABLE |
|
filters.toInclusive | BOOLEAN | NULLABLE |
|
facets | RECORD | REPEATED | The list of facets to apply in the request |
facets.field | STRING | NULLABLE |
|
facets.values | STRING | REPEATED |
|
facets.valueKey | STRING | NULLABLE |
|
facets.numerical | BOOLEAN | NULLABLE |
|
facets.range | BOOLEAN | NULLABLE |
|
facets.boundsOnly | BOOLEAN | NULLABLE |
|
facets.from | FLOAT | NULLABLE |
|
facets.to | FLOAT | NULLABLE |
|
sort | RECORD | REPEATED | The list of sorts to apply in the request |
sort.field | STRING | NULLABLE |
|
sort.reverse | BOOLEAN | NULLABLE |
|
items | RECORD | REPEATED | The list of items to apply in the request |
items.field | STRING | NULLABLE |
|
items.values | STRING | REPEATED |
|
items.role | STRING | NULLABLE |
|
orFilters | BOOLEAN | NULLABLE | if the filters should be applied as and or as or |
parameters | RECORD | REPEATED | be careful, when making the request you should not set [ { ] |
parameters.values | STRING | NULLABLE |
|
parameters.values | STRING | REPEATED |
|
string_attributes | REPEATED | additional string (not localized) attributes of the content | |
localized_string_attributes | REPEATED | additional localized string attributes of the content | |
numeric_attributes | REPEATED | additional numeric (not localized) attributes of the content | |
localized_numeric_attributes | REPEATED | additional localized numeric attributes of the content | |
datetime_attributes | REPEATED | additional datetime (not localized) attributes of the content | |
localized_datetime_attributes | REPEATED | additional localized datetime attributes of the content |