Skip to main content
API docs by Redocly

Clienteling Setup API (0.0.1)

Download OpenAPI specification:Download

Use this resource to set up retailers and stores for clienteling in the NewStore platform. For more information, see how clienteling is used via NewStore Associate App.

Enable clienteling configuration

Represents a new configuration created for retailers to enable clienteling in stores in their business.

Enable clienteling configuration for retailer

Configures clienteling capabilities for an existing retailer. Once configured, the retailer can start clienteling operations in stores in their business.

The ecom_link property contains the link to the e-commerce website of the retailer, which is included along with product recommendations sent to the customer via clienteling messages.

Authorizations:
bearerAuth
header Parameters
Tenant
required
string

The name of the tenant making the request.

Request Body schema: application/json
ecom_link
string

The link to the retailer's website.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "request_id": "ckdk5bwy00009ztlo16062bce",
  • "message": "Something is wrong with the request."
}

Onboarding stores

Contains endpoints that you can use to enable clienteling at specified stores for the retailer.

Note: Ensure that you have the phone number that you intend to use for clienteling conversations in the store.

Onboard store

Onboard a new store to clienteling.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

query Parameters
enable
boolean
Default: false

If true enables the store right away on clienteling

header Parameters
Tenant
required
string

The name of the tenant making the request.

Request Body schema: application/json
phone_number
required
string

The phone number that will be used to onboard the store for clienteling.

Responses

Request samples

Content type
application/json
{
  • "phone_number": "+1234567890"
}

Response samples

Content type
application/json
{
  • "request_id": "ckdk5bwy00009ztlo16062bce",
  • "message": "Something is wrong with the request."
}

Available phone numbers

Represents the phone numbers that are available to be purchased for the store, which can then be used to configure clienteling operations in the store.

See onboarding stores for more information.

List available phone numbers

Retrieves a list of available phone numbers that can be used to enable clienteling operations in a store. The available phone numbers are based on store configuration for the specified store (such as the country code, geography and landline extension).

Once a number has been used to onboard a store, it will be used for clienteling operations in the store.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]