HomeGuidesAPI Reference
API Reference

Creates a new sale in the system

post
https://api.flipdish.co/salesManagement/orgs//sales

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

Creates a new sale in the system

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

Organization ID in standard format

Body Params
string
required

Sales Channel ID in standard format

string

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

string
required

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

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.

string
enum
required

Fulfillment mode

Allowed:
string

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

string
length ≤ 15

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

string
required

Menu ID

string
required

Revision ID

customer
object
delivery
object
dineIn
object
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*
string

Free text JSON for adding any additional information

Headers
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

Updated 4 months 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 4 months ago