Skip to main content
PATCH
/
api
/
v2
/
platform
/
orders
/
{id}
/
use_store_credit
Use Store Credit for an Order
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/orders/{id}/use_store_credit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123
}'
{
  "error": "The access token is invalid"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
​
amount
number

Response

store credit payment created