API Reference

Create order V2

post
https://api.abbiamo.io/v2/order

This guide documents the Abbiamo API documentation guidelines.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Your seller identifier. Default value is the seller document number

string
required

Your order number identifier

string
enum
required
Defaults to DELIVERY

Order type: DELIVERY if it is shipped to the customer, TAKEOUT if the customer is gonna pickup in the store, RETURN if the píckup point is at customer's address

Allowed:
string

External service/integration order id. You can use your id here

int32

Invoice total amount in reais cents, the default value is 1 cent if this field is null

string

The time in format of ISO string with timezone when the invoice was created. Example: 2022-12-15T12:15:08.060-03:00

string

Invoice number identification

string

44 digits string of the electronic invoice

volumes
array of objects
required

Volumes informations

volumes*
customer
object
required
destination_address
object

Required if type DELIVERY. Optional if type TAKEOUT. Ignored if type RETURN

source_address
object

Required if type RETURN. Ignored if other types

delivery
object

This object is specific for carrier integrations. You should not send it if you are not integrated with carriers systems. If you have further questions, please reach out to us.

takeout
object

Takeout automations. Only valid if type is specified as TAKEOUT

json

Any additional information about the order that will be stored in the database and can be used among the plataform like dispatch rules

boolean
Defaults to true

This parameter works together with the delivery object. If the delivery object is present, this parameter will be ignored. If there's no delivery object, then, this parameter is evaluated. If true, dispatch rules will be applied. If false no rule will be applied and the order will just be created

int32

Shipping price the customer has paid to receive the order in the promised shipping date. This field must be in reais cents

string

Promised shipping datetime in format of ISO string with timezone to final customer. Example: 2022-12-15T12:15:08.060-03:00

int32

Planned duration from the pickup point to the destination point, in minutes

date-time

ISO 8601 timestamp representing the start of the delivery window. Example: 2025-10-08T14:30:00.000-03:00

date-time

ISO 8601 timestamp representing the end of the delivery window. Example: 2025-10-08T15:30:00.000-03:00

int32

Estimated dwell time at destination during delivery, in minutes

date-time

ISO 8601 timestamp representing the time that the order was created in your system. Example: 2025-10-08T14:30:00.000-03:00

string

Your shipper unique Identifier.

Responses

Updated 2 days ago

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

Updated 2 days ago