SmakeSmake API Docs
EndpointsAdditional Instructions

Show an additional instruction

GET
/additional-instructions/{id}

Returns the additional instruction with the id = x.

AuthorizationbearerAuth

Authorization

bearerAuth
AuthorizationBearer <token>

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

Path Parameters

id*integer

The ID of the resource.

Header Parameters

Accept*"application/json"

The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).

Default"application/json"

Value in

  • "application/json"

Response Body

application/json

application/json

application/json

Request example
curl -X GET "https://example.com/additional-instructions/0" \  -H "Accept: application/json"
{  "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"}

List additional instructions GET

The endpoint lists all available additional instructions that can be transferred in the endpoint [variants/{id}/design](/docs/checkout/2022-02-01/endpoints/variants/designVariant). ## 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](/docs/checkout/2022-02-01/basic/pagination), [Filtering](/docs/checkout/2022-02-01/basic/filtering)

List customers GET

Fetching a list of customers. ## List Return a collection of customers. ### Filtering ##### List of customers for specific email(s) * `/customers?filter[email][email protected]` * `/customers?filter[email][email protected],[email protected]` ##### List of customers for specific external identifier(s) * `/customers?filter[external_identifier]=12345` * `/customers?filter[external_identifier]=12345,67890` See: [Pagination](/docs/checkout/2022-02-01/basic/pagination), [Filtering](/docs/checkout/2022-02-01/basic/filtering) This collection is **cursor paginated**: `links.first`/`links.last` are `null`, `links.next`/`links.prev` carry the cursor URLs and `meta` contains `next_cursor`/`prev_cursor` instead of `current_page`.