Create an order

post https://sandbox-api.heypongo.com/v1/orders

Please keep your current payload if you are already using our previous endpoints.

Required scopes:

order.create

Body Params

order_id

string

required

Your order id.

unique_id

string

If the order is initiated by an external partner, then this field must contain the order id from that partner.

channel

string

required

Order channel.

delivery

string

required

Delivery mode.

loyalty_store_slug

string

required

The store slug from Hey Pongo.

loyalty_tablet_id

integer

The Hey Pongo tablet id that should be notified.

amount_with_taxes

integer

required

Order amount in cents.

amount_taxes

integer

Order taxes amount in cents.

reward_ids

array of strings

reward_ids

order_status

string

required

Order status.

created_at

string

required

Order creation datetime in ISO8601 format. Must be a valid date.

delivery_status

string

required

Order delivery status.

withdrawal_date

string

Order withdrawal datetime in ISO8601 format. Must be a valid date.

comment

string

Customer order comment.

lines

array of objects

required

Array of order lines (at least one). Must have at least 1 items.

lines*

customer

object

Customer data.

payments

array of objects

Payment details. This field is required when payments is present.

payments

device_id

string

Device id that handles the command.

device_name

string

Device name that handles the command.

Response

Language

Credentials

Bearer


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://sandbox-api.heypongo.com/v1/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "channel": "pos",
8
  "delivery": "takeaway",
9
  "order_status": "opened",
10
  "delivery_status": "waiting-for-delivery"
11
}
12
'

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

application/json

200