Checkout Store Credit
Add Store Credit
POST https://yourstore.example.com/api/storefront/checkouts/{checkoutId}/store-creditRequest
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.
Parameters
- store_domain in path - string
Response
Body
object | application/json
dataobject
example
Remove Store Credit
DELETE https://yourstore.example.com/api/storefront/checkouts/{checkoutId}/store-creditRequest
Removes store credit from a checkout.
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.
Parameters
- store_domain in path - string
example
Response
Body
object | application/json
example
Did you find what you were looking for?