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
chevron-right
200

OK

application/json
idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
created_atstring · date-timeRequired

When the tag was created

namestringRequired

The unique name for the tag.

slugstringRequired

The unique slug for the tag.

descriptionstring · nullableOptional

The description of the tag.

image_urlstring · nullableOptional

The Image URL associated with the tag.

enabledbooleanRequired

Indicates whether this tag is enabled.

updated_atstring · nullableOptional

When the tag was last updated.

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
namestring · nullableOptional
slugstring · nullableOptional
descriptionstring · nullableOptional
enabledboolean · nullableOptional
Responses
chevron-right
200

OK

application/json
idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
created_atstring · date-timeRequired

When the tag was created

namestringRequired

The unique name for the tag.

slugstringRequired

The unique slug for the tag.

descriptionstring · nullableOptional

The description of the tag.

image_urlstring · nullableOptional

The Image URL associated with the tag.

enabledbooleanRequired

Indicates whether this tag is enabled.

updated_atstring · nullableOptional

When the tag was last updated.

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
chevron-right
200

OK

application/json
idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
created_atstring · date-timeRequired

When the tag was created

namestringRequired

The unique name for the tag.

slugstringRequired

The unique slug for the tag.

descriptionstring · nullableOptional

The description of the tag.

image_urlstring · nullableOptional

The Image URL associated with the tag.

enabledbooleanRequired

Indicates whether this tag is enabled.

updated_atstring · nullableOptional

When the tag was last updated.

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
namestring · nullableOptional
slugstring · nullableOptional
descriptionstring · nullableOptional
enabledboolean · nullableOptional
Responses
chevron-right
200

OK

application/json
idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
created_atstring · date-timeRequired

When the tag was created

namestringRequired

The unique name for the tag.

slugstringRequired

The unique slug for the tag.

descriptionstring · nullableOptional

The description of the tag.

image_urlstring · nullableOptional

The Image URL associated with the tag.

enabledbooleanRequired

Indicates whether this tag is enabled.

updated_atstring · nullableOptional

When the tag was last updated.

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
chevron-right
200

OK

application/json
idstringRequired

The ID of the direct image upload URL.

upload_urlstringRequired

The URL to upload the image to.

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?