Endpoints
Additional Instructions
Smake Checkout API — Additional Instructions
The endpoint lists all available additional instructions that can be transferred in the endpoint variants/{id}/design.
List
Returns a collection of additional instructions.
Filtering
You can filter your results as follows:
List additional instructions for specified id(s)
/additional-instructions?filter[id]=1/additional-instructions?filter[id]=1,2,3
List additional instructions for specified name
/additional-instructions?filter[name]=qui
List additional instructions for a specified origin code
/additional-instructions?filter[type]=product/additional-instructions?filter[type]=shipping
See: Pagination, Filtering
Example
Request
GET /additional-instructions HTTP/1.1Response
{
"data": [
{
"id": 1,
"name": "Apply Marvel stickers",
"price": 8.0,
"type": "product"
},
{
"id": 2,
"name": "Sticker on the package",
"price": 10.2,
"type": "shipping"
}
...
],
"links": {
"first": "https://api.smake.io/v2/additional-instructions?page=1",
"last": null,
"prev": null,
"next": "https://api.smake.io/v2/additional-instructions?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.smake.io/v2/additional-instructions",
"per_page": 25,
"to": 25
}
}Get
Returns the additional instruction with the id = x.
Example
Request
GET /additional-instructions/1 HTTP/1.1Response
{
"id": 1,
"name": "Apply Marvel stickers",
"price": 8.0,
"type": "product"
}