Single step leave A/S/F

The flow is similar to the standard User Leaves A/S/F use case the standard User Leaves A/S/F use case, except all the user’s information is provided in the initial Process Start request. In most cases, the Process Start API optionally consumes no initial payload. Once a Process initializes, Storefront Gateway responds with a request for the data it requires to complete its task. However, the User Leaves A/S/F Process is one of the cases where the client can provide the required data upfront, in the initial request body. This can be useful if you want your UI to collect the required data, in a flow you deem easiest for your end users, before first before calling the Process.

Request

If your client has all the relevant information, it provides that calls the Process with the Process Step API, and includes that information in the request body:

**REQUEST - POST https://\{your.url\}/process/start/entitlementManagement.UserLeavesASF.v1.0**
{
   "parameters": {
      "entities": [
         {
            "entityType": "account",
            "entityId": 6007
         }
      ]
   }
} 

`parameters`	Object that contains the data required for the Process.
`entities`	Array of entities to be removed from the current User. Each entity object includes:
`entityType`	The type of entity being shared. Possible values are `account`, `subscription`, and `feature`.
`entityId`	The unique internal identifier on the entity (i.e., the `id` property). A list of available entities along with their internal identifiers can be obtained by using the relevant APIs (e.g. GET /user/accounts, GET /user/subscriptions).

Response

Provided all the information is accurate, Storefront Gateway removes any associations between the current User and the specified entities (Accounts, Subscriptions, Features). The Process returns a 200 HTTP status:

**RESPONSE - body**
{
   "processId": "57afa130-aadd-4f62-ace3-c3e94c974822",
   "processName": "entitlementManagement.UserLeavesASF.v1.0",
   "lastStep": true,
}

`processId`	Unique identifier for the current instance of this Process.
`processName`	Full name of the Process, including the category and version number.
`lastStep`	Boolean that indicates whether or not this was the last step in the Process.
Parent topic:User Leaves a Shared Account, Subscription, or Feature

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

Request

Response

​Request

​Response

Request

Response