Storefront websites

Use these operations to access Storefront websites.

Storefront operations interact directly with the customer, and provide the customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.

Operations

Retrieve a website

Request

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

Security
CustomerJWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/websites/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Website retrieved.

Bodyapplication/json
idstring, <= 50 characters(WebsiteId)read-only

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

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
namestringrequired

Name of the website.

urlstringrequired

Domain address of the website.

servicePhonestringrequired

Customer service phone number of the website.

serviceEmailstring, (email)required

Customer service email address of the website.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

customFieldsobject(ResourceCustomFields)

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.

Default:{}
Example:
{
  "foo": "bar"
}
settingsobject

Website settings.

logoIdstring or null, <= 50 characters

ID of the linked file object.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
logoUrlstring or nullread-only

URL of the website logo.

organizationIdstring, <= 50 characters(OrganizationId)read-onlydeprecated

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

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
Response
{
  "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": {
    "depositForm": { … },
    "paymentForm": { … },
    "amplitude": { … },
    "payoutRequest": { … }
  },
  "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "logoUrl": "string",
  "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "_links": [
    { … }
  ]
}