v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB

URL Generator API

Generate User Session URL

Creates a session URL (SURL). Session URLs are either valid for one purchase, or for 72 hours after the last web hit for that session has been requested by the Cleverbridge web servers. Various marketing campaigns sometimes require the customer to make a purchase within a limited time or for a maximum quantity. This resource allows you to define those parameters.<br /> For XML examples and schemas, see the Additional Examples - Generate User Session URL.

post/urlgenerator/generateusersessionurl

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

CurrentSessionIdstring

Unique ID of an existing session URL. If you use this parameter, the data from an existing session will be copied to the new session, directly behind the generated <code>Url</code>. As a result, the customer will not loose the settings associated with the existing session.

TargetUrlstring required

The destination URL for which you want to create a session URL. The <code>TargetURL</code> string must be url-encoded only for XML requests. For an overview of all supported parameters, see List of Checkout Process Parameters.

Response

Urlstring

The generated session URL.

ResultMessagestring

Optional result or error message.