GoSmarter API Gateway

InventoryTagRules

Endpointhttps://api.gosmarter.ai

List all inventory tag rules

GET

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules

Retrieves all inventory tag rules for the specified company, including linked tag information.

List all inventory tag rules › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all inventory tag rules › Responses

List of inventory tag rules

object[]

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

GET/api/company/{companyId}/tag-rules

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

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tagName": "tagName",
    "tagColor": "tagColor",
    "ruleId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "ruleJson": "ruleJson",
    "isActive": true
  }
]

json

application/json

Create new inventory tag rule

POST

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules

Creates a new inventory tag rule for the specified company. The rule will be automatically evaluated against existing inventory.

Create new inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new inventory tag rule › Request Body

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Create new inventory tag rule › Responses

Rule created successfully

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

POST/api/company/{companyId}/tag-rules

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}
'

shell

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Get inventory tag rule

GET

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Retrieves a specific inventory tag rule by ID with linked tag information.

Get inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Get inventory tag rule › Responses

The inventory tag rule

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

GET/api/company/{companyId}/tag-rules/{ruleId}

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

shell

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "tagName": "tagName",
  "tagColor": "tagColor",
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Update inventory tag rule

PUT

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Updates an existing inventory tag rule. The rule will be re-evaluated against all inventory items.

Update inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Update inventory tag rule › Request Body

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Update inventory tag rule › Responses

Rule updated successfully

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

PUT/api/company/{companyId}/tag-rules/{ruleId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules/:ruleId \
  --header 'Content-Type: application/json' \
  --data '
{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}
'

shell

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Delete inventory tag rule

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Deletes an inventory tag rule. This will remove all tag assignments that were created by this rule. This action cannot be undone.

Delete inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Delete inventory tag rule › Responses

Rule deleted successfully

No data returned

DELETE/api/company/{companyId}/tag-rules/{ruleId}

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules/:ruleId

shell

Example Responses

No example specified for this content type

InventoryTags Entitlements

GoSmarter API Gateway

InventoryTagRules

Endpointhttps://api.gosmarter.ai

List all inventory tag rules

GET

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules

Retrieves all inventory tag rules for the specified company, including linked tag information.

List all inventory tag rules › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all inventory tag rules › Responses

List of inventory tag rules

object[]

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

GET/api/company/{companyId}/tag-rules

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

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tagName": "tagName",
    "tagColor": "tagColor",
    "ruleId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "ruleJson": "ruleJson",
    "isActive": true
  }
]

json

application/json

Create new inventory tag rule

POST

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules

Creates a new inventory tag rule for the specified company. The rule will be automatically evaluated against existing inventory.

Create new inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new inventory tag rule › Request Body

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Create new inventory tag rule › Responses

Rule created successfully

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

POST/api/company/{companyId}/tag-rules

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}
'

shell

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Get inventory tag rule

GET

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Retrieves a specific inventory tag rule by ID with linked tag information.

Get inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Get inventory tag rule › Responses

The inventory tag rule

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

GET/api/company/{companyId}/tag-rules/{ruleId}

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

shell

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "tagName": "tagName",
  "tagColor": "tagColor",
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Update inventory tag rule

PUT

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Updates an existing inventory tag rule. The rule will be re-evaluated against all inventory items.

Update inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Update inventory tag rule › Request Body

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Update inventory tag rule › Responses

Rule updated successfully

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description of the rule's purpose

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

PUT/api/company/{companyId}/tag-rules/{ruleId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules/:ruleId \
  --header 'Content-Type: application/json' \
  --data '
{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}
'

shell

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

application/json

Delete inventory tag rule

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/tag-rules/{ruleId}

Deletes an inventory tag rule. This will remove all tag assignments that were created by this rule. This action cannot be undone.

Delete inventory tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Delete inventory tag rule › Responses

Rule deleted successfully

No data returned

DELETE/api/company/{companyId}/tag-rules/{ruleId}

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/tag-rules/:ruleId

shell

Example Responses

No example specified for this content type

InventoryTags Entitlements