GoSmarter Logo
GoSmarter API Gateway
GoSmarter API Gateway

OrderLineItemTags

List all order line item tags

GET
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags

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

List all order line item tags › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

List all order line item 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 line item tags › Responses

List of order line item tags with usage counts

metaOrderLineItemTagDto
usageCount
​integer · int32

Number of line items 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 line item tag

POST
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags

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

Create new order line item tag › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Create new order line item 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 line item tag › Request Body

createOrderLineItemTagDto
name
​string

Tag name (must be unique within company)

color
​string

Hex color code for the tag

description
​string

Optional description

Create new order line item tag › Responses

Tag created successfully

orderLineItemTagDto
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

Update order line item tag

PUT
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags/{tagId}

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

Update order line item 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 line item 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 line item tag › Request Body

createOrderLineItemTagDto
name
​string

Tag name (must be unique within company)

color
​string

Hex color code for the tag

description
​string

Optional description

Update order line item tag › Responses

Tag updated successfully

orderLineItemTagDto
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

Soft-delete order line item tag

DELETE
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags/{tagId}

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

Soft-delete order line item 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 line item 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 line item tag › Responses

Tag soft-deleted successfully

No data returned

Get order line item tag change history

GET
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags/{tagId}/history

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

Get order line item 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 line item 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 line item tag change history › Responses

Audit history returned successfully

auditEventDto
changedAt
​string · date-time
changedById
​string · uuid
changedByName
​string
changeType
​string
entityType
​string
entityLabel
​string

List deleted order line item tags

GET
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags/deleted

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

List deleted order line item tags › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

List deleted order line item 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 line item tags › Responses

List of soft-deleted order line item tags

metaOrderLineItemTagDto
usageCount
​integer · int32

Number of line items 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 line item tag

POST
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tags/{tagId}/restore

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

Restore soft-deleted order line item 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 line item 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 line item tag › Responses

Tag restored successfully

orderLineItemTagDto
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 line item tag assignments

GET
https://api.gosmarter.ai
/api/company/{companyId}/order-line-item-tag-assignments

Returns all tag assignments for order line items in the specified company.

List order line item tag assignments › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

List order line item 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 line item tag assignments › Responses

List of tag assignments

orderLineItemTagAssignmentTagDto
orderLineItemId
​string · uuid

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

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

List order line item tag assignments for an order

GET
https://api.gosmarter.ai
/api/company/{companyId}/orders/{orderId}/line-item-tags

Returns tag assignments for all active line items belonging to the specified order.

List order line item tag assignments for an order › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

orderId
​string · uuid · required

The unique identifier of the order

List order line item tag assignments for an order › 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 line item tag assignments for an order › Responses

Tag assignments for the order's line items

orderLineItemTagAssignmentTagDto
orderLineItemId
​string · uuid

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

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

List tag assignments for an order line item

GET
https://api.gosmarter.ai
/api/company/{companyId}/order-line-items/{orderLineItemId}/tags

Returns all tag assignments for the specified order line item.

List tag assignments for an order line item › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

orderLineItemId
​string · uuid · required

The unique identifier of the order line item

List tag assignments for an order line item › 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 tag assignments for an order line item › Responses

Tag assignments for the line item

orderLineItemTagAssignmentTagDto
orderLineItemId
​string · uuid

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

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

OrderTagRulesOrderLineItemTagRules