Modify an existing Discount

put https://example.com/api/finance/v1/discounts/{id}

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

Discount

string

required

length ≤ 64

Unique identifier for this discount

name

string

required

length ≤ 64

Name of this discount

type

integer

Describes the type of discount

amountInPercent

integer

The percentage amount for this discount times 100, e.g 5000 equals 50%.
This is only effective if type equals 2.

amountInCents

integer

The discounted amount in smallest monetary unit (Cent/Rappen).
This is only effective if type equals 1.

enterDiscountOnPaying

boolean

If this is set, the amount can be set freely during the payment process.

externalPLU

string | null

An external PLU has no meaning within helloTESS! and can be used for your reference, e.g. matching external id's.

active

boolean

Is this discount active?

Responses

401

You are not unauthorized

404

Not Found

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://example.com/api/finance/v1/discounts/id?storeId=null' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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