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
GET /v1/stores/{storeId}/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "created_at": "2025-11-19T15:40:12.562Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "name": "text",
    "slug": "text",
    "description": "text",
    "image_url": "text",
    "enabled": true,
    "updated_at": "2025-11-19T15:40:12.562Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

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
200

OK

application/json
post
/v1/stores/{storeId}/tags
POST /v1/stores/{storeId}/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": "text",
  "slug": "text",
  "description": "text",
  "enabled": true
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "created_at": "2025-11-19T15:40:12.562Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "name": "text",
  "slug": "text",
  "description": "text",
  "image_url": "text",
  "enabled": true,
  "updated_at": "2025-11-19T15:40:12.562Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

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}
GET /v1/stores/{storeId}/tags/{tagId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "created_at": "2025-11-19T15:40:12.562Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "name": "text",
  "slug": "text",
  "description": "text",
  "image_url": "text",
  "enabled": true,
  "updated_at": "2025-11-19T15:40:12.562Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

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}
DELETE /v1/stores/{storeId}/tags/{tagId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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
200

OK

application/json
patch
/v1/stores/{storeId}/tags/{tagId}
PATCH /v1/stores/{storeId}/tags/{tagId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": "text",
  "slug": "text",
  "description": "text",
  "enabled": true
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "created_at": "2025-11-19T15:40:12.562Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "name": "text",
  "slug": "text",
  "description": "text",
  "image_url": "text",
  "enabled": true,
  "updated_at": "2025-11-19T15:40:12.562Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

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
GET /v1/stores/{storeId}/tags/{tagId}/image-upload-url HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "upload_url": "text"
}

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
POST /v1/stores/{storeId}/tags/{tagId}/image-upload-finish HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "image_id": "text"
}
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
DELETE /v1/stores/{storeId}/tags/{tagId}/image HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousSubscriptionsNextTrials

Last updated

Was this helpful?