- Platform Overview
- Resources and Guides
-
POS Integration
-
Getting Started
-
Core Concepts
-
Integration SDK
-
Certification
-
- Order Ahead
-
Provider Enablement
-
Provider Enablement
-
Endpoints
-
Developer Endpoints
-
-
API Reference
-
Getting Started
-
v15
-
- Access Tokens
- Campaigns
- Credit Cards
- Users
- Credit
- Locations
- Payment Methods
- QR Codes
- Progress Adjustments
-
Orders
- Create Proposed Order
- Complete Order
- Refund
- List by App
- Interstitials
- Get Merchant Details
- Get User Details
- Create Feedback
- Rewards
- Gift Cards
-
-
v14
-
- Credit
- Access Tokens
- Campaigns
- Categories
- Credit Cards
- Interstitials
- Locations
- Loyalty
- Orders
- Payment Tokens
- Support Tickets
- Users
-
-
Orders .: Get Merchant Details
API Reference / v15
Get Merchant-Oriented Order Details
This endpoint returns parameters pertinent to merchants, as opposed to users. In order to access an order through this endpoint, the user must be associated with the merchant.
Request Endpoint
GET /v15/merchants/:id/orders/:uuid
Authorization Required – Merchant Token in Header
Authorization: token merchant="982-9a4218e4b6714b7b6b47890d0bf2f46544c99ff7a5957f72ef5637eaafdc73"
Request Parameters
Param | Presence | Description |
---|---|---|
uuid |
Required | The UUID of the order. |
id |
Required | The merchant’s ID |
cURL Example
curl https://sandbox.thelevelup.com/v15/merchants/34/orders/f7943600849501323c1552668b2aa48c \
-H Accept:application/json \
-H Content-Type:application/json \
-H 'Authorization:token merchant="982-9a4218e4b6714b7b6b47890d0bf2f46544c99ff7a5957f72ef5637eaafdc73"'
Example Response
HTTP/1.1 200 OK
{
"order": {
"cashier": "Andrew Jones",
"created_at": "2014-12-17T11:24:26-05:00",
"identifier_from_merchant": "1001",
"location_id": 5698,
"loyalty_id": 633172,
"refunded_at": null,
"register": "3",
"transacted_at": "2014-12-17T11:24:26-05:00",
"user_display_name": "Test U.",
"uuid": "123b75b0806011e29e960800200c9a66",
"items": [
{
"item": {
"description": "Leftovers featuring pickled cabbage",
"name": "BiBimBap",
"quantity": 2,
"sku": "1111",
"category": "Korean",
"upc": "9999",
"children": [],
"charged_price_amount": 200,
"standard_price_amount": 200
}
},
{
"item": {
"description": "Lovely sprockets with gravy",
"name": "Sprockets",
"quantity": 7,
"sku": "1234",
"category": "Weird stuff",
"upc": "4321",
"children": [],
"charged_price_amount": 100,
"standard_price_amount": 100
}
}
],
"earn_amount": 0,
"merchant_funded_credit_amount": 12,
"spend_amount": 10,
"tip_amount": 2,
"total_amount": 12
}
}
Response Parameters
Parameters | Type | Description |
---|---|---|
cashier |
String | The cashier who is logged into the POS terminal. |
created_at |
String (Date) | The ISO 8601 date and time (YYYY-MM-DDThh:mm:ss±hh:mm) the order was created. See transacted_at for the date and time the order was placed. |
identifier_from_ merchant
|
String | The order ID or number for the check. Should be usable to find the check on the POS. |
location_id |
Integer | LevelUp Location ID that is placing the order. |
loyalty_id |
Integer | The merchant specific user ID. |
refunded_at |
String (Date) or null | The ISO 8601 date and time (YYYY-MM-DDThh:mm:ss±hh:mm) the order was refunded. |
register |
String | The register that placed the order. |
transacted_at |
String | The ISO 8601 date and time (YYYY-MM-DDThh:mm:ss±hh:mm) the user placed the order. |
user_display_name |
String | The first name and last initial of the user. |
uuid |
String (UUID) | The order’s unique identifier. |
items[] |
JSON Array | An array of items in the order. |
item |
JSON Hash | Object representing an order item. |
item[children] |
JSON Array | Array of sub-items. Usually modifiers or add-on items. |
item[charged_price_ amount]
|
Integer | The price for the item(s) that was charged to the customer (in cents). (Unit price * quantity - non-LevelUp discounts) |
item[description] |
String | The description of the item. |
item[name] |
String | The name of the item. |
item[quantity] |
Integer | The number of this item sold. Not required for child items. |
item[sku] |
String | SKU (Stock Keeping Unit) code of this item. |
item[category] |
String | Category of the item. |
item[standard_price_ amount]
|
Integer | Standard price for the item(s). (Unit price * quantity) |
item[upc] |
String | UPC (Universal Product Code) of the item. |
earn_amount |
Integer | The amount (in cents) of credit the customer earned by completing the order. |
merchant_funded_credit_amount |
Integer | The amount (in cents) of mercahnt funded credit used on the order. |
spend_amount |
Integer | Total amount of the order (in cents), including applied LevelUp discounts and tax. |
tip_amount |
Integer (Money) | The amount (in cents) tipped by the user. |
total_amount |
Integer (Money) | The amount (in cents) spent by the user, including tip, but excluding credit applied. |
Errors
A merchant with the given ID was not found
HTTP/1.1 404 Not Found
[
{
"error": {
"object": "merchant",
"property": "id",
"message": "Merchant not found."
}
}
]
An order with the given UUID was not found
HTTP/1.1 404 Not Found
[
{
"error": {
"object": "order",
"property": "id",
"message": "Order not found."
}
}
]
The current user does not have proper merchant credentials
HTTP/1.1 401 Unauthorized