List 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[collection_name]=product/additional-instructions?filter[collection_name]=shipping
See: Pagination, Filtering
AuthorizationbearerAuth
Authorization
bearerAuth API token as bearer token — you receive a test and a live token, there is no switch between them. See Setup → Authentication and Setup → Test mode.
In: header
Query Parameters
Page number to return — see Basic Usage → Pagination.
1Number of objects per page (default 25, maximum 100) — see Basic Usage → Pagination.
value <= 10025List additional instructions for specified id(s). Several values are separated by comma, e.g. filter[id]=1,2,3.
List additional instructions for specified name, e.g. filter[name]=qui.
List additional instructions for a specified origin code — product or shipping.
Value in
- "product"
- "shipping"
Header Parameters
The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).
"application/json"Value in
- "application/json"
Response Body
application/json
application/json
curl -X GET "https://example.com/additional-instructions?filter%5Bid%5D=1&filter%5Bname%5D=qui&filter%5Bcollection_name%5D=product" \ -H "Accept: application/json"{ "data": [ { "id": 1, "name": "Apply promotional stickers", "price": 8, "collection_name": "product", "created_at": "2022-02-21T11:08:37+00:00", "updated_at": "2022-02-21T11:08:37+00:00" }, { "id": 2, "name": "Sticker on the package", "price": 10.2, "collection_name": "shipping", "created_at": "2022-02-21T11:08:37+00:00", "updated_at": "2022-02-21T11:08:37+00:00" } ], "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 }}