Create checkout session

POST

https://api.craftcart.io/api/v1/storefront/checkout/session

Last modified:2026-04-18 03:08:00

Storefront endpoint for headless commerce clients. Use x-storefront-token; optional scope via x-storefront-scope or scope query.

Request

Authorization

API Key

Add parameter in header

x-storefront-token

Example:

x-storefront-token: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200CreateCheckoutSessionResponse

application/json

Checkout session response

Body

🟠401ErrorResponse401

🟠404ErrorResponse404

🟠409ErrorResponse409

🟠422ErrorResponse422

🔴503ErrorResponse503

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.craftcart.io/api/v1/storefront/checkout/session' \
--header 'x-storefront-token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cartId": "cart_e9fd4b94d7f5d9b3",
    "customerEmail": "jane@example.com",
    "acceptsMarketing": true,
    "successUrl": "https://shop.example.com/checkout/success",
    "cancelUrl": "https://shop.example.com/cart"
}'

Response Example

200 - Success

{"success":true,"data":{"cart":{"id":"cart_e9fd4b94d7f5d9b3"},"checkoutSession":{"id":"cs_test_a1b2c3d4","url":"https://checkout.stripe.com/c/pay/cs_test_a1b2c3d4"}},"meta":{}}

Modified at 2026-04-18 03:08:00

Select shipping method

Confirm checkout session