GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Replaces a Establishment object

put
https://qa2.revelup.com/enterprise/Establishment//

Replaces a Establishment object specified by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of Establishment to replace

Body Params

Establishment object that needs to be updated

string

Directions to the physical location. No validation. Will be displayed in the About section of the Revel Online Ordering page.

string

Business description. No validation. Will be displayed in the About section of the Revel Online Ordering page.

string
length ≤ 511

Business name. No validation. Will be displayed in the About section of the Revel Online Ordering page.

boolean
Defaults to true

Flag. If set to False, the location is inactive and can not be accessed.

uri

URI of an Address resource where the location address is defined. Contents will be displayed in the About section of the Revel Online Ordering page.

json
Defaults to {}

Field no longer used. Stores a JSON object.

boolean
Defaults to false

Flag. If set to True, this location will have access to the billing tab where hosting fees can be paid.

uri

URI of a Brand resource that specifies the location brand. Most non-enterprise accounts will have a signle brand.

string
length ≤ 280

Name of the brand this location is part of.

boolean
Defaults to true

Flag. If set to True, the location can be deactivated remotely.

date-time

Timestamp of when the location will be deactivated automatically. If the timestamp exceeds current date, the disabled_for_cancellation flag is set to True.

integer
enum

Where the customer bought their subscription from.

Client Type:

  • 0 - Revel
  • 1 - Intuit
Allowed:
string
length ≤ 255

Name of the primary location contact.

uri

URI of the User that created this location.

date-time

ISO8601 timestamp of the time the resource was created.

boolean
Defaults to false

Flag. If set to True, allows access to API endpoints that generate reports designed for the CTUIT integration.

uri
deprecated

Deprecated field - currency is now defined in the system settings.

boolean
Defaults to false

Flag. If set to True, will enable the delivery management feature.

boolean
Defaults to false

Flag. If set to True, indicates that access to certain elements of the UI was disabled due to unpaid outstanding invoices in the billing portal.

string

Timestamp of when the location was disabled due to unpaid outstanding invoices.

boolean
Defaults to false

Flag. If set to True, indicates that the location was cancelled by the owner.

boolean
Defaults to false

Flag. If set to True, indicates that the location was disabled due to unpaid outstanding invoices in the billing portal.

url
deprecated

Deprecated field - used to store the background image of the customer display, which is now defined in the system settings.

date-time

ISO8601 timestamp that indicates when the instance was deployed.

string
deprecated

Deprecated field.

string
length ≤ 75

Location contact email.

integer
enum

Type of algorythm used for export file generation. If Both, an option to use the Old export is present, but New is used by default.

Export Type:

  • 0 - Old - Slower, but can handle extremely large amounts of data.
  • 1 - New - Faster, but will fail if exporting a very large amount of data.
  • 2 - Both - Both types allowed.
Allowed:
string
length ≤ 80

Location fax number.

integer
enum

Location type.

Hierarchy Type:

  • 0 - Client - Represents the brand of the location. Acts as a folder.
  • 3 - Division - Represents the franchise of the location. Acts as a sub-folder.
  • 5 - Store - Represents a single, physical location.
Allowed:
images
array of urls

Array of image URLs that show the location. Will be displayed in the About section of the Revel Online Ordering page.

images
boolean
Defaults to false

Flag. If set to True, the location contact details were verified by an administrator. Certain sections are restricted until this is done.

url
deprecated

Deprecated field - used to store the URL to the Kiosk idle image, which is now defined in the system settings.

string
length ≤ 280
deprecated

Deprecated field - part of the discontinued PayPal integration.

string
length ≤ 75
deprecated

Deprecated field - part of the discontinued PayPal integration.

string
length ≤ 280
deprecated

Deprecated field - part of the discontinued PayPal integration.

integer
enum

'Lock adding' will prevent adding from the same location, 'Lock all adding' will prevent adding from all locations.

Lock Type.

  • 0 - Unlock adding
  • 1 - Lock adding
  • 2 - Lock all adding
Allowed:
boolean
Defaults to false

Flag. If set to True, this location will not accept new discounts pushed via the Enterprise Management System.

integer
enum

'Lock adding' will prevent adding from the same location, 'Lock all adding' will prevent adding from all locations.

Lock Type.

  • 0 - Unlock adding
  • 1 - Lock adding
  • 2 - Lock all adding
Allowed:
uri

URI of a RevelImage resource that stores the business logo.

url
deprecated

Deprecated field - used to store the URL of the business logo.

uri

URI of the location manager's User resource.

boolean
Defaults to false

Flag. If set to True, will enable the Matrix Inventory feature.

string
length ≤ 280

Location alias. Will be used as a reference by the reporting platform and the POS. Not client-facing.

string
deprecated

Deprecated field - location notes are no longer accessible via API and are fore staff users only.

string

Customer NetSuite ID, which ties their billing portal with this location.

boolean
deprecated

Deprecated field - onboarding process is no longer tracked here.

date-time
deprecated

Deprecated field - onboarding process is no longer tracked here.

date-time
deprecated

Deprecated field - onboarding process is no longer tracked here.

integer
enum

Location payment gateway. For display purposes only.

Payment Gateway:

  • 0 - None
  • 101 - USAePay
  • 102 - Mercury
  • 103 - PayPal
  • 104 - FreedomPay
  • 105 - WorldPay
  • 106 - Intuit
  • 201 - Moneris
  • 301 - Adyen
  • 401 - Tyro
  • 402 - Quest
string
length ≤ 80

Location contact number. Will be displayed in the About section of the Revel Online Ordering page.

integer
enum

QB integration indicator.

Integration Type:

  • 0 - None
  • 1 - Online
Allowed:
string
length ≤ 255

Fuel Retail only field. Maps to the GSAP Bill-to field.

string
length ≤ 6

Location Revel ID. Used to uniquely identify the location.

boolean
Defaults to false
deprecated

Deprecated field - part of the discontinued RTI integration.

string
length ≤ 100

Internal use only.

boolean
Defaults to false

Flag. If set to True, will lock scale measurement precision to 2 decimal places.

uri

URI of the associated SystemSetting resource.

date-time

ISO8601 timestamp of the last change to the location's associated SystemSetting resource.

boolean
Defaults to false

Flag. If set to True, will display a warning banner in the UI regarding an unpaid outstanding billing invoice.

boolean
Defaults to false

Flag. If set to True, will display a warning popup on the POS regarding an unpaid outstanding billing invoice.

string
length ≤ 6

Fuel Retail only field. Maps to ROID or GSAP Ship-to field.

social_networks
array of uris
deprecated

Deprecated field - used to store a list SocialNetwork URIs for social media links.

social_networks
integer
deprecated

Deprecated field.

integer
deprecated

Deprecated field.

integer
deprecated

Deprecated field - surcharges are now defined in the system settings.

tax
array of strings
deprecated

Deprecated field - taxes are now defined in their own Tax resource.

tax
string
deprecated

Deprecated field.

boolean
Defaults to false

Flag. If set to True, payroll reports can be made.

string

Pytz timezone. Will define the timezone of all reporting timestamps, so should not be changed on production instances.

integer
enum

Location service type.

Service Type:

  • 0 - Table Service
  • 1 - Quick Service
  • 2 - Retail
  • 3 - Grocery
  • 4 - Revel Lite QSR - Deprecated
  • 5 - Revel Lite Retail - Deprecated
  • 6 - Donation - Deprecated
  • 7 - Fuel Retail
  • 8 - Simple Start - Deprecated
  • 9 - Essential - Deprecated
uri

URI of the user that last made changes to this resource.

date-time

ISO8601 timestamp of the last time the resource was updated.

boolean
Defaults to false

Flag. If set to True, the location is marked as a VIP and is entitled to the VIP support line.

string
length ≤ 255

Unique key for making web reservations under this location.

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Establishment with the provided ID not found.

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago