Retrieve Tenant

Retrieve a tenant by tenant ID.

GET/tenants/{tenantId}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Retrieve Tenant action (under Auth Admin).
Fill in the fields below, then reference the result from later steps as {{retrieveTenant.response.data}}.

Request

Path parameters

tenantIdstringrequired

Response

Returns 200 with an object. Read it in later steps with {{retrieveTenant.response.data.<field>}}.

tenantIdstring

merchantIdinteger

descriptionstring

contactstring

emailAddressstring

phoneNostring

isDeletedboolean

statusstring

tierstring

This read only value relates to the B2C Comerce realm of the customer. - XS = Bronze and Bronze+ - S = Silver and Silver+ - M = Gold and Gold+ - L = Platinum and Platinum+

One ofXSSML

requestQuotaPerMinutenumber

This read only value shows the the number of requests that can be made per minute.

json

{
  "tenantId": "aaaa_prd",
  "merchantId": 1,
  "description": "SLAS Merchant Name",
  "contact": "SLAS Tenant Contact",
  "emailAddress": "tenant_contact@slas.tst",
  "phoneNo": "000-000-0000",
  "isDeleted": false,
  "status": "CLEAR",
  "tier": "L",
  "requestQuotaPerMinute": 8000
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?