Get merchant with storefront locations
curl --request GET \
--url https://api.craveup.com/api/v1/merchant/{merchantSlug} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.craveup.com/api/v1/merchant/{merchantSlug}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.craveup.com/api/v1/merchant/{merchantSlug}', 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.craveup.com/api/v1/merchant/{merchantSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.craveup.com/api/v1/merchant/{merchantSlug}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.craveup.com/api/v1/merchant/{merchantSlug}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craveup.com/api/v1/merchant/{merchantSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "org_123",
"name": "Crave Collective",
"country": "US",
"currency": "usd",
"locations": [
{
"id": "loc_456def",
"restaurantDisplayName": "Downtown Pizza Co",
"methodsStatus": {
"pickup": true,
"table": true,
"delivery": false,
"roomService": false
},
"coverPhoto": "https://cdn.craveup.com/cover.jpg",
"restaurantLogo": "https://cdn.craveup.com/logo.png",
"restaurantBio": "A neighbourhood pizza shop with seasonal specials.",
"addressString": "123 Market Street, San Francisco, CA"
}
],
"bio": "Crave Test Kitchen is ready to serve you...",
"cover": "https://cdn.craveup.com/merchant-cover.jpg",
"logo": "https://cdn.craveup.com/merchant-logo.png"
}{
"success": false,
"message": "Unauthorized access",
"code": "UNAUTHORIZED"
}{
"success": false,
"message": "Requested resource not found",
"code": "NOT_FOUND"
}{
"success": false,
"message": "An unexpected error occurred",
"code": "GENERIC_ERROR"
}Merchants
Get merchant with storefront locations
Returns merchant metadata and enabled locations for the storefront experience.
GET
/
merchant
/
{merchantSlug}
Get merchant with storefront locations
curl --request GET \
--url https://api.craveup.com/api/v1/merchant/{merchantSlug} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.craveup.com/api/v1/merchant/{merchantSlug}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.craveup.com/api/v1/merchant/{merchantSlug}', 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.craveup.com/api/v1/merchant/{merchantSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.craveup.com/api/v1/merchant/{merchantSlug}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.craveup.com/api/v1/merchant/{merchantSlug}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craveup.com/api/v1/merchant/{merchantSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "org_123",
"name": "Crave Collective",
"country": "US",
"currency": "usd",
"locations": [
{
"id": "loc_456def",
"restaurantDisplayName": "Downtown Pizza Co",
"methodsStatus": {
"pickup": true,
"table": true,
"delivery": false,
"roomService": false
},
"coverPhoto": "https://cdn.craveup.com/cover.jpg",
"restaurantLogo": "https://cdn.craveup.com/logo.png",
"restaurantBio": "A neighbourhood pizza shop with seasonal specials.",
"addressString": "123 Market Street, San Francisco, CA"
}
],
"bio": "Crave Test Kitchen is ready to serve you...",
"cover": "https://cdn.craveup.com/merchant-cover.jpg",
"logo": "https://cdn.craveup.com/merchant-logo.png"
}{
"success": false,
"message": "Unauthorized access",
"code": "UNAUTHORIZED"
}{
"success": false,
"message": "Requested resource not found",
"code": "NOT_FOUND"
}{
"success": false,
"message": "An unexpected error occurred",
"code": "GENERIC_ERROR"
}Authorizations
API Key required to authenticate requests
Path Parameters
Pattern:
^[a-z0-9-]+$Response
Merchant retrieved successfully.
Example:
"org_123"
Example:
"Crave Collective"
Example:
"US"
Example:
"usd"
Show child attributes
Show child attributes
Merchant-level description. Empty string when not set.
Example:
"Crave Test Kitchen is ready to serve you..."
Merchant hero image. Empty string when not set.
Example:
"https://cdn.craveup.com/merchant-cover.jpg"
Merchant logo used across storefront experiences. Empty string when not set.
Example:
"https://cdn.craveup.com/merchant-logo.png"
⌘I