Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

planId
string
required

The plan id, e.g. plan-restock-aigle-32.

Minimum string length: 1

Body

application/json
expectedVersion
integer
required
Required range: 0 < x <= 9007199254740991
to
enum<string>
required
Available options:
DRAFT,
VALIDATED,
SENT,
RECEIVED,
PROPOSED,
AGREED,
IN_TRANSIT,
SETTLED,
CREDITED,
CLOSED,
CANCELLED

Response

The plan in its new status, at its new version.

The plan in its new status, at its new version.

id
string
required
Minimum string length: 1
reference
string
required
Required string length: 1 - 64
name
string
required
Required string length: 1 - 255
notes
string | null
required
Maximum string length: 10000
status
enum<string>
required
Available options:
DRAFT,
VALIDATED,
SENT,
RECEIVED,
PROPOSED,
AGREED,
IN_TRANSIT,
SETTLED,
CREDITED,
CLOSED,
CANCELLED
ruleGroupId
string | null
required
Minimum string length: 1
deadline
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
issuedDocument
object | null
required
version
integer
required
Required range: 0 < x <= 9007199254740991
family
enum<string>
required
Available options:
restock,
pre_season_order,
supplier_return,
supplier_exchange
supplierId
string
required
Minimum string length: 1
storeId
string | null
required
Minimum string length: 1