Modify an existing ArticleGroup

put https://example.com/api/basedata/v1/article-groups/{id}

When modifing an existing ArticleGroup, 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

ArticleGroup

string

required

length ≤ 64

Unique Identifier , must be unique in the system

mainArticleGroup

integer

required

Main article group

name

string

required

length ≤ 255

Article group name

externalId

string

length ≤ 255

Human readable article group id

taxInhouse

int32

Default inhouse tax rate times 100 (1900 equals 19%) for articles in this group

taxTakeaway

int32

Default inhouse tax rate times 100 (700 equals 7%) for artilces in this 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)

pluStart

integer

Start PLU numbers (for autogenerated PLU's)

pluEnd

integer

End PLU numbers (for autogenerated PLU's)

topArticleGroupId

string

A custom top article group like AFG

externalPLU

string

External ID to be used in third party systems

active

boolean

required

Show article group on default layer

deleted

boolean

Is this article group deleted?

Responses

401

You are not unauthorized

404

Not Found

Language

Credentials

Header


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url 'https://example.com/api/basedata/v1/article-groups/id?storeId=null' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "mainArticleGroup": "0: Food",
8
  "active": true
9
}
10
'

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