robotics_v1_serving_task_claim

POST

/api/robotics/v1/serving-tasks/{task_id}/claim/

curl --request POST \
  --url https://example.com/api/robotics/v1/serving-tasks/1/claim/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "client_idempotency_key": "" }'

• The Sitora installation serving this document

First claim wins. Idempotent via the Idempotency-Key header.

Authorizations

• robotCredential

Parameters

Path Parameters

task_id

required

integer

Request Body

object

client_idempotency_key

string

"" <= 128 characters

object

client_idempotency_key

string

"" <= 128 characters

object

client_idempotency_key

string

"" <= 128 characters

Responses

200

Media typeapplication/json

object

id

required

integer

display_number

required

integer format: int64

<= 9223372036854776000

leg

required

• dine_in_tray - Dine-in tray run
• delivery_courier - Delivery courier leg

string

Allowed values: dine_in_tray delivery_courier

status

• offered - Offered
• claimed - Claimed
• loaded - Loaded
• en_route - En route
• arrived - Arrived
• completed - Completed
• failed - Failed
• cancelled - Cancelled
• expired - Expired

string

Allowed values: offered claimed loaded en_route arrived completed failed cancelled expired

manifest

required

object

key

additional properties

offered_at

required

string format: date-time

expires_at

required

string format: date-time

claimed_at

string format: date-time

nullable

loaded_at

string format: date-time

nullable

en_route_at

string format: date-time

nullable

arrived_at

string format: date-time

nullable

terminal_at

string format: date-time

nullable

failure_code

string

<= 64 characters

Example

{
  "leg": "dine_in_tray",
  "status": "offered"
}

404

Media typeapplication/json

object

detail

required

string

code

required

string

Example^generated

{
  "detail": "example",
  "code": "example"
}

409

Media typeapplication/json

object

detail

required

string

code

required

string

Example^generated

{
  "detail": "example",
  "code": "example"
}

410

Media typeapplication/json

object

detail

required

string

code

required

string

Example^generated

{
  "detail": "example",
  "code": "example"
}