Retrieve a website

Retrieves a website with a specified ID. Use this operation to find the website name, logo, or more.

SecurityCustomerJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Website retrieved.

Response Schema: application/json
name
required
string

Name of the website.

url
required
string

Domain address of the website.

servicePhone
required
string

Customer service phone number of the website.

serviceEmail
required
string <email>

Customer service email address of the website.

id
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
string or null

Hosted payment form CSS options.

object or null

Hosted payment form theme options.

object or null

Hosted payment form features.

organizationId
string <= 50 characters
Deprecated

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "organization"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/storefront/websites/{id}
Request samples
Response samples
application/json
{
  • "id": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  • "name": "string",
  • "url": "string",
  • "servicePhone": "string",
  • "serviceEmail": "user@example.com",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "settings": {
    },
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "_links": [
    ]
}