Create an order

post

https://orders-api.paymongo.com/v1/orders

Creates a dine-in order for a touchpoint. livemode and organization are derived from the merchant secret key.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Order to create

custom_fees

array of objects

custom_fees

customer

object

items

array of objects

required

length ≥ 1

items*

inventory_item_id

string

InventoryItemID is optional: the channel-resolved inventories-api item id
for this line. Omitted means the line is untracked (no stock hold).

item_id

string

required

price

integer

Price is optional and opt-in: the unit price the client displayed. When
present, the server validates it against the authoritative price and
returns price_mismatch on mismatch; when omitted, the server uses the
authoritative price silently.

quantity

integer

required

variant_id

string

VariantID optionally selects a product variant; omitted means the
product's default variant.

location_slug

string

location_slug is optional (omit for org-level orders); touchpoint_code is required.

metadata

object

Metadata is a flat string map stored verbatim on the order (e.g. a shipping address), opaque to this service. Up to 50 keys, key names 1 to 40 characters, values up to 500 characters.

tips

object

touchpoint_code

string

required

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

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

application/json

201Created

400Bad Request

401Unauthorized

502Bad Gateway

default