Dev Docs

Dev Docs
Back to support
Back to support

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 importconfigkey for the simple item import defaultimportstockV1.

Body

The valid json looks like that:

[

    {

        "__id": "Nlb4rq0_9::||::578",

        "__organizationalId": "Nlb4rq0_9",

        "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



__id

Type: ID

Sample: "Nlb4rq0_9::||::578"

Description: The unique, internal id of the org-structure combined with the unique, internal id of the corresponding item.

__organizationalId

Type: ID

Sample: "Nlb4rq0_9"

Description: The unique, internal id of the org-structure, typically the same ID as the storeID.

itemId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The internal, unique ID for the corresponding item.

mainPOSItemId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

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

name

Type: "TEXT" - string

Sample: "Newspaper"

Description: The name of the corresponding item.

uom

Type: -

Sample: "PCE"

Description: The unit of measurement.

storeId

Type: -

Sample: "N|1234"

Description: The unique, internal id of the regarding store.

store

Type: "NNNN" - string

Sample: "1001"

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

stockLowLimit

Type: "NNN" - string

Sample: "10"

Description: The minimum stock of the corresponding item.

available

Type: "NNN" - string

Sample: "10"

Description: The available stock of the corresponding item.

reserved

Type: "NNN" - string

Sample: "10"

Description: The reserved stock of the corresponding item.

inTransferIncoming

Type: "NNN" - string

Sample: "10"

Description: The incoming stock of the corresponding item.

inTransferOutgoing

Type: "NNN" - string

Sample: "10"

Description: The ordered stock of the corresponding item.

ordered

Type: "NNN" - string

Sample: "10"

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