Tags

Get all tags for a store

get
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/tags

Create a new tag

post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
namenull | stringOptional
slugnull | stringOptional
descriptionnull | stringOptional
enablednull | booleanOptional
Responses
200

OK

application/json
post
/v1/stores/{storeId}/tags

Get a tag by an ID

get
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/tags/{tagId}

Delete a tag by ID

delete
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Responses
delete
/v1/stores/{storeId}/tags/{tagId}

No content

Update a tag by ID

patch
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Body
namenull | stringOptional
slugnull | stringOptional
descriptionnull | stringOptional
enablednull | booleanOptional
Responses
200

OK

application/json
patch
/v1/stores/{storeId}/tags/{tagId}

Get upload URL for tag image

get

Gets a pre-signed upload URL for uploading an image to a tag

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/tags/{tagId}/image-upload-url

Finish tag image upload

post

Finishes an image upload for a tag

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Body
image_idstringRequired

The ID of the uploaded image returned by the server.

Responses
post
/v1/stores/{storeId}/tags/{tagId}/image-upload-finish

No content

Delete tag image

delete

Deletes an image for a tag

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
tagIdstring · flake-idRequiredExample: 411486491630370816
Responses
delete
/v1/stores/{storeId}/tags/{tagId}/image

No content

Last updated

Was this helpful?