Create an order

post

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

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

If an order with the same order_id has already been processed for the given store, the endpoint will return a 202 Accepted status with the message "This order has already been processed." and the order's id. This indicates that the request has been accepted and everything is fine on our side.

Required scopes:

order.create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

order_id

string

required

Your order id.

unique_id

string | null

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

channel

string

enum

required

Order channel.

Allowed:

delivery

string

enum

required

Delivery mode.

Allowed:

loyalty_store_slug

string

required

The store slug from Hey Pongo. The slug of an existing record in the stores table.

loyalty_tablet_id

integer | null

The Hey Pongo tablet id that should be notified.

amount_with_taxes

integer

required

Order amount in cents.

amount_taxes

integer | null

Order taxes amount in cents.

reward_ids

array of strings

reward_ids

order_status

string

enum

required

Order status.

Allowed:

created_at

string

required

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

delivery_status

string

enum

required

Order delivery status.

Allowed:

withdrawal_date

string | null

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

comment

string | null

Customer order comment.

lines

array of objects

required

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

lines*

customer

object | null

Customer data.

payments

array of objects

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

payments

device_id

string | null

Device id that handles the command.

device_name

string | null

Device name that handles the command.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

201Order created successfully

202Order already processed