Create a sale

post

https://api.flipdish.co/salesManagement/orgs/{orgId}/sales

⚠️ Beta Notice: This endpoint is currently in beta and may change or be deprecated at any time without notice.

Records a completed sale against an org. Use this endpoint to ingest sales from an external point-of-sale, ordering, or marketplace system into Flipdish so they appear in reporting, reconciliation, and the audit trail. Each request must include a unique x-idempotency-key header. Retries with the same key return the original response instead of producing a duplicate sale, which makes the call safe to retry on network failures.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

string

required

Organization ID in standard format

Body Params

salesChannelId

string

required

Sales Channel ID in standard format

source

string

Free text field for partner to add their source e.g. App, ChatGPT etc

requestedFulfillmentTime

string

required

The time at which the restaurant hands over responsibility of the food. ISO 8601 UTC format

desiredAsap

boolean

True if user wants it asap. False if user wants it at a specific time. If user provides true but requestedFulfillmentTime is more than an hour away then override it to false.

dispatchType

string

enum

required

Fulfillment mode

Allowed:

externalId

string

Partner/platform order unique identifier. Optional in case if platform wants to use their own orderNumbers

displayId

string

length ≤ 15

Display ID for the sale. Visible to the restaurant staff and customer.

menuId

string

required

Menu ID

menuRevisionId

string

required

Revision ID

customer

object

delivery

object

dineIn

object

notes

string

Notes intended for the restaurant staff / chef

charges

array of objects

required

charges*

discounts

array of objects

required

discounts*

items

array of objects

required

length ≥ 1

List of items included in the order. Item IDs are not required for create operations.

items*

payments

array of objects

required

Payment and refund lines used to generate RMS receipt lines. May be empty when no payment lines exist, implying unpaid sale.

payments*

metadata

string

Free text JSON for adding any additional information

Headers

x-idempotency-key

string

required

Unique idempotency key (GUID) to ensure the request is processed only once. If a request with the same key was already processed, the original response will be returned.

Responses

200Sale created successfully

400Bad Request

401Authentication has been denied

403Successfully authenticated but access has been denied