Get order
Returns a single order if it belongs to a location the app is connected to.
curl --request GET \
--url https://api.maple.inc/v1/orders/{orderId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/orders/{orderId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.maple.inc/v1/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.maple.inc/v1/orders/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.maple.inc/v1/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.maple.inc/v1/orders/{orderId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "order",
"id": "<string>",
"livemode": true,
"created": 123,
"status": "<string>",
"payment_status": "<string>",
"location_id": "<string>",
"fulfillment_type": "<string>",
"scheduled_for": "<string>",
"delivery_address": {
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"notes": "<string>"
},
"customer": {
"name": "<string>",
"phone": "<string>",
"phone_last_four": "<string>"
},
"line_items": [
{
"name": "<string>",
"menu_entity_id": "<string>",
"quantity": 123,
"base_price": 123,
"tax": 123,
"modifiers": [
{
"name": "<string>",
"menu_entity_id": "<string>",
"quantity": 123,
"price": 123
}
]
}
],
"totals": {
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"surcharge": 123,
"tip": 123,
"delivery_fee": 123,
"delivery_tip": 123,
"total": 123
},
"external_id": "<string>",
"payment": {
"provider": "<string>",
"status": "<string>",
"payment_link_url": "<string>"
}
}{
"_tag": "DeveloperApiBadRequest",
"message": "<string>",
"feedback": "<string>",
"code": "<string>"
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"code": "insufficient_scope",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123,
"feedback": "<string>"
}Authorizations
API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.
Path Parameters
Response
Success
order True when the order belongs to the live environment; false for test-mode data.
Customer-selected completion time (ISO 8601, UTC) for scheduled orders; null for ASAP orders. Prepare the order for this time, not on receipt.
The delivery address for delivery orders, including delivery instructions; null for pickup orders or when no stored address is available.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
All amounts in integer USD cents. total = subtotal + tax + surcharge + tip + delivery fees.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api.maple.inc/v1/orders/{orderId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/orders/{orderId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.maple.inc/v1/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.maple.inc/v1/orders/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.maple.inc/v1/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.maple.inc/v1/orders/{orderId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "order",
"id": "<string>",
"livemode": true,
"created": 123,
"status": "<string>",
"payment_status": "<string>",
"location_id": "<string>",
"fulfillment_type": "<string>",
"scheduled_for": "<string>",
"delivery_address": {
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"notes": "<string>"
},
"customer": {
"name": "<string>",
"phone": "<string>",
"phone_last_four": "<string>"
},
"line_items": [
{
"name": "<string>",
"menu_entity_id": "<string>",
"quantity": 123,
"base_price": 123,
"tax": 123,
"modifiers": [
{
"name": "<string>",
"menu_entity_id": "<string>",
"quantity": 123,
"price": 123
}
]
}
],
"totals": {
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"surcharge": 123,
"tip": 123,
"delivery_fee": 123,
"delivery_tip": 123,
"total": 123
},
"external_id": "<string>",
"payment": {
"provider": "<string>",
"status": "<string>",
"payment_link_url": "<string>"
}
}{
"_tag": "DeveloperApiBadRequest",
"message": "<string>",
"feedback": "<string>",
"code": "<string>"
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"code": "insufficient_scope",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>",
"feedback": "<string>"
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123,
"feedback": "<string>"
}