previewToken

This class provides RESTful services to generate the preview token.

Handler Class:

com.ibm.commerce.rest.member.handler.PreviewTokenHandler

Method Summary

HTTP MethodPathDescription
POST/store/{storeId}/previewTokenRequests the preview token.

Method Details

POST /store/{storeId}/previewToken

Requests the preview token.

Handler Method:

genPreviewToken

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewParametersfalseN/A
HTTP Status Codes:
HTTP Status CodeDescription
201The requested resource has been created.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewToken


Example

Request:
POST /wcs/resources/store/10001/previewToken
HTTP Status Code:

201

Response:
{
	"previewToken": "AEAA_QCbAOkADQAnEWiViA"
}

Data Type Details

com.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewParameters

Preview parameters.

Properties:
NameData TypeRequired
workspaceIdstringfalse
statusstringfalse
startstringfalse
invstatusstringfalse
timeZoneIdstringfalse
includedMemberGroupIdsstringfalse

com.ibm.commerce.rest.member.handler.PreviewTokenHandler$PreviewToken

Preview token.

Properties:
NameData TypeRequired
previewTokenstringfalse