Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
URL Generator API

Generate Protected URL

Creates a unique URL (UURL), which you can use to protect a destination URL. Protection is necessary when the destination URL contains dynamic products, confidential products, and customer profile data. It also allows you to place various restrictions on the unique URL.<br /> For XML examples and schemas, see the Additional Examples - Generate Protected URL.<br /><b>Warning</b> - Do not use protected URLs (UURLs) if you plan on creating a large quantity of URLs (10,000 or more). This can hurt the Cleverbridge platform and slow down your customers' checkout experience. If you plan on creating a large quantity of URLs, you should use session URLs (SURLs) or dynamic protected URLs (dynamic UURLs). For more information, contact Client Experience.

post/urlgenerator/generateprotectedurl

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

AllowPurchaseOrderboolean

Whether the customer can use purchase order as a payment method.

AllowToChangeCartboolean

Whether the customer can edit the quantity of the product in the cart.

EnableFraudProtectionboolean

Fraud protection ensures that suspicious orders are inspected by the Cleverbridge anti-fraud team.

MaxQuantityinteger required

Maximum number of orders for which the link is valid. Only submitted orders are counted. When the maximum is reached, the link automatically expires, and no more orders are accepted. The number must be between 0 and 99999.

ResultItemQuantityinteger

Number of protected URLs that are generated. The number must be between 1 and 1000.

TargetUrlstring required

The destination URL that you want to protect. 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.

ValidFromstring date-time

Start date and time according to RFC3339.

ValidUntilstring date-time

End date and time according to RFC3339.

Response

OK

ResultMessagestring

Optional result or error message.