API docs by Redocly

Article-Api (1.0.0-oas3)

Download OpenAPI specification:

E-mail: api@oktopos.com

The OktoPOS Manager ArticleAPI provides a way to manage articles for the OktoPOS Manager from third party applications.

Authentication

All functions in this API require a valid authentication token. You can find this token in your instance of OktoPOS Manager in OktoPOS -> System.

articles

add article

Authorizations:
api_key
Request Body schema: application/json
required
id
integer

The internal identifier of this article.

externalReferenceNumber
required
string

A unique value from the source system. Can be used to identify the article in later imports.

description
required
string [ 1 .. 200 ] characters

The name of the article. Needs to be unique.

required
Array of objects (ArticlePrice) non-empty

A list of prices for different distribution channels. Valid for all divisions in the target system.

cashierCanChangePrice
boolean
Default: false

The cashier at the POS is allowed to change the price of this article directly in cart.

required
object (Unit)

A unit of measurement used to identify article quantities

object (ArticleGroup)

A simple group value. Can be assigned to an article.

materialNumber
string [ 0 .. 200 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "externalReferenceNumber": "string",
  • "description": "string",
  • "price": [
    ],
  • "cashierCanChangePrice": false,
  • "unit": {
    },
  • "group": {
    },
  • "materialNumber": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

optionally filtered list of articles

Authorizations:
api_key
Request Body schema: application/json
page
integer
Default: 1
pageSize
integer <= 500
Default: 50
object

optional filter params for article list

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "pageSize": 50,
  • "filter": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

search for an article with prices of a specific division

Authorizations:
api_key
path Parameters
externalIdentifier
required
string
division
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search for an article

Authorizations:
api_key
path Parameters
externalIdentifier
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

list distribution-channels

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

list units

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add barcodes

Authorizations:
api_key
Request Body schema: application/json
required
externalReferenceNumber
required
string

A unique value from the source system. Can be used to identify the barcode.

forceReuse
boolean
required
Array of objects (Barcode) non-empty

Responses

Request samples

Content type
application/json
{
  • "externalReferenceNumber": "string",
  • "forceReuse": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

delete barcodes from article

Request Body schema: application/json
required
externalReferenceNumber
required
string

A unique value from the source system. Can be used to identify the barcode.

required
Array of objects (Barcode) non-empty

Responses

Request samples

Content type
application/json
{
  • "externalReferenceNumber": "string",
  • "barcodes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

change all division prices

Authorizations:
api_key
Request Body schema: application/json
required
externalReferenceNumber
required
string

A unique value from the source system. Can be used to identify the price.

required
Array of objects (ArticlePrice) non-empty

Responses

Request samples

Content type
application/json
{
  • "externalReferenceNumber": "string",
  • "price": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

get an translated unit by identifier

Authorizations:
api_key
path Parameters
identifier
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a translated distribution channel by identifier

Authorizations:
api_key
path Parameters
identifier
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get an translated allergen by identifier

Authorizations:
api_key
path Parameters
identifier
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a translated nutrition fact type by identifier

Authorizations:
api_key
path Parameters
identifier
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get all functional articles for a division

available from OktoPOS Manager version 3.80

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "messages": [
    ],
  • "success": true,
  • "timestamp": 0,
  • "total": 0,
  • "version": "string"
}