Skip to content
Komplett LogoKomplett Platform

Get allowed actions

GET
/v1/{orderId}/allowed-actions
curl --request GET \
  --url https://example.com/orders/v1/example/allowed-actions

Returns which state-changing operations are currently permitted on an order. The result is a point-in-time snapshot: the action itself can still be rejected with 422 if the order progresses in the meantime.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orderId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canBeCancelled
required
boolean
Examplegenerated
{
  "canBeCancelled": true
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}