Retrieves a website with specified ID.
Website retrieved.
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. | |||||||||||
| |||||||||||
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. | |||||||||||
Unauthorized access. Invalid credentials used.
Access forbidden.
Resource not found.
$website = $client->websites()->load('websiteId');
{- "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": {
- "foo": "bar"
}, - "settings": {
- "paymentForm": {
- "css": "string",
- "theme": {
- "colorPrimary": "#504CCA"
}, - "features": {
- "showCoupons": [
- "string"
]
}
}
}, - "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "_links": [
- {
- "href": "string",
- "rel": "self"
}
]
}