Update an order action

PATCH /v1/order_actions/{order_action_id}

Changes the fields you send. This is how a response is recorded.

Authentication

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Path parameters

Name	Type	Required
order_action_id	string	yes

Request body

Field	Type	Required
name	string
description	string
on_activities_type	"break" | "delivery" | "end" | "pickup" | "start"
consumer_tracking	boolean
is_mandatory	boolean
is_blocking	boolean
prompt_request	object or null
order_id	string
status	"CANCELED" | "COMPLETED" | "CREATED" | "FAILED"
status_description	null or string
prompt_response	object or null
modified_at	null or string	yes
tags	array of string
attributes	object

Responses

200

resource: OrderAction

Field	Type	Required
name	string	yes
description	string	yes
on_activities_type	"break" | "delivery" | "end" | "pickup" | "start"	yes
consumer_tracking	boolean	yes
is_mandatory	boolean	yes
is_blocking	boolean	yes
prompt_request	object or null	yes
order_id	string	yes
status	"CANCELED" | "COMPLETED" | "CREATED" | "FAILED"	yes
status_description	null or string	yes
prompt_response	object or null	yes
id	string	yes
created_at	string	yes
modified_at	null or string	yes
deleted_at	null or string	yes
created_by	string	yes
modified_by	null or string	yes
deleted_by	null or string	yes
owners	array of string	yes
tags	array of string	yes
attributes	object	yes

Example

curl -X PATCH 'https://orders-api.cloud.zoopit.no/v1/order_actions/{order_action_id}'
  -H 'Authorization: Bearer <token>'
  -H 'Content-Type: application/json'
  -d '{ ... }'

Try it in the interactive Orders API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.