Website
A website record exposes a website to REST web services.
This record has the following subrecords:
-
imagesize
-
siteentrypoint
-
websitefieldset
REST web services do not support legacy tax features. To work with taxation through REST web services, you must have the SuiteTax feature enabled. For more information about using SuiteTax, see SuiteTax.
The REST API Browser includes information about the field names and field types of the website record. It also includes the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s website reference page.
For information about using the REST API Browser, see The REST API Browser.
Record IDs
The record ID for the website REST record is website.
Prerequisites
You must enable the Website feature to be able to use the website record.
Limitations
The following sublists are not accessible through REST web services:
-
Storetab
-
Sitecurrency
-
Sitelanguage
-
Cartcolumn
-
Imagisize
Additionally, a number of fields are also not accessible. For the list of accessible fields, see the REST API browser.
The website record does not work with external ID.
Code Samples
The following code sample shows how to load website data from a website with the ID 1.
GET {{COMPANY_URL}}/services/rest/record/v1/website/1
The following code sample shows how to find a website by name.
GET {{COMPANY_URL}}/services/rest/record/v1/website?q=displayName START_WITH "My website"