Orders
GET /locations/:locationId/orders
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/orders?createdAtStart=&createdAtEnd=&includeUpdatedActivity={{includeUpdatedActivity}}
curl --location -g --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//orders?createdAtStart=&createdAtEnd=&includeUpdatedActivity={{includeUpdatedActivity}}' \
--header 'x-api-key;'
Depending on which query parameters are supplied, retrieves all orders that were either last updated, created OR closed within the specified date/time range for the supplied location.
-
Only orders that were last updated (i.e., created, modified, closed, deleted) within the last 90 days (approximately) are available.
-
The duration of the date range cannot exceed 26 hours.
-
One of the following sets of date range parameters must be supplied in the query string. Note that all dates must be RFC 3339 formatted (w/o milliseconds):
- Option 1 (recommended) - Use this option to return those orders that were last updated within the time range defined by the below query string parameters.
- updatedAtStart - inclusive
- updatedAtEnd - exclusive. Must be 5 or more minutes in the past. This delay is imposed to ensure that updates to orders are not "missed" due to internal database replication lag.
- Option 2* - Use this option to return those orders that were created within the time range defined by the below query string parameters.
- createdAtStart - inclusive
- createdAtEnd - exclusive. Must be 5 or more minutes in the past. This delay is imposed to ensure that updates to orders are not "missed" due to internal database replication lag.
- Option 3* - Use this option to return those orders that were last closed within the time range defined by the below query string parameters.
- closedAtStart - inclusive
- closedAtEnd - exclusive. Must be 5 or more minutes in the past. This delay is imposed to ensure that updates to orders are not "missed" due to internal database replication lag.
- Option 1 (recommended) - Use this option to return those orders that were last updated within the time range defined by the below query string parameters.
*Please Note
If options 2 or 3 are utilized to regularly fetch orders (as opposed to using Option 1 as recommended), it is highly recommended to add "includeUpdatedActivity=true" to the query string to avoid missing order updates. That way any orders that were created/closed previously (but last updated within the specified createdAt or closedAt time range) will be re-fetched.
If fetching orders by "closedAt" date/time (Option #3) with "includeUpdatedActivity" set to "true", only previously closed orders that have been updated within the specified time range will be added into in the result set (yes, closed orders can be modified under certain circumstances).
Suggested Order Retrieval Patterns
Import Orders Daily
- Retrieve the last 26 hours of order updates every 24 hours (preferably during restaurant downtime for non 24 hour operations). This will permit up to 2 hours of secondary database server replication lag* on SpotOn’s side w/o introducing the risk of the API Consumer missing order updates. Obviously, order updates that occurred 24 to 26 hours prior to the daily request will be fetched twice by the API consumer if there wasn’t any serious replication lag on SpotOn’s side between hours 24 and 26.
Import Orders In a “close to realtime” Fashion
-
Retrieve orders every 5 minutes, but with a 5 minute “lag” (this lag is imposed by SpotOn in order to account for data replication delays on SpotOn’s side and/or clock discrepancies between SpotOn’s servers and the API Consumer’s servers). In other words, the API consumer will receive order updates that occurred 5 to 10 minutes ago every 5 minutes.
-
Also, as an extra layer of protection against missed order updates, retrieve the last 26 hours of order updates every 24 hours (preferably during restaurant downtime for non 24 hour operations). This will permit up to 2 hours of secondary database server replication lag on SpotOn’s side w/o introducing the risk of an API Consumer missing order updates.
Regardless of the chosen data retrieval pattern, note that the API Consumer will have to perform the appropriate “retries” when API errors are encountered to ensure that order updates are not missed.
- The POS Export API retrieves data from one of SpotOn’s secondary database servers rather than from the primary in order to reduce load on the primary. Note that secondary server replication lag times rarely go over a few seconds, but longer lag times are possible (e.g., during database maintenance).
Response Payload Structure
The response body for a "200 OK" response will contain a JSON array of order objects. Each object in the array will be structured as follows:
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| id | string | The unique ID for the order. | |
| name | string | The name of the order. | |
| deleted | boolean | True if the order has been marked as deleted. | |
| locationId | string | The unique ID for the location of the order. | |
| orderTypeId | string | The unique ID for the order type of the order. | Yes |
| orderTypeName | string | The name of the order type (at the time the order type was assigned to the order). | Yes |
| createdByEmployeeId | string | The unique ID for the employee who created the order. | Yes |
| createdByEmployeeName | string | The name of the employee (as stored in the system at the time the order was created). | Yes |
| createdAt | string | The RFC 3339 formatted date/time that the order was created. | |
| closedAt | string | The RFC 3339 formatted date/time that the order was closed. Will be empty/null if the order is still open. | |
| orderNumber | string | The order number. Will be an empty string for open orders that haven't yet had an order number assigned. | |
| tableNumber | string | The table number for the order. Will be an empty string if the order is not assigned to a specific table. | |
| scheduled | boolean | True if the order is/was scheduled for a future time. Payments on scheduled orders w/ a null "releasedAt" date/time should likely be treated as liabilities that don't contribute towards net sales until the order is released to the kitchen. | |
| releasedAt | string | The RFC 3339 formatted date/time that the scheduled order was released to the kitchen. If the scheduled order was not yet released, this field will be null. Note that this field only applies to those orders where "scheduled" is true. As stated above, payments on scheduled orders w/ a null "releasedAt" date/time should likely be treated as liabilities that don't contribute towards net sales until the order is released to the kitchen. | |
| ownerInfo | OWNERINFO | An object containing information regarding the employee that owns the order. | |
| totalAmount | DOLLARAMOUNT | The final total dollar amount of the order (after discounts, taxes and surcharges have been applied). | |
| balanceDueAmount | DOLLARAMOUNT | The dollar amount of the balance still due on the order. | |
| checks | []CHECK | An array containing the individual checks that comprise the order. | |
| updatedAt | string | The RFC 3339 formatted date/time that the order was last updated. NOTE: Milliseconds are currently present in this value. This is subject to change in the future (meaning we may drop the milliseconds portion of the date/time in the future to be consistent with the rest of this API). So please ensure that the API consuming code doesn't depend on Milliseconds being present. |
OWNERINFO
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| employeeId | string | The unique ID of the employee that owns the order. | Yes |
| employeeName | string | The name of the employee that owns the order. | Yes |
| jobPositionId | string | The unique ID of the job position that the employee was clocked in under when he/she took ownership of the order. | Yes |
CHECK
| Field Name | Field Type | Field Description |
|---|---|---|
| gratuityAmount | DOLLARAMOUNT | The auto gratuity dollar amount applied to the check. |
| totalAmount | DOLLARAMOUNT | The final total dollar amount of the check (after discounts, taxes and surcharges have been applied). |
| paymentsAmount | DOLLARAMOUNT | The total dollar amount of the payment(s) applied to this check. |
| balanceAmount | DOLLARAMOUNT | The amount of the balance still due on the check. |
| guests | []GUEST | An array containing the guests that were added to the check. |
| surcharges | []SURCHARGE | An array of surcharges that were applied to the check. An an example of a surcharge that would appear at the check level would be a "Delivery Surcharge". |
| payments | []PAYMENT | An array of payments that were applied to the check. |
| autoGratuityTaxes | []TAX | An array of taxes that apply to the auto gratuity. |
| items | []MENUITEM | An array containing the menu items that were added directly to the check (rather than being added at the guest level). This array is almost always empty. |
| voidedItems | []MENUITEM | An array containing menu items that were added directly to the order, then voided. If no items directly on the order were voided, this will be empty. |
GUEST
| Field Name | Field Type | Field Description |
|---|---|---|
| name | string | The name of the guest if available. |
| items | []MENUITEM | An array containing menu items ordered by the guest. |
| voidedItems | []MENUITEM | An array containing menu items that were added to the guest, then voided. If no items for this guest were voided, this will be empty. |
MENUITEM
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| menuItemId | string | The unique ID for the menu item. This ID will refer to a menu item returned by the "menu-items" endpoint. | Yes |
| name | string | The name for the menu item (as on record at the time the menu item was added to the order). | Yes |
| createdAt | string | The RFC 3339 formatted date/time that the menu item was added to the order. | |
| quantity | string | The quantity for the menu item expressed as a decimal number string. Notes: 1) For a subitem, this value will always equal the quantity of the top-level menu item since the POS restricts a subitem's quantity to be "1 per parent menu item instance". With that being said, one should NOT multiply a subitem's quantity by it's ancestor quantities for inventory tracking purposes. 2) Fractional quantities (such as ".5") are possible since the same physical menu item can be split between multiple guests. | |
| preDiscountsAmount | DOLLARAMOUNT | The extended dollar amount (amount*quantity) charged for the menu item before discounts and taxes (not including charges for this item's priced subitems and modifiers). | |
| discountsAmount | DOLLARAMOUNT | The total dollar amount of discounts applied to this menu item (not including discount amounts that were applied to this item's priced subitems and modifiers). | |
| postDiscountsAmount | DOLLARAMOUNT | The extended dollar amount (amount*quantity) charged for the menu item after discounts have been applied, but before taxes (again, not including charges for this item's priced subitems and modifiers). | |
| taxesAmount | DOLLARAMOUNT | The total amount of taxes applied to this menu item (not including taxes on this item's priced subitems and modifiers). | |
| totalAmount | DOLLARAMOUNT | The extended total amount (amount*quantity) charged for this menu item, after discounts and taxes have been applied (again, not including charges for this item's priced subitems and modifiers). | |
| discounts | []DISCOUNT | An array containing the individual discounts that were directly/indirectly applied to this menu item. Note that for items with subitems/modifiers, the "amount" for each discount in the array does not represent a total. Each discount amount only represents the portion of the discount that was applied to the item itself, it does not include the discount amounts that were applied to that item's subs/mods. | |
| taxes | []TAX | An array containing the individual taxes that were applied to this menu item. | |
| subItems | []MENUITEM | An array containing any subitems that were selected for this menu item. | |
| giftCardIssueReload | boolean | "true" if the menu item represents the sale/reloading of a gift card. This field is important since gift card sales/reloads should likely be treated as a liability rather than contributing to net sales. | |
| modifiers | []MODIFIER | An array containing the modifiers that were selected for this menu item. |
DISCOUNT
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| id | string | The unique ID that identifies a particular instance of an applied discount. This ID may appear multiple times at various levels of the same order due to the nature of "higher level" discounts (e.g. check level discounts) that are recursively distributed amongst child menu-items/sub-items/modifiers. | |
| discountId | string | The unique ID of the discount. This ID references a particular discount returned by the "discounts" endpoint. | Yes |
| discountName | string | The name of the discount at the time that it was applied. | Yes |
| createdAt | string | The RFC 3339 formatted date/time that the discount was applied. | |
| amount | DOLLARAMOUNT | The dollar amount of the discount. |
TAX
| taxId | string | The unique ID for the tax. This ID references a tax returned by the "taxes" endpoint. Notes: This field will be empty for online orders received through "splick.it". Only a very small number of our restaurants accept splick.it orders, so an empty value here should be rare. | Yes |
| taxName | string | The name of the tax at the time it was applied. | Yes |
| percentage | string | The rate of the tax. The value is expressed as a decimal percentage string (e.g., "6.5" represents a tax rate of 6.5%). | |
| amount | DOLLARAMOUNT | The dollar amount of the tax. |
MODIFIER
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| modifierId | string | The unique ID for the modifier. This ID will refer to a modifier returned by the "modifiers" endpoint. Notes: This field will be empty for online orders received through "splick.it". Only a very small number of our restaurants accept splick.it orders, so an empty value here should be rare. | Yes |
| modifierOptionId | string | The unique ID for the modifier option that was chosen. This ID will refer to a modifier option returned by the "modifier-options" endpoint. Note: This field will be empty for online orders received through "splick.it". Only a very small number of our restaurants accept splick.it orders, so an empty value here should be rare. | Yes |
| text | string | The display text for the modifier/modifier option combo. For example, If the modifier is named "Cheese" and the modifier option is named "Extra", the value of this field will be "Extra Cheese". | |
| preDiscountsAmount | DOLLARAMOUNT | The extended dollar amount (amount multiplied by the parent menu item's quantity) charged for the modifier before discounts and taxes have been applied. | |
| discountsAmount | DOLLARAMOUNT | The total amount of discounts applied to this modifier. Note that discounts cannot be applied directly to a modifier, so any discounts at this level would have been applied to a parent entity (i.e., check or menu item) and then proportionately distributed to this modifier. | |
| postDiscountsAmount | DOLLARAMOUNT | The extended dollar amount (amount multiplied by the parent menu item's quantity) charged for the modifier after discounts have been applied, but before taxes. | |
| taxesAmount | DOLLARAMOUNT | The total amount of taxes applied to the modifier. | |
| totalAmount | DOLLARAMOUNT | The extended total amount (amount multiplied by the parent menu item's quantity) charged for the modifier, after discounts and taxes have been applied. | |
| discounts | []DISCOUNT | An array containing the individual discounts that were added to a parent entity (i.e., check or menu item) and then proportionately distributed to this modifier. | |
| taxes | []TAX | An array containing the individual taxes that were applied to this modifier. |
SURCHARGE
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| surchargeId | string | The unique ID for the surcharge. This ID references a surcharge returned by the "surcharges" endpoint. | Yes |
| surchargeName | string | The name of the surcharge at the time it was applied. | Yes |
| createdAt | string | The RFC 3339 formatted date/time that the surcharge was applied. | |
| amount | DOLLARAMOUNT | The dollar amount of the surcharge. | |
| taxesAmount | DOLLARAMOUNT | The total dollar amount of the taxes applied to the surcharge. | |
| taxes | []TAX | An array containing the individual taxes that were applied to the surcharge. |
Note that surcharges can be applied at either the check or payment level.
PAYMENT
| Field Name | Field Type | Field Description | Org Level Attribute* |
|---|---|---|---|
| paymentOptionId | string | The unique ID for the payment option that was used for the payment. This ID references a payment option returned by the "payment-options" endpoint. | Yes |
| paymentName | string | The name of the payment option at the time the payment was applied. | Yes |
| createdAt | string | The RFC 3339 formatted date/time that the payment was applied. | |
| amount | DOLLARAMOUNT | The dollar amount of the payment. | |
| surcharges | []SURCHARGE | An array containing the individual surcharges that were applied to the payment. An example of such a surcharge would be a credit card surcharge to account for processing fees incurred by the merchant. | |
| surchargesAmount | int64 | The total amount of surcharges applied to the payment. | |
| tipAmount | DOLLARAMOUNT | The dollar amount of the tip. | |
| tipDeductionAmount | DOLLARAMOUNT | The dollar amount that is to be deducted from the tip before distributing it to the employee that owns the tip to account for credit card processing fees incurred by the merchant. | |
| tipAppliedToEmployeeId | string | The unique ID of the employee that owns the tip. | Yes |
| employeeId | string | The unique ID of the employee who took the payment. | Yes |
| employeeName | string | The name of the employee (as on record at the time of payment) who took the payment. | Yes |
| cardType | string | Credit card type. If "paymentOptionId" is that of a payment option with a "kind" of "CC", "cardType" will contain one of the following values: "Unknown" "Amex" "Discover" "Manual CC" "Mastercard" "Visa" | |
| cardNumber | string | Last 4 characters of the credit card number (formatted as "...XXXX"). Applicable only if "paymentOptionId" is that of a payment option with a "kind" of "CC" . | |
| cardholderName | string | The cardholder's name. Applicable only if "paymentOptionId" is that of a payment option with a "kind" of "CC". |
DOLLARAMOUNT
An amount in US dollars expressed as a decimal number string. For example, $1.10 will be represented as "1.1".
*Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.
Example Response
[
{
"id": "p0lnzv4kcvfupgtt2llh5nabn2",
"name": "Quick Sale",
"deleted": false,
"locationId": "Location152",
"orderTypeId": "5c7d1e3a8bb3c0e2a1d4f2c7",
"orderTypeName": "Dine In",
"createdByEmployeeId": "hqmiywohdvcsxlpfyftxpokmem",
"createdByEmployeeName": "Mark Nalepka",
"createdAt": "2020-02-28T19:09:15Z",
"closedAt": "2020-02-28T22:37:39Z",
"orderNumber": "3",
"tableNumber": "",
"scheduled": false,
"ownerInfo": {
"employeeId": "hqmiywohdvcsxlpfyftxpokmem",
"employeeName": "Mark Nalepka",
"jobPositionId": "5c7d1e4a8bb3c0e2a1d50b5c"
},
"totalAmount": "38.69",
"balanceDueAmount": "0",
"checks": [
{
"gratuityAmount": "3.02",
"totalAmount": "38.69",
"paymentsAmount": "38.69",
"balanceAmount": "0",
"guests": [
{
"name": "Guest 1",
"items": [
{
"menuItemId": "5c7d1e448bb3c0e2a1d50460",
"name": "Coke",
"createdAt": "2020-02-28T19:09:15Z",
"quantity": "1",
"preDiscountsAmount": "2.19",
"discountsAmount": "1.1",
"postDiscountsAmount": "1.09",
"taxesAmount": "0.09",
"totalAmount": "1.18",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "1.1"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0.09"
}
],
"subItems": [],
"giftCardIssueReload": false,
"modifiers": []
},
{
"menuItemId": "5c7d1e448bb3c0e2a1d50461",
"name": "Asian Chicken Salad 嗨",
"createdAt": "2020-02-28T19:09:44Z",
"quantity": "1",
"preDiscountsAmount": "9.29",
"discountsAmount": "4.64",
"postDiscountsAmount": "4.65",
"taxesAmount": "0.37",
"totalAmount": "5.02",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "4.64"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0.37"
}
],
"subItems": [],
"giftCardIssueReload": false,
"modifiers": [
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4b2",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5bf",
"text": "Lite Caesar",
"preDiscountsAmount": "0",
"discountsAmount": "0",
"postDiscountsAmount": "0",
"taxesAmount": "0",
"totalAmount": "0",
"discounts": [],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0"
}
]
},
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4b5",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5c1",
"text": "Add Bacon",
"preDiscountsAmount": "1.99",
"discountsAmount": "1",
"postDiscountsAmount": "0.99",
"taxesAmount": "0.08",
"totalAmount": "1.07",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "1"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0.08"
}
]
},
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4b2",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5ce",
"text": "Sub- Caesar",
"preDiscountsAmount": "0",
"discountsAmount": "0",
"postDiscountsAmount": "0",
"taxesAmount": "0",
"totalAmount": "0",
"discounts": [],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0"
}
]
}
]
},
{
"menuItemId": "5c7d1e448bb3c0e2a1d504e6",
"name": "Salad Platters",
"createdAt": "2020-02-28T19:09:51Z",
"quantity": "1",
"preDiscountsAmount": "40",
"discountsAmount": "19.99",
"postDiscountsAmount": "20.01",
"taxesAmount": "1.6",
"totalAmount": "21.61",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "19.99"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "1.6"
}
],
"subItems": [
{
"menuItemId": "5c7d1e448bb3c0e2a1d5048b",
"name": "BBQ Ranch Chicken Salad",
"createdAt": "2020-02-28T19:10:31Z",
"quantity": "1",
"preDiscountsAmount": "5",
"discountsAmount": "2.5",
"postDiscountsAmount": "2.5",
"taxesAmount": "0.2",
"totalAmount": "2.7",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "2.5"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0.2"
}
],
"subItems": [],
"giftCardIssueReload": false,
"modifiers": [
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4d6",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5bf",
"text": "Lite Champagne Ving",
"preDiscountsAmount": "0",
"discountsAmount": "0",
"postDiscountsAmount": "0",
"taxesAmount": "0",
"totalAmount": "0",
"discounts": [],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0"
}
]
},
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4b5",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5c1",
"text": "Add Bacon",
"preDiscountsAmount": "1.99",
"discountsAmount": "1",
"postDiscountsAmount": "0.99",
"taxesAmount": "0.08",
"totalAmount": "1.07",
"discounts": [
{
"id": "e5mtzvab1zhyfizyxvtw4a1xzu",
"discountId": "5c7d1e498bb3c0e2a1d50a5e",
"discountName": "Manager Comp %",
"createdAt": "2020-02-28T19:12:11Z",
"amount": "1"
}
],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0.08"
}
]
},
{
"modifierId": "5c7d1e3c8bb3c0e2a1d4f4b2",
"modifierOptionId": "5c7d1e3e8bb3c0e2a1d4f5ce",
"text": "Sub- Caesar",
"preDiscountsAmount": "0",
"discountsAmount": "0",
"postDiscountsAmount": "0",
"taxesAmount": "0",
"totalAmount": "0",
"discounts": [],
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"percentage": "8",
"amount": "0"
}
]
}
]
}
],
"giftCardIssueReload": false,
"modifiers": []
}
]
}
],
"surcharges": [
{
"surchargeId": "tur4tqloefav5oj3xeko1uo1te",
"surchargeName": "Sample Taxable Surcharge",
"createdAt": "2020-02-28T19:11:07Z",
"amount": "3.02",
"taxesAmount": "0",
"taxes": [
{
"taxId": "5c7d1e3d8bb3c0e2a1d4f5b0",
"taxName": "CA Tax",
"amount": "0"
}
]
}
],
"payments": [
{
"paymentOptionId": "5c7d1e4a8bb3c0e2a1d50af1",
"paymentName": "Cash ",
"createdAt": "2020-02-28T19:14:37Z",
"amount": "38.69",
"surcharges": [],
"surchargesAmount": "0",
"tipAmount": "",
"tipDeductionAmount": "0",
"tipAppliedToEmployeeId": "",
"employeeId": "hqmiywohdvcsxlpfyftxpokmem",
"employeeName": "Mark Nalepka",
"cardType": "",
"cardNumber": "",
"cardholderName": "",
}
],
"items": []
}
]
}
]
| Headers | |
|---|---|
| x-api-key | Your API Key |
| Params | |
|---|---|
| updatedAtStart | 2020-02-28T00:00:00Z Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 26 hours. Orders that were last updated in any fashion (created, updated, closed, or deleted) during the specified date/time range will be returned. |
| updatedAtEnd | 2020-02-28T22:20:00Z Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range. |
| createdAtStart | Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 26 hours. |
| createdAtEnd | Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range. |
| closedAtStart | {{closedAtStart}} Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 26 hours. |
| closedAtEnd | {{closedAtEnd}} Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range. |
| includeUpdatedActivity | {{includeUpdatedActivity}} This flag is only applicable if querying for orders based on their "createAt" or "closedAt" values. If "true", orders that were created/closed previously (but last updated within the specified "createdAt" or "closedAt" time range) will be re-fetched. It is highly recommended that the query parameter be present and set to true when querying based on "createAt" or "closedAt". Otherwise, order updates can/will be missed. |
| Path Variables | |
|---|---|
| locationId | The unique ID for the location |
GET /locations/:locationId/orders/:orderId
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/orders/:orderId
curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//orders/' \
--header 'x-api-key;'
Retrieves a single order for the supplied location.
Response Payload Structure
The response body for a "200 OK" response will contain a single JSON order object. See the parent route's documentation for more details.
| Headers | |
|---|---|
| x-api-key | Your API Key |
| Path Variables | |
|---|---|
| locationId**** | The unique ID for the location |
| orderId | The unique ID for the order |
Updated over 2 years ago