API Reference

Modify an existing Article

put
https://example.com/api/basedata/v1/articles/

When modifing an existing Article, the id field must be given as a path parameter but discarded in the body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the entity

Query Params
string
Defaults to null

Use the store level properties if any exist otherwise the global properties are used

Body Params

Article

string
required
length ≤ 64

Globally unique Article id

string | null

PLU for this article

string
required
length ≤ 255

Article Name

string
length ≤ 65536

Article Description

integer
enum
required

The article might be used in different workflows based on the article type.

Allowed:
string
required
length ≤ 65536

The id of the article group the article is associated with

int32
required

Gross price in smallest monetary unit (Cents/Rappen)

string
length ≤ 64

External PLU (id) field

int32

Gross secondary price in smallest monetary unit (Cents/Rappen), like promotions etc.

int32

Gross takeaway price in smallest monetary unit (Cents/Rappen)

int32

Default inhouse tax rate times 100 (1900 equals 19%)

int32

Default Takeaway tax rate times 100 (700 equals 7%)

boolean
Defaults to false

Inherit Tax rates from articleGroup

boolean
Defaults to false

Inherit colors from Article Group

string
length between 6 and 6

HEX color code (6 digits)

string
length between 6 and 6

HEX color code (6 digits)

string
length between 6 and 6

HEX color code (6 digits)

string

Allergy information about this product

string
Defaults to 0

Fat content of the Product

string | null

Barcode of this product

int32

Calculatory production cost to get calculate marginal return. Smallest monetary unit (Cent/Rappen)

int32

Calculatory production cost to get calculate marginal return on weighted articles. Smallest monetary unit (Cent/Rappen)

boolean
Defaults to true

Show article group on default layer

boolean
Defaults to false

Is this article deleted?

Responses

401

You are not unauthorized

404

Not Found

Updated almost 3 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 3 years ago