Add Store Credit

POST

https://your_store.example.com/api/storefront/checkouts/:checkoutId/store-credit

Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

This endpoint requires using Stencil CLI, a local session, and a CSRF token to work.

Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified. > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. > * This endpoint requires using Stencil CLI, a local session, and a CSRF token to work.

Path parameters

checkoutIdstringRequiredformat: "uuid"

The ID of the subject checkout. Identical to the cart ID.

Response

Returns the checkout object.

$	curl -X POST https://your_store.example.com/api/storefront/checkouts/checkoutId/store-credit \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"cartId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"currency": "USD",
4	"customerId": 987654,
5	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6	"items": [
7	{
8	"name": "Wireless Bluetooth Headphones",
9	"price": 100,
10	"productId": 12345,
11	"quantity": 1
12	}
13	],
14	"storeCreditApplied": 25,
15	"total": 75,
16	"updatedAt": "2024-06-15T12:00:00Z"
17	}

Note

Path parameters

Headers

Response

Note