Return a Business

GET 
/api/v1/businesses/:id

Return a Business

Request

Path Parameters

id int32required

Query Parameters

include string

Include associations (delimited with comma). Available associations: addresses, groups, menus, orders, partners, pictures, products, reviews, exclusive_suppliers

language string

Possible values: [af, sq, ar, be, bg, ca, zh-CN, zh-TW, hr, cs, da, nl, en, et, tl, fi, fr, gl, de, el, iw, hi, hu, is, id, ga, it, ja, ko, la, lv, lt, mk, ms, mt, no, fa, pl, pt, ro, ru, sr, sk, sl, es, sw, sv, th, tr, uk, vi, cy, yi]

Responses

200

Return a Business

application/vnd.api+json

Schema

Schema

data

object

id stringrequired

type stringrequired

Possible values: [businesses]

links

object

required

self stringrequired

attributes

object

required

access-group string

allow-pickup booleanrequired

approved-for-lefood booleanrequired

auto-accept-orders booleanrequired

auto-accept-booking booleanrequired

auto-accept-booking-limit string

available-in-lefood booleanrequired

average-delivery-time numberrequired

average-score numberrequired

average-waiting-time numberrequired

bill-url string

bio string

booking-open-hours

object

id string

monday string[]

tuesday string[]

wednesday string[]

thursday string[]

friday string[]

saturday string[]

sunday string[]

breakfast-service booleanrequired

brunch-service booleanrequired

business-open-hours

object

id string

monday string[]

tuesday string[]

wednesday string[]

thursday string[]

friday string[]

saturday string[]

sunday string[]

cafe-service booleanrequired

can-pay-with-cards booleanrequired

can-pay-with-cash booleanrequired

can-pay-with-mobile booleanrequired

city stringrequired

contact-with-proper-owner-possible booleanrequired

country stringrequired

country-code stringrequired

currency string

delivery-available booleanrequired

delivery-charge-ref string

delivery-price-participation-ratio stringrequired

delivery-service-type-ref string

delivery-url string

detected-language string

dinner-service booleanrequired

email string

facebook string

favorite-id string

geolocation-lat stringrequired

geolocation-lng stringrequired

has-catering booleanrequired

has-delivery booleanrequired

has-join-the-queue booleanrequired

has-online-booking booleanrequired

has-private-events booleanrequired

has-reservations booleanrequired

has-takeaway booleanrequired

hubrise-catalog-id string

hubrise-catalog-name string

instagram string

live-info string

logo

object

required

url string

lunch-service booleanrequired

main-photo-url string

max-reservation-size numberrequired

menu-synced boolean

min-amount-for-delivery-cents numberrequired

min-time-before-reservation numberrequired

name stringrequired

online-booking-url string

owner-role string

partoo-business-id stringnullable

phone string

phone-country-code string

phone-country-prefix string

pos-partner-integration-exists booleanrequired

post-code stringrequired

price-per-person numberrequired

price-range numberrequired

rating numberrequired

region string

region-code stringrequired

secret-code string

slug string

snack-service booleanrequired

special-open-hours

object[]

Array [

id string

start_date stringrequired

end_date stringrequired

schedule string[]required

]

state stringrequired

street stringrequired

street-number stringrequired

stripe-currency stringrequired

stripe-payment-ref string

eat-in-ref required

stripe-user-id string

tagline string

takeaway-service-type-ref string

takeaway-url string

time-of-stay numberrequired

time-slots numberrequired

timezone stringrequired

unit-name stringrequired

unit-style stringrequired

visible-in-lefood booleanrequired

website string

youtube string

settings

object

required

orkestro_delivery_confirmation_enabled booleanrequired

order_business_web_notifications_enabled booleanrequired

reservation_business_web_notifications_enabled booleanrequired

sidebar-settings

object

required

The sidebar settings reflect the configuration in which the sidebar is displayed for your business.

property name*

object

visible boolean

order number

relationships

object

required

addresses

object

required

links

object

required

self stringrequired

related stringrequired

groups

object

required

links

object

required

self stringrequired

related stringrequired

menus

object

required

links

object

required

self stringrequired

related stringrequired

orders

object

required

links

object

required

self stringrequired

related stringrequired

partners

object

required

links

object

required

self stringrequired

related stringrequired

pictures

object

required

links

object

required

self stringrequired

related stringrequired

products

object

required

links

object

required

self stringrequired

related stringrequired

reviews

object

required

links

object

required

self stringrequired

related stringrequired

exclusive-suppliers

object

required

links

object

required

self stringrequired

related stringrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "businesses",
    "links": {
      "self": "string"
    },
    "attributes": {
      "access-group": "string",
      "allow-pickup": true,
      "approved-for-lefood": true,
      "auto-accept-orders": true,
      "auto-accept-booking": true,
      "auto-accept-booking-limit": "string",
      "available-in-lefood": true,
      "average-delivery-time": 0,
      "average-score": 0,
      "average-waiting-time": 0,
      "bill-url": "string",
      "bio": "string",
      "booking-open-hours": {
        "id": "string",
        "monday": [
          "string"
        ],
        "tuesday": [
          "string"
        ],
        "wednesday": [
          "string"
        ],
        "thursday": [
          "string"
        ],
        "friday": [
          "string"
        ],
        "saturday": [
          "string"
        ],
        "sunday": [
          "string"
        ]
      },
      "breakfast-service": true,
      "brunch-service": true,
      "business-open-hours": {
        "id": "string",
        "monday": [
          "string"
        ],
        "tuesday": [
          "string"
        ],
        "wednesday": [
          "string"
        ],
        "thursday": [
          "string"
        ],
        "friday": [
          "string"
        ],
        "saturday": [
          "string"
        ],
        "sunday": [
          "string"
        ]
      },
      "cafe-service": true,
      "can-pay-with-cards": true,
      "can-pay-with-cash": true,
      "can-pay-with-mobile": true,
      "city": "string",
      "contact-with-proper-owner-possible": true,
      "country": "string",
      "country-code": "string",
      "currency": "string",
      "delivery-available": true,
      "delivery-charge-ref": "string",
      "delivery-price-participation-ratio": "string",
      "delivery-service-type-ref": "string",
      "delivery-url": "string",
      "detected-language": "string",
      "dinner-service": true,
      "email": "string",
      "facebook": "string",
      "favorite-id": "string",
      "geolocation-lat": "string",
      "geolocation-lng": "string",
      "has-catering": true,
      "has-delivery": true,
      "has-join-the-queue": true,
      "has-online-booking": true,
      "has-private-events": true,
      "has-reservations": true,
      "has-takeaway": true,
      "hubrise-catalog-id": "string",
      "hubrise-catalog-name": "string",
      "instagram": "string",
      "live-info": "string",
      "logo": {
        "url": "string"
      },
      "lunch-service": true,
      "main-photo-url": "string",
      "max-reservation-size": 0,
      "menu-synced": true,
      "min-amount-for-delivery-cents": 0,
      "min-time-before-reservation": 0,
      "name": "string",
      "online-booking-url": "string",
      "owner-role": "string",
      "partoo-business-id": "string",
      "phone": "string",
      "phone-country-code": "string",
      "phone-country-prefix": "string",
      "pos-partner-integration-exists": true,
      "post-code": "string",
      "price-per-person": 0,
      "price-range": 0,
      "rating": 0,
      "region": "string",
      "region-code": "string",
      "secret-code": "string",
      "slug": "string",
      "snack-service": true,
      "special-open-hours": [
        {
          "id": "string",
          "start_date": "string",
          "end_date": "string",
          "schedule": [
            "string"
          ]
        }
      ],
      "state": "string",
      "street": "string",
      "street-number": "string",
      "stripe-currency": "string",
      "stripe-payment-ref": "string",
      "eat-in-ref": {},
      "stripe-user-id": "string",
      "tagline": "string",
      "takeaway-service-type-ref": "string",
      "takeaway-url": "string",
      "time-of-stay": 0,
      "time-slots": 0,
      "timezone": "string",
      "unit-name": "string",
      "unit-style": "string",
      "visible-in-lefood": true,
      "website": "string",
      "youtube": "string",
      "settings": {
        "orkestro_delivery_confirmation_enabled": true,
        "order_business_web_notifications_enabled": true,
        "reservation_business_web_notifications_enabled": true
      },
      "sidebar-settings": {}
    },
    "relationships": {
      "addresses": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "groups": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "menus": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "orders": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "partners": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "pictures": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "products": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "reviews": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "exclusive-suppliers": {
        "links": {
          "self": "string",
          "related": "string"
        }
      }
    }
  }
}

Example

{
  "data": {
    "id": "50404d91-bc45-43b2-8360-47f26b5ddc33",
    "type": "businesses",
    "links": {
      "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33"
    },
    "attributes": {
      "allow-pickup": true,
      "approved-for-lefood": true,
      "auto-accept-orders": false,
      "auto-accept-booking": true,
      "available-in-lefood": true,
      "average-delivery-time": 0,
      "average-score": 8.1,
      "average-waiting-time": 0,
      "bill-url": null,
      "bio": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "breakfast-service": true,
      "booking-open-hours": {
        "id": "cf47b162-95a4-4151-bef1-5fd470b36566",
        "sunday": [],
        "monday": [
          "10:00-19:00"
        ],
        "tuesday": [
          "20:00-00:00"
        ],
        "wednesday": [
          "00:00-05:00",
          "10:00-18:00"
        ],
        "thursday": [],
        "friday": [],
        "saturday": []
      },
      "brunch-service": false,
      "business-open-hours": {
        "id": "eec4cf9a-f105-45ff-a368-706fc6e988e3",
        "sunday": [],
        "monday": [
          "10:00-19:00"
        ],
        "tuesday": [
          "20:00-00:00"
        ],
        "wednesday": [
          "00:00-05:00",
          "10:00-18:00"
        ],
        "thursday": [],
        "friday": [],
        "saturday": []
      },
      "cafe-service": true,
      "can-pay-with-cards": true,
      "can-pay-with-cash": true,
      "can-pay-with-mobile": true,
      "city": "London",
      "contact-with-proper-owner-possible": true,
      "country": "United Kingdom",
      "country-code": "GB",
      "currency": "GBP",
      "delivery-available": true,
      "delivery-charge-ref": "code.1",
      "delivery-price-participation-ratio": "0.0",
      "delivery-service-type-ref": "code*1",
      "delivery-url": "https://pyszne.pl",
      "detected-language": "la",
      "dinner-service": false,
      "email": "aleksandra.bochenska@netguru.com",
      "facebook": "https://facebook.com",
      "favorite-id": null,
      "geolocation-lat": "51.5134147",
      "geolocation-lng": "-0.117157",
      "has-catering": false,
      "has-delivery": true,
      "has-join-the-queue": false,
      "has-online-booking": true,
      "has-private-events": false,
      "has-reservations": true,
      "has-takeaway": true,
      "hubrise-catalog-id": "1v3b3",
      "hubrise-catalog-name": "QA Business",
      "instagram": "https://instagram.com/netguru/",
      "live-info": null,
      "logo": {
        "url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/business/logo/50404d91-bc45-43b2-8360-47f26b5ddc33/6767c7dc-aeb5-4bb4-83de-4c3311512d77.jpeg"
      },
      "lunch-service": true,
      "main-photo-url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/picture/photo/459b132f-4bb6-4496-925c-eef1ea0a7f9d/cc7ba4bc-e24d-4861-a9c0-6032918f13a7.jpeg",
      "max-reservation-size": 20,
      "menu-synced": false,
      "min-amount-for-delivery-cents": 2000,
      "min-time-before-reservation": 3600,
      "name": "Test with Orkestro",
      "online-booking-url": "https://booking.com",
      "owner-role": "Additional information :)",
      "partoo-business-id": "615436b10a54203456024339",
      "phone": "7911123456",
      "phone-country-code": "GG",
      "phone-country-prefix": "44",
      "pos-partner-integration-exists": true,
      "post-code": "WC2B 6UF",
      "price-per-person": 20,
      "price-range": 2,
      "rating": 8.1,
      "region": "London, City of",
      "region-code": "GB-LND",
      "secret-code": "TGC12345",
      "slug": "test-with-orkestro",
      "snack-service": true,
      "special-open-hours": [
        {
          "id": "585ff8ef-4473-4e06-9d7b-cf272c446e37",
          "start_date": "2023-12-14T00:00:00.000Z",
          "end_date": "2023-12-15T00:00:00.000Z",
          "schedule": [
            "10:00-12:00",
            "13:00-15:00"
          ]
        },
        {
          "id": "bbdb3804-cd2f-4180-856c-a33386f39946",
          "start_date": "2023-12-16T00:00:00.000Z",
          "end_date": "2023-12-18T00:00:00.000Z",
          "schedule": [
            "10:00-20:00"
          ]
        },
        {
          "id": "c69a795e-45bc-484a-8a1a-43f896005ff3",
          "start_date": "2023-12-20T00:00:00.000Z",
          "end_date": "2023-12-21T00:00:00.000Z",
          "schedule": []
        }
      ],
      "state": "published",
      "street": "Kingsway",
      "street-number": "1",
      "stripe-currency": "GBP",
      "stripe-payment-ref": "code-1",
      "eat-in-ref": null,
      "stripe-user-id": "acct_1JhWDyBInYph3F9j",
      "tagline": null,
      "takeaway-service-type-ref": "code_1",
      "takeaway-url": "https://glovo.pl",
      "time-of-stay": 2700,
      "time-slots": 900,
      "timezone": "Europe/London",
      "unit-name": "Table",
      "unit-style": "Style 1",
      "visible-in-lefood": true,
      "website": "https://netguru.com",
      "youtube": "https://www.youtube.com/watch?v=VXBFPjRrsV4&ab",
      "settings": {
        "orkestro_delivery_confirmation_enabled": true,
        "order_business_web_notifications_enabled": true,
        "reservation_business_web_notifications_enabled": true
      },
      "sidebar-settings": {
        "home": {
          "visible": true,
          "order": 0
        },
        "dashboard": {
          "visible": true,
          "order": 1
        }
      }
    },
    "relationships": {
      "addresses": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/addresses",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/addresses"
        }
      },
      "groups": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/groups",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/groups"
        }
      },
      "menus": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/menus",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/menus"
        }
      },
      "orders": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/orders",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/orders"
        }
      },
      "partners": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/partners",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/partners"
        }
      },
      "pictures": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/pictures",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/pictures"
        }
      },
      "products": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/products",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/products"
        }
      },
      "reviews": {
        "links": {
          "self": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/relationships/reviews",
          "related": "/businesses/50404d91-bc45-43b2-8360-47f26b5ddc33/reviews"
        }
      }
    }
  }
}

Loading...