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.

Body

application/json
id
string
required
Minimum string length: 1
skuId
string
required
Pattern: ^[0-9a-f]{64}$
customerId
string
required
Minimum string length: 1
storeId
string
required
Minimum string length: 1
startAt
string<date-time>
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
days
required
Available options:
1
ratePerDayCents
integer
required
Required range: 0 < x <= 9007199254740991
depositAmountCents
integer
required
Required range: 0 < x <= 9007199254740991
depositReference
string
required
Minimum string length: 1

Response

The opened rental: active, dueAt derived from startAt + days, no settlement yet, attributed to the calling actor.

The opened rental: active, dueAt derived from startAt + days, no settlement yet, attributed to the calling actor.

id
string
required
skuId
string
required
customerId
string
required
storeId
string
required
period
object
required
days
required
Available options:
1
ratePerDayCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
depositAmountCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
depositReference
string
required
status
enum<string>
required
Available options:
active,
returned,
overdue
actorId
string
required
rentedAt
string
required
settlement
object