Sign In

Get /v1/b2b/customer/session

Inputs

  • Sign in via email and password
    • x-acme-email: header, email address of the user we're signing in as
    • x-acme-password: password of the user we're signing in as
  • Sign in via userName
    • x-acme-tenantId: tenant id of the user we're signing in as
    • x-acme-user-name: userName of the user we're signing in as
    • x-acme-password: password of the user we're signing in as

Returns

A Session Response

Create Tenant

POST /v1/b2b/customer

Inputs

A Create Tenant object

Returns

The id of the newly created tenant

Get a Tenant

Get /v1/b2b/customer/{id}

Inputs

  • id:  the id of the tenant you want to get

Returns

A Tenant object

List Users of a Tenant

Get /v1/b2b/customer/list

Returns

A list of Tenant objects

Activate a Tenant

POST /v1/b2b/customer/{id}/activate

Inputs

  • id:  Tenant ID of the tenant you want to activate
  • Body:  Tenant information to activate this tenant.  Must contain information like address...

Returns

No Return

Customer JSON Objects

Session Response

Field
Description
Notes
sessionSession to be used in future calls. 
expireMsnumber of milliseconds that this session is valid for 
emailemail address of this user 
userNameUser Name for this user 
tenantIdid of the tenant 
firstNameFirst name of the user 
lastNameLast name of the user 
confirmedboolean true if the user has confirmed their email address 
onBoarded boolean, true if this user has been on boarded and entered all of their information 
titleTitle of this user 
tenantTimeZoneTimeZone that the tenant is in. 
companyNameName of the company 
rolesList of names of roles supported by this user 

 

Tenant

Field
Description
Notes

name

Name of the company. 

streetAddress1

Street address of the company. 
streetAddress2Second line of street address of the company. 
cityCity the company is in. 
stateState the company is in. 
zipCodeZip code of the company. 
countryCountry the company is in. 
phoneNumberPhone number for the company. 
companyUrlThe company's website url. 
logoImageThe path to the logo image of the company. 
timezoneThe timezone the company is in. 
consumerPagePath to our consumer page for the company. 
giftCertificatesboolean true if this tenant supports gift certificates 
reviewsboolean true if the reviews are accepted for this tenant otherwise false.  

Create Tenant

Field
Description
Notes
orgNameOrganization name of the new tenant. 
emailemail address of the admin for this tenant.