Returns a list of Adjustments
curl --request GET \
--url http://{defaultHost}/api/v2/platform/adjustments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.732Z",
"updated_at": "2022-11-08T19:33:53.732Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "2",
"type": "order"
}
},
"source": {
"data": {
"id": "1",
"type": "tax_rate"
}
}
}
},
{
"id": "2",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.754Z",
"updated_at": "2022-11-08T19:33:53.754Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "3",
"type": "order"
}
},
"source": {
"data": {
"id": "2",
"type": "tax_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/adjustments?page=1&per_page=&include=&filter[order_id]=",
"next": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page="
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Records returned
The response is of type object
.
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/adjustments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.732Z",
"updated_at": "2022-11-08T19:33:53.732Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "2",
"type": "order"
}
},
"source": {
"data": {
"id": "1",
"type": "tax_rate"
}
}
}
},
{
"id": "2",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.754Z",
"updated_at": "2022-11-08T19:33:53.754Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "3",
"type": "order"
}
},
"source": {
"data": {
"id": "2",
"type": "tax_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/adjustments?page=1&per_page=&include=&filter[order_id]=",
"next": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page="
}
}
Returns a list of Adjustments
curl --request GET \
--url http://{defaultHost}/api/v2/platform/adjustments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.732Z",
"updated_at": "2022-11-08T19:33:53.732Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "2",
"type": "order"
}
},
"source": {
"data": {
"id": "1",
"type": "tax_rate"
}
}
}
},
{
"id": "2",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.754Z",
"updated_at": "2022-11-08T19:33:53.754Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "3",
"type": "order"
}
},
"source": {
"data": {
"id": "2",
"type": "tax_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/adjustments?page=1&per_page=&include=&filter[order_id]=",
"next": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page="
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Records returned
The response is of type object
.
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/adjustments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.732Z",
"updated_at": "2022-11-08T19:33:53.732Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "2",
"type": "order"
}
},
"source": {
"data": {
"id": "1",
"type": "tax_rate"
}
}
}
},
{
"id": "2",
"type": "adjustment",
"attributes": {
"source_type": "Spree::TaxRate",
"adjustable_type": "Spree::Order",
"amount": "100.0",
"label": "Shipping",
"mandatory": null,
"eligible": true,
"created_at": "2022-11-08T19:33:53.754Z",
"updated_at": "2022-11-08T19:33:53.754Z",
"state": "open",
"included": false,
"display_amount": "$100.00"
},
"relationships": {
"order": {
"data": {
"id": "1",
"type": "order"
}
},
"adjustable": {
"data": {
"id": "3",
"type": "order"
}
},
"source": {
"data": {
"id": "2",
"type": "tax_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/adjustments?page=1&per_page=&include=&filter[order_id]=",
"next": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page="
}
}