This class provides RESTful services to generate the preview token.
com.ibm.commerce.rest.member.handler.PreviewTokenHandler
| HTTP Method | Path | Description |
|---|---|---|
| POST | /store/{storeId}/previewToken | Requests the preview token. |
Requests the preview token.
genPreviewToken
true
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | Request body. | body | com.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewParameters | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewToken
POST /wcs/resources/store/10001/previewToken
201
{
"previewToken": "AEAA_QCbAOkADQAnEWiViA"
}
Preview parameters.
| Name | Data Type | Required |
|---|---|---|
| workspaceId | string | false |
| status | string | false |
| start | string | false |
| invstatus | string | false |
| timeZoneId | string | false |
| includedMemberGroupIds | string | false |
Preview token.
| Name | Data Type | Required |
|---|---|---|
| previewToken | string | false |