{
"opencollection": "1.0.0",
"info": {
"name": "Admin Account / Address Store Credits API",
"version": "v3"
},
"items": [
{
"info": {
"name": "Store Credits",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of Store Credits",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://{defaultHost}/api/v2/platform/store_credits",
"params": [
{
"name": "page",
"value": "1",
"type": "query"
},
{
"name": "per_page",
"value": "50",
"type": "query"
},
{
"name": "include",
"value": "user,created_by,category,credit_type",
"type": "query",
"description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes"
},
{
"name": "filter[user_id_eq]",
"value": "5",
"type": "query"
},
{
"name": "filter[created_by_id_eq]",
"value": "2",
"type": "query"
},
{
"name": "filter[amount_gteq]",
"value": "50.0",
"type": "query"
},
{
"name": "filter[currency_eq]",
"value": "USD",
"type": "query"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of Store Credits"
},
{
"info": {
"name": "Create a Store Credit",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://{defaultHost}/api/v2/platform/store_credits",
"params": [
{
"name": "include",
"value": "user,created_by,category,credit_type",
"type": "query",
"description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a Store Credit"
},
{
"info": {
"name": "Return a Store Credit",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://{defaultHost}/api/v2/platform/store_credits/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "include",
"value": "user,created_by,category,credit_type",
"type": "query",
"description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a Store Credit"
},
{
"info": {
"name": "Update a Store Credit",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://{defaultHost}/api/v2/platform/store_credits/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "include",
"value": "user,created_by,category,credit_type",
"type": "query",
"description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates a Store Credit"
},
{
"info": {
"name": "Delete a Store Credit",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://{defaultHost}/api/v2/platform/store_credits/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a Store Credit"
}
]
}
],
"bundled": true
}