Skip to main content
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>'
{
  "id": "org_123",
  "name": "Crave Collective",
  "country": "US",
  "currency": "usd",
  "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",
  "locations": [
    {
      "id": "loc_456def",
      "restaurantDisplayName": "Downtown Pizza Co",
      "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",
      "methodsStatus": {
        "pickup": true,
        "table": true,
        "delivery": false,
        "roomService": false
      }
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API Key required to authenticate requests

Path Parameters

​
merchantSlug
string
required

Response

Merchant retrieved successfully.

​
id
string
required
Example:

"org_123"

​
name
string
required
Example:

"Crave Collective"

​
country
string
required
Example:

"US"

​
currency
string
required
Example:

"usd"

​
locations
object[]
required
​
bio
string

Merchant-level description. Empty string when not set.

Example:

"Crave Test Kitchen is ready to serve you..."

​
cover
string

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