Skip to main content

Create a Checkout URL

Use this guide to dynamically build URLs that generate Simpler checkout carts.

Not for replacing your checkout

Checkout URLs are meant for links — for example in campaigns, emails or banners — and as a fallback when the cart request fails. To replace your store's native checkout, use Replacing Checkout.

1. Base URL​

All checkout URLs start with:

https://checkout.simpler.so/

2. Required Parameters​

ParameterTypeDescription
appUUIDYour App ID (placeholder: 00000000-0000-0000-0000-000000000000).
prdJSONURL-encoded JSON array of product objects (see below).
curString3-letter ISO currency code (e.g. EUR, USD).

2.1. prd Array Format​

prd is the URL-encoded JSON string of an array of products. Each product object must include:

  • id (string): The product identifier. This is either the internal product ID or the SKU, depending on your integration.
  • qty (integer): quantity
  • attrs (object): optional attribute map (e.g. size, edition). If attributes are omitted and the product requested has attributes, the URL will lead to an options selection page before checkout.

Example JSON:

[
{ "id":"67", "qty":1, "attrs":{ "attribute_size":"" } },
{ "id":"93", "qty":1, "attrs":{ "attribute_edition":"Digital", "attribute_pa_color":"" } },
{ "id":"33", "qty":2, "attrs":{} }
]

3. Optional Parameters​

ParameterTypeDescription
langStringLanguage code (e.g. en, fr) or locale (e.g. en_US, fr_FR).
cpnStringCoupon code (e.g. SUMMER21).
rlcStringRemote loyalty coupon code, pre-selected on your own site (e.g. SHOE10). See Remote Loyalty Coupons.
sourceStringOrigin of checkout (e.g. cart_page).
metadataJSONFree-form JSON object (e.g. utm_medium).

4. Example URLs​

4.1. One-Line Example​

https://checkout.simpler.so/?app=00000000-0000-0000-0000-000000000000&prd=[{"id":"67","qty":1,"attrs":{"attribute_size":""}},{"id":"93","qty":1,"attrs":{"attribute_edition":"Digital","attribute_pa_color":""}},{"id":"33","qty":2,"attrs":{}}]&cur=EUR&lang=en_US&source=cart_page&cpn=SUMMER21&metadata={"utm_medium":"Simpler"}

4.2. Pretty-Printed Example​

https://checkout.simpler.so/?
app=00000000-0000-0000-0000-000000000000&
prd=[
{"id":"67","qty":1,"attrs":{"attribute_size":""}},
{"id":"93","qty":1,"attrs":{"attribute_edition":"Digital","attribute_pa_color":""}},
{"id":"33","qty":2,"attrs":{}}
]&
cur=EUR&
lang=en_US&
source=cart_page&
cpn=SUMMER21&
metadata={"utm_medium":"Simpler"}

5. Verify​

Visit the URL in your browser and verify that it is correct. You should be seeing Simpler's Checkout with the options you specified (coupon*, language, products etc).

info

Coupon

Coupons may not be available based on their validity and availability. If you are using coupons, ensure you have the correct coupon code and that it is valid for the current order.