Skip to main content
PATCH
/
v1
/
items
/
{itemId}
/
specialprices
Update Item Special Price
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v1/items/{itemId}/specialprices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "IsActive": true,
  "SpecialPrice": [
    {
      "IsActive": true,
      "CustomerGroupId": 123,
      "NetPrice": 123,
      "SalesChannelId": "<string>"
    }
  ],
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDateActive": true,
  "EndDate": "2023-11-07T05:31:56Z",
  "TillAmountActive": true,
  "TillAmountInStockSmallerThan": 123
}
'
{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
itemId
integer<int32>
required

The id of the item that the special price belongs to.

Body

application/json

The special price details of the item to update.

Model Class: UpdateItemSpecialPrice

​
IsActive
boolean
required

Indicates if the special price is active.

​
SpecialPrice
object[]

List of all special prices for JTL-Wawi and the sales channel with the type online shop and JTL-POS.

​
StartDate
string<date-time>

The date when the special price should start.

​
EndDateActive
boolean

If set, the special price will end on a given date. In this case, the field EndDate is required.

​
EndDate
string<date-time>

This is required if EndDateActive is set. In this case, the special price ends on this date.

​
TillAmountActive
boolean

Indicates that the special price ends when a certain amount is reached. The field TillAmountInStockSmallerThan is required in this case.

​
TillAmountInStockSmallerThan
integer<int32>

If this amount of stock for the item is reached, the special price ends. Only applies if TillAmountActive is true.

Response