» Support » Entwicklerdokumentation » Item API

Item API

With this import, all items that are for sale can be imported. Each item can be built according to your needs and can include several item identifications, item menus, prices etc. All necessary fields are available in the import, just as if the article would be created manually.

If you need more information about items, please have a look for the user documentation.

Endpoint

The endoint definition can be found in the common information.

The importconfigkey for the simple item import can be viewed in the management console under the item "System settings" - "Import/Export" - "Data exchange".

Body

The valid json looks like that:

[
{
"__id": "{{__id}}",
"__organizationalId": "-1",
"taxGroupID": "{{taxGroupID}}",
"unitlistprice": {{unitlistprice}},
"texts": {
"name": {
"i18nVariants": {
"de_DE": "{{name_de_de}}"
}
}
},
"image": [],
"discountFlag": {{discountFlag}},
"returnAble": {{returnAble}},
"manualPriceOverwriteAllowed": {{manualPriceOverwriteAllowed}},
"zeroPriceAllowed": {{zeroPriceAllowed}},
"manualPriceEntry": {{manualPriceEntry}},
"taxExemptProhibitedFlag": {{taxExemptProhibitedFlag}},
"mainPOSItemId": "{{mainPOSItemId}}",
"itemGroups": [
{
"itemGroup": "{{itemGroups}}"
}
],
"buttonGroups": ["{{buttonGroups}}"],
"itemCategory": "{{itemCategory}}"
}
]

Definition

Field

Type

Sample

Description

__id

NNNNN - string

"12345"

The internal, unique ID for the item.

__organizationalId

"Nli1bkf_0" or "-1"

The unique ID for the concerning organization. If there are multiple stores and the item is only available in specific store, you need the organizationalId for the appropiate store.

taxGroupID

"N" - string

"2"

1 - Item without tax

2 - Item with standard tax rate

3- Item with reduced tax rate

unitlistprice

NN.NN - numeric

39.99

The price of the item.

Important: It is necessary to use a point as seperator.

texts/name

"TEXT" - string

"Newspaper"

The name of the item.

image

"Nli1bkf_A0"

The internal id of the image.

discountFlag

True / False - boolean

True

Specifies whether an item is discountable or not.

returnAble

True / False - boolean

True

Specifies whether an item is returnable or not.

manualPriceOverwriteAllowed

True / False - boolean

True

Specifies whether an item price may be manually overwritten or not.

zeroPriceAllowed

True / False - boolean

True

Specifies whether an item may have a price of "0.00" or not.

manualPriceEntry

True / False - boolean

True

Specifies whether a window for manual price entry should be opened after scanning the item or not.

taxExemptProhibitedFlag

True / False - boolean

True

Specifies whether the item can be sold as tax free or not.

mainPOSItemId

"NNNNN" - string

"12345" or "ABC-123

The unique ID for the item, like a item or part number. This ID will be scanned at the POS.

itemGroup

"NNNN" - string

"12345" or "ABC-123"

Links this item to the selected item group.

buttonGroups

string

"12345"

The unique ID for the link to the assigned item groups

itemCategory

"DEFAULT", "GIFT_CARD", "VARIANT_MASTER", "VARIANTS_SUB", "SET", "OPTION"

"DEFAULT"

The category to which an item should be assigned. (e.g. default, set etc.)

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Item Import - DOWNLOAD

  • Postman Environment for Item Import - DOWNLOAD