Dev Docs

Deposit Items

Endpoint

The endoint definition can be found in the common information.

The importconfigkey for the simple item import is defaultimportitemsV2.

Body

The valid json looks like that for a deposit item:

[
{
"__id": "{{__id}}",
"__organizationalId": "{{__organizationalId}}",
"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}}",
"itemCategory": "{{itemCategory}}"
}
]


Definition

Field



__id

Type: NNNNN - string

Sample: "12345"

Description: The internal, unique ID for the item. Should be the same as the MainPosItemID

__organizationalId

Type:-

Sample: "Nli1bkf_0" or "-1"

Description: 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

Type: "N" - string

Sample: "2"

Description: 1 - Item without tax

2 - Item with standard tax rate

3- Item with reduced tax rate

unitlistprice

Type: NN.NN - numeric

Sample: 39.99

Description: The price of the item. Important: It is necessary to use a point as seperator.

texts/name

Type: "TEXT" - string

Sample: "Newspaper"

Description: The name of the item.

image

Type: -

Sample: "Nli1bkf_A0"

Description: The internal id of the image.

discountFlag

Type: True / False - boolean

Sample: True

Description: Specifies whether an item is discountable or not.

returnAble

Type: True / False - boolean

Sample: True

Description: Specifies whether an item is returnable or not.

manualPriceOverwriteAllowed

Type: True / False - boolean

Sample: True

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

zeroPriceAllowed

Type: True / False - boolean

Sample: True

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

manualPriceEntry

Type: True / False - boolean

Sample: True

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

taxExemptProhibitedFlag

Type: True / False - boolean

Sample: True

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

mainPOSItemId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123

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

itemGroup

Type: "NNNN" - string

Sample: "12345" or "ABC-123"

Description: Links this item to the selected item group.

buttonGroups

Type: string

Sample: "12345"

Description: The unique ID for the link to the assigned item groups

itemCategory

Type: "DEFAULT", "GIFTCARD", "VARIANTMASTER", "VARIANTSSUB", "SET", "OPTION"

Sample: "DEPOSIT"

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



Item w/ linked deposit

Endpoint

The endoint definition can be found in the common information.

The importconfigkey for the simple item import is defaultimportitemsV2.

Body

The valid json looks like that for a item w/ linked deposit:

[
{
"__id": "{{__id}}",
"__organizationalId": "{{__organizationalId}}",
"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}}",
"itemCategory": "{{itemCategory}}",
"depositRelations": [
{
"relation": "{{deposit}}",
"assemblyPerCount": {{deposit_qty}}
}
]
}
]


Definition

Field



__id

Type: NNNNN - string

Sample: "12345"

Description: The internal, unique ID for the item. Should be the same as the MainPosItemID

__organizationalId

Type:-

Sample: "Nli1bkf_0" or "-1"

Description: 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

Type: "N" - string

Sample: "2"

Description: 1 - Item without tax

2 - Item with standard tax rate

3- Item with reduced tax rate

unitlistprice

Type: NN.NN - numeric

Sample: 39.99

Description: The price of the item. Important: It is necessary to use a point as seperator.

texts/name

Type: "TEXT" - string

Sample: "Newspaper"

Description: The name of the item.

image

Type: -

Sample: "Nli1bkf_A0"

Description: The internal id of the image.

discountFlag

Type: True / False - boolean

Sample: True

Description: Specifies whether an item is discountable or not.

returnAble

Type: True / False - boolean

Sample: True

Description: Specifies whether an item is returnable or not.

manualPriceOverwriteAllowed

Type: True / False - boolean

Sample: True

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

zeroPriceAllowed

Type: True / False - boolean

Sample: True

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

manualPriceEntry

Type: True / False - boolean

Sample: True

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

taxExemptProhibitedFlag

Type: True / False - boolean

Sample: True

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

mainPOSItemId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123

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

itemGroup

Type: "NNNN" - string

Sample: "12345" or "ABC-123"

Description: Links this item to the selected item group.

buttonGroups

Type: string

Sample: "12345"

Description: The unique ID for the link to the assigned item groups

itemCategory

Type: "DEFAULT", "GIFTCARD", "VARIANTMASTER", "VARIANTSSUB", "SET", "OPTION"

Sample: "DEPOSIT"

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

depositRelations_relation

Type: string

Sample: "12345"

Description: The unique ID of the deposit item which has to be linked to the default item.

depositRelations_qty

Type: number

Sample: "1"

Description: In what quantity should the default item contain the deposit item?



Example case

The Postman project below contains all the necessary files to illustrate an example use-case.

Download postman project "Deposit case"

  1. Import all the existing .json files into postman.

  2. Enter the following data in the included environments:

    - baseURL

    - username

    - password

    Leave all other entries unchanged.

  3. Open the imported "ITEM API | Deposit"-Collection in the postman app.

  4. On the top right corner, assign the imported "ITEM API | Deposit"-Environment to the opened collection.

  5. Click the "Send"-Button to send the post to your management console.

  6. Open the imported "ITEM API | Item w/ linked deposit"-Collection in the postman app.

  7. On the top right corner, assign the imported "ITEM API | Item w/ linked deposit"-Environment to the opened collection.

  8. Click the "Send"-Button to send the post to your management console.



Result: The two items should now appear in your management console. Furthermore, in the detail/edit view you should be able to see that the item w/ linked deposit includes a deposit of 0.25€.