Set order as withdrawn

This guide documents the Abbiamo API documentation guidelines.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Header required

The Header x-abbiamo-seller-group-key is required to create orders. Please fill out this field on the upper right corner of this page.

If you dont have one, check the this page to know how to get yours

📘

Rate Limit

There is a global rate limit of 1500 request within a 5-minute window

This endpoint sets an order to status SUCCESSFUL and sub_status WITHDRAWN. It is the end of the cycle of an order, therefore no other update can be done after this endpoint.

❗️

Attention to validations

You will not be successful if trying to set an order as withdrawn that is not of type TAKEOUT or is not ready to be picked up by the customer (status DISPATCHED)

Path Params
string
required
Defaults to 5c2c1dc2-0509-415c-a68c-a04d355d993c

The order id sent in the webhook events

Body Params
string
required

The event time in format of ISO string with timezone. Example: 2022-12-15T12:15:08.060-03:00

receiver
object

Information about the person who has received the package

string

Any additional information or the reason to cancel

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json