Modify an existing Article

put https://example.com/api/basedata/v1/articles/{id}

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

Path Params

string

required

The id of the entity

Query Params

storeId

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

plu

string | null

PLU for this article

name

string

required

length ≤ 255

Article Name

description

string

length ≤ 65536

Article Description

type

integer

required

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

articleGroupId

string

required

length ≤ 65536

The id of the article group the article is associated with

price

int32

required

Gross price in smallest monetary unit (Cents/Rappen)

externalPLU

string

length ≤ 64

External PLU (id) field

priceSecondary

int32

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

priceTakeaway

int32

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

taxInhouse

int32

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

taxTakeaway

int32

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

inheritTaxrate

boolean

Defaults to false

Inherit Tax rates from articleGroup

inheritColors

boolean

Defaults to false

Inherit colors from Article Group

colorForeground

string

length between 6 and 6

HEX color code (6 digits)

colorBackground

string

length between 6 and 6

HEX color code (6 digits)

colorBorder

string

length between 6 and 6

HEX color code (6 digits)

allergyInfo

string

Allergy information about this product

fatContentPoints

string

Defaults to 0

Fat content of the Product

barcode

string | null

Barcode of this product

netProductionCosts

int32

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

netProductionCostsPerWeight

int32

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

active

boolean

Defaults to true

Show article group on default layer

deleted

boolean

Defaults to false

Is this article deleted?

Responses

401

You are not unauthorized

404

Not Found

Language

Credentials

Header


xxxxxxxxxx
14
1
curl --request PUT \
2
     --url 'https://example.com/api/basedata/v1/articles/id?storeId=null' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "0: Main Article",
8
  "inheritTaxrate": false,
9
  "inheritColors": false,
10
  "fatContentPoints": 0,
11
  "active": true,
12
  "deleted": false
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Modified

400The response in case of a bad request