- 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
- Rewards
- Gift Cards
-
-
v14
-
- Credit
- Access Tokens
- Campaigns
- Categories
- Credit Cards
- Interstitials
- Locations
- Loyalty
-
Orders
- List by App
- List By Location
- Create
- Get Merchant Details
- Refund
- Get User Details
- Create Feedback
- Payment Tokens
- Support Tickets
- Users
-
-
Orders .: Get Merchant Details
API Reference / v14
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 /v14/merchants/:id/orders/:uuid
Authorization Required – Merchant Token in Header
Authorization: token 123456-75489120749...
Request Parameters
Param | Presence | Description |
---|---|---|
uuid |
Required | The UUID of the order. |
id |
Required | The merchant’s ID |
cURL Example
curl -X GET -H Accept:application/json -H Content-Type:application/json -H "Authorization:token 123456-75489120749..." https://api.thelevelup.com/v14/merchants/3225/orders/123b75b0806011e29e960800200c9a66
Example Response
HTTP/1.1 200 OK
{
"order": {
"created_at": "2014-01-01T00:00:00-04:00",
"merchant_funded_credit_amount": 5,
"earn_amount": 0,
"loyalty_id": 123,
"spend_amount": 5,
"refunded_at": "2014-01-01T00:00:00-04:00",
"tip_amount": 0,
"total_amount": 5,
"location_id": 123,
"transacted_at": "2014-01-01T00:00:00-04:00",
"user_display_name": "Ryan T",
"uuid": "123b75b0806011e29e960800200c9a66"
}
}
Response Parameters
Parameters | Type | Description |
---|---|---|
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. |
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. |
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. |
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