Update an Offer Status

put

https://{region}/api/v2/admin/offers/{box_id}/status

This endpoint changes the status of an offer to reflect its current state in the process, such as "Shipped" or "Completed."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

box_id

string

required

The unique identifier of the new status for the offer.

Body Params

status_id

integer

required

To specify the unique identifier representing the current status of an offer or item.

notes

string | null

To add additional information or comments about the offer or item.

list_reason

string | null

Reason for updating the offer. This field is required only when changing status to 'Not as described'.

send_email

boolean

To indicate whether an email notification should be sent (true or false). The default value is false, and it overrides the workflow’s email setting.

items

array of objects

List of item objects to process.

items

transaction_id

string | null

To provide the unique identifier for a specific transaction.

images

array of strings or null

List of image URLs uploaded during status change.

images

Headers

x-secret-key

string

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200