GoSmarter API Gateway

InventoryTags

Endpointhttps://api.gosmarter.ai

List all inventory tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags

Retrieves all inventory tags for the specified company, including usage counts.

List all inventory tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all inventory tags › Responses

List of inventory tags with usage counts

object[]

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

GET/api/company/{companyId}/tags

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/tags

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "usageCount": 0,
    "tagId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "color": "color",
    "description": "description"
  }
]

json

application/json

Create new inventory tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/tags

Creates a new inventory tag for the specified company.

Create new inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new inventory tag › Request Body

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Create new inventory tag › Responses

Tag created successfully

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

POST/api/company/{companyId}/tags

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/tags \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "color": "color",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "color": "color",
  "description": "description"
}

json

Example Responses

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Get inventory tag

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Retrieves a specific inventory tag by ID with usage count.

Get inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Get inventory tag › Responses

The inventory tag with usage count

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

GET/api/company/{companyId}/tags/{tagId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId

shell

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "usageCount": 0,
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Update inventory tag

PUT

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Updates an existing inventory tag. Changes to name and color will be reflected everywhere the tag appears.

Update inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Update inventory tag › Request Body

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Update inventory tag › Responses

Tag updated successfully

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

PUT/api/company/{companyId}/tags/{tagId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "color": "color",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "color": "color",
  "description": "description"
}

json

Example Responses

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Delete inventory tag

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Deletes an inventory tag. This will remove the tag from all inventory items and delete all associated rules. This action cannot be undone.

Delete inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Delete inventory tag › Responses

Tag deleted successfully

No data returned

DELETE/api/company/{companyId}/tags/{tagId}

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId

shell

Example Responses

No example specified for this content type

List inventory tag assignments

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-tag-assignments

Returns all tag assignments for inventory items in the specified company.

List inventory tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List inventory tag assignments › Responses

List of tag assignments

object[]

inventoryId

string · uuid

The inventory item identifier

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name

color

string

Hex color code for the tag

description

string

Optional description of the tag

GET/api/company/{companyId}/inventory-tag-assignments

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-tag-assignments

shell

Example Responses

[
  {
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "color": "color",
    "description": "description"
  }
]

json

application/json

Reference InventoryTagRules

GoSmarter API Gateway

InventoryTags

Endpointhttps://api.gosmarter.ai

List all inventory tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags

Retrieves all inventory tags for the specified company, including usage counts.

List all inventory tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all inventory tags › Responses

List of inventory tags with usage counts

object[]

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

GET/api/company/{companyId}/tags

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/tags

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "usageCount": 0,
    "tagId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "color": "color",
    "description": "description"
  }
]

json

application/json

Create new inventory tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/tags

Creates a new inventory tag for the specified company.

Create new inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new inventory tag › Request Body

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Create new inventory tag › Responses

Tag created successfully

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

POST/api/company/{companyId}/tags

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/tags \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "color": "color",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "color": "color",
  "description": "description"
}

json

Example Responses

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Get inventory tag

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Retrieves a specific inventory tag by ID with usage count.

Get inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Get inventory tag › Responses

The inventory tag with usage count

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

GET/api/company/{companyId}/tags/{tagId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId

shell

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "usageCount": 0,
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Update inventory tag

PUT

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Updates an existing inventory tag. Changes to name and color will be reflected everywhere the tag appears.

Update inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Update inventory tag › Request Body

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Update inventory tag › Responses

Tag updated successfully

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

PUT/api/company/{companyId}/tags/{tagId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "color": "color",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "color": "color",
  "description": "description"
}

json

Example Responses

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "color": "color",
  "description": "description"
}

json

application/json

Delete inventory tag

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Deletes an inventory tag. This will remove the tag from all inventory items and delete all associated rules. This action cannot be undone.

Delete inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Delete inventory tag › Responses

Tag deleted successfully

No data returned

DELETE/api/company/{companyId}/tags/{tagId}

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/tags/:tagId

shell

Example Responses

No example specified for this content type

List inventory tag assignments

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-tag-assignments

Returns all tag assignments for inventory items in the specified company.

List inventory tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List inventory tag assignments › Responses

List of tag assignments

object[]

inventoryId

string · uuid

The inventory item identifier

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name

color

string

Hex color code for the tag

description

string

Optional description of the tag

GET/api/company/{companyId}/inventory-tag-assignments

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-tag-assignments

shell

Example Responses

[
  {
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "color": "color",
    "description": "description"
  }
]

json

application/json

Reference InventoryTagRules