API Reference

Modify an existing Promotion

put
https://example.com/api/finance/v1/promotions/

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

Promotion

string

The id of the promotions

string

The name of the promotions

number

The start time when the promotion is applied

number

The end time when the promotion is applied

string
enum
Defaults to 2

Which article price to use

Allowed:
boolean

Is this promotion active

boolean

Apply this promotion Monday

boolean

Apply this promotion Tuesday

boolean

Apply this promotion Wednesday

boolean

Apply this promotion Thursday

boolean

Apply this promotion Friday

boolean

Apply this promotion Saturday

boolean

Apply this promotion Sunday

string

Discount to apply with this promotion

string

User Group to apply with this promotion

boolean
Defaults to false

Apply TOGO when using this promotion

boolean
Defaults to false

Apply the discount at the article level, not invoice level

articleGroupIds
array of strings

Article groups for which this promotion is applied

articleGroupIds
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