Skip to main content

Sample Payloads

Introduction​

This article provides examples of online order payloads for the most common types of online ordering transactions. They are for illustrative purposes only, to demonstrate the potential structure of online order request payloads.

For a list of all Online Ordering fields and their detailed definitions, see the API Reference:

Local Order Creation​

POST /o/op/1/order/local:


{
"businessLocationId": {{businessLocationId}},
"endpointId": "Sample-Endpoint-ID",
"thirdPartyReference": "Sample-Order-Reference",
"tableNumber": 1,
"clientCount": 1,
"customerInfo": {
    "firstName": "Lightspeed",
    "lastName": "Test",
    "email": "documentationtest@lightspeedhq.com",
    "salutation": "Mr",
    "notes": "XYZ",
    "thirdPartyReference": "Sample-Customer-Reference"
},
"items": [
    {
    "quantity": 1,
    "sku": "8"
    }
],
"orderNote": "XYZ"
}

To-Go Order Creation​

POST /o/op/1/order/toGo:


{
"businessLocationId": {{businessLocationId}},
"endpointId": "Sample-Endpoint-ID",
"thirdPartyReference": "Sample-Order-Reference",
"collectionCode": 12345,
"customerInfo": {
    "firstName": "Lightspeed",
    "lastName": "Test",
    "email": "documentationtest@lightspeedhq.com",
    "salutation": "Mr",
    "notes": "XYZ",
    "thirdPartyReference": "Sample-Customer-Reference"
},
"deliveryAddress": {
    "addressLine1": "123 Street",
    "addressLine2": "Suite 200",
    "city": "City Name",
    "zip": "123456"
},
"items": [
    {
    "quantity": 1,
    "sku": "8"
    }
],
"orderNote": "XYZ"
}