» Support » Entwicklerdokumentation » Stock API

Stock API

In order to have the current item stocks constantly in view or to enter new stocks for deliveries, the interface offers a direct possibility to import the stocks of individual items or of the entire inventory.

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 <link>.

The importconfigkey for the simple item import yynurhgmszkytnwh

Body

The valid json looks like that:

[
{
"itemId": "{{itemId}}",
"mainPOSItemId": "{{mainPOSItemId}}",
"name": {
"i18nVariants": {
"de_DE": "{{name_de_de}}"
}
},
"uom": "{{uom}}",
"storeId": "{{storeId}}",
"store": "{{store}}",
"stockLowLimit": "{{stockLowLimit}}",
"available": "{{available}}",
"reserved": "{{reserved}}",
"inTransferIncoming": "{{inTransferIncoming}}",
"inTransferOutgoing": "{{inTransferOutgoing}}",
"ordered": "{{ordered}}"
}
]

Definition

Field

Type

Sample

Description

itemId

"NNNNN" - string

"12345" or "ABC-123"

The internal, unique ID for the corresponding item.

mainPOSItemId

"NNNNN" - string

"12345" or "ABC-123"

The unique ID for the item, like a item or part number.

name

"TEXT" - string

"Newspaper"

The name of the corresponding item.

uom

"PCE"

The unit of measurement.

storeId

"N|1234"

The unique, internal id of the regarding store.

store

"NNNN" - string

"1001"

The unique id of the regarding store, which is visible in the management console.

stockLowLimit

"NNN" - string

"10"

The minimum stock of the corresponding item.

available

"NNN" - string

"10"

The available stock of the corresponding item.

reserved

"NNN" - string

"10"

The reserved stock of the corresponding item.

inTransferIncoming

"NNN" - string

"10"

The incoming stock of the corresponding item.

inTransferOutgoing

"NNN" - string

"10"

The outgoing stock of the corresponding item.

ordered

"NNN" - string

"10"

The ordered stock of the corresponding item.

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Stock Import - DOWNLOAD

  • Postman Environment for Stock Import - DOWNLOAD