Apply an operation on a preparation request

put

https://sandbox-api.unify-retail.com/v1/preparation-requests/{id}/operations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length between 13 and 13

The unique identifier of the preparation request

Body Params

operation

string

enum

required

Specifies the operation to be applied to the preparation request. Possible values are:

accept: Confirms the preparation request.
refuse: Refuse the preparation request and trigger a rebound. A refusal occurs if all requested locations reject the preparation request.
cancel: Cancel the preparation request if it was previously accepted and trigger a rebound.
prepare: Prepares items into packages. If any item's preparation quantity is 0, a rebound operation is triggered for that item.
available_in_store: Marks items as available in the store.
pickup_partial: Indicates that only a partial pickup has been completed. Automatically create an RMA for the unsent items.
pickup_refused: Marks the pickup as refused. Create automatically an RMA with the unsent items.
pickup_completed: Confirms the pickup has been successfully completed.

location_id

string

required

length ≤ 20

This field is required for only accept and refuse operation

packages

array of objects

This field is required only for prepare operation

packages

unsent_items

array of objects

This field is required only if the preparation request is refused, canceled, or incomplete

unsent_items

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200Successful response