OrderTags

List all order tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/order-tags

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

List all order tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all order tags › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List all order tags › Responses

List of order tags with usage counts

metaOrderTagDto[]

metaOrderTagDto

usageCount

integer · int32

Number of orders currently assigned this tag

createdAt

string · date-time

updatedAt

string · date-time

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

description

string

Optional description

active

boolean

Whether the tag is active (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this tag

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

Create new order tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/order-tags

Creates a new order tag for the specified company. Returns 409 Conflict if a soft-deleted tag with the same name already exists.

Create new order tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new order tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Create new order tag › Request Body

createOrderTagDto

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag

description

string

Optional description

Create new order tag › Responses

Tag created successfully

orderTagDto

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

description

string

Optional description

active

boolean

Whether the tag is active (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this tag

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

POST/api/company/{companyId}/order-tags

curl https://api.gosmarter.ai/api/company/:companyId/order-tags \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "color": "color",
  "description": "description"
}'

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",
  "active": true,
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "isSystemTag": true,
  "severity": "severity"
}

json

application/json

Update order tag

PUT

https://api.gosmarter.ai

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

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

Update order tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Update order tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update order tag › Request Body

createOrderTagDto

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag

description

string

Optional description

Update order tag › Responses

Tag updated successfully

orderTagDto

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

description

string

Optional description

active

boolean

Whether the tag is active (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this tag

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

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

curl https://api.gosmarter.ai/api/company/:companyId/order-tags/:tagId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "color": "color",
  "description": "description"
}'

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",
  "active": true,
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "isSystemTag": true,
  "severity": "severity"
}

json

application/json

Soft-delete order tag

DELETE

https://api.gosmarter.ai

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

Soft-deletes an order tag. The tag is marked inactive and hidden from the tag list. Deleted tags can be restored via POST /company/{companyId}/order-tags/{tagId}/restore.

Soft-delete order tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Soft-delete order tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Soft-delete order tag › Responses

Tag soft-deleted successfully

No data returned

Get order tag change history

GET

https://api.gosmarter.ai

/api/company/{companyId}/order-tags/{tagId}/history

Returns the full temporal audit history for an order tag, most recent changes first.

Get order tag change history › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Get order tag change history › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get order tag change history › Responses

Audit history returned successfully

auditEventDto[]

auditEventDto

changedAt

string · date-time

changedById

string · uuid

changedByName

string

changeType

string

auditFieldChange[]

entityType

string

entityLabel

string

List deleted order tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/order-tags/deleted

Retrieves all soft-deleted order tags for the specified company.

List deleted order tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List deleted order tags › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List deleted order tags › Responses

List of soft-deleted order tags

metaOrderTagDto[]

metaOrderTagDto

usageCount

integer · int32

Number of orders currently assigned this tag

createdAt

string · date-time

updatedAt

string · date-time

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

description

string

Optional description

active

boolean

Whether the tag is active (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this tag

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

Restore soft-deleted order tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/order-tags/{tagId}/restore

Restores a soft-deleted order tag so it can be used again.

Restore soft-deleted order tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag to restore

Restore soft-deleted order tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Restore soft-deleted order tag › Responses

Tag restored successfully

orderTagDto

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

description

string

Optional description

active

boolean

Whether the tag is active (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this tag

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

List order tag assignments

GET

https://api.gosmarter.ai

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

Returns all tag assignments for orders in the specified company.

List order tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List order tag assignments › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List order tag assignments › Responses

List of tag assignments

orderTagAssignmentTagDto[]

orderTagAssignmentTagDto

orderId

string · uuid

The order 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

assignedByRuleId

string · uuid

Rule that assigned this tag (null if manually assigned)

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/orders/{orderId}/tags

Returns all tag assignments for the specified order.

companyId

string · uuid · required

The unique identifier of the company

orderId

string · uuid · required

The unique identifier of the order

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Tag assignments for the order

orderTagAssignmentTagDto[]

orderTagAssignmentTagDto

orderId

string · uuid

The order 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

assignedByRuleId

string · uuid

Rule that assigned this tag (null if manually assigned)

isSystemTag

boolean

True for tags provisioned by a subscribed Rule Pack

severity

string

Rule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags

Set manual tag assignments

PUT

https://api.gosmarter.ai

/api/company/{companyId}/orders/{orderId}/tags/manual

Replaces all manual tag assignments for an order with the provided set. Rule-based assignments are not affected. Pass an empty list to clear all manual tags.

Set manual tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

orderId

string · uuid · required

The unique identifier of the order

Set manual tag assignments › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Set manual tag assignments › Request Body

setManualTagsRequest

tagIds

string[]

Set manual tag assignments › Responses

Updated manual tag assignments

orderTagAssignmentDto[]

orderTagAssignmentDto

assignmentId

string · uuid

Unique identifier for the assignment

orderId

string · uuid

Order identifier

tagId

string · uuid

Tag identifier

assignedByRuleId

string · uuid

Rule that assigned this tag (null if manual)

assignedAt

string · date-time

Timestamp when the tag was assigned (UTC)

PUT/api/company/{companyId}/orders/{orderId}/tags/manual

curl https://api.gosmarter.ai/api/company/:companyId/orders/:orderId/tags/manual \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Example Request Body

{
  "tagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

[
  {
    "assignmentId": "00000000-0000-0000-0000-000000000000",
    "orderId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "assignedByRuleId": "00000000-0000-0000-0000-000000000000",
    "assignedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Organisations OrderTagRules

OrderTags

List all order tags

List all order tags › path Parameters

List all order tags › Headers

List all order tags › Responses

Create new order tag

Create new order tag › path Parameters

Create new order tag › Headers

Create new order tag › Request Body

Create new order tag › Responses

Update order tag

Update order tag › path Parameters

Update order tag › Headers

Update order tag › Request Body

Update order tag › Responses

Soft-delete order tag

Soft-delete order tag › path Parameters

Soft-delete order tag › Headers

Soft-delete order tag › Responses

Get order tag change history

Get order tag change history › path Parameters

Get order tag change history › Headers

Get order tag change history › Responses

List deleted order tags

List deleted order tags › path Parameters

List deleted order tags › Headers

List deleted order tags › Responses

Restore soft-deleted order tag

Restore soft-deleted order tag › path Parameters

Restore soft-deleted order tag › Headers

Restore soft-deleted order tag › Responses

List order tag assignments

List order tag assignments › path Parameters

List order tag assignments › Headers

List order tag assignments › Responses

List tag assignments for an order

List tag assignments for an order › path Parameters

List tag assignments for an order › Headers

List tag assignments for an order › Responses

Set manual tag assignments

Set manual tag assignments › path Parameters

Set manual tag assignments › Headers

Set manual tag assignments › Request Body

Set manual tag assignments › Responses