OrderLineItemTagRequirements

List order line item tag requirements

GET

https://api.gosmarter.ai

/api/company/{companyId}/order-line-item-tag-requirements

Returns all active required/preferred inventory-tag requirements for the company's order line items.

List order line item tag requirements › path Parameters

companyId

string · uuid · required

The unique identifier of the company

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

Active tag requirements

orderLineItemTagRequirementItemDto[]

orderLineItemTagRequirementItemDto

orderLineItemId

string · uuid

The order line item the requirement belongs to

tagId

string · uuid

The inventory tag required or preferred of the supplying stock

requirement

string

'Required' (hard constraint) or 'Preferred' (soft preference)

GET

https://api.gosmarter.ai

/api/company/{companyId}/order-line-items/{orderLineItemId}/tag-requirements

Returns the active required/preferred inventory-tag requirements of the specified order line item. Empty when the line item has none (or does not exist for the company).

companyId

string · uuid · required

The unique identifier of the company

orderLineItemId

string · uuid · required

The unique identifier of the order line item

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.

Active tag requirements of the line item

orderLineItemTagRequirementItemDto[]

orderLineItemTagRequirementItemDto

orderLineItemId

string · uuid

The order line item the requirement belongs to

tagId

string · uuid

The inventory tag required or preferred of the supplying stock

requirement

string

'Required' (hard constraint) or 'Preferred' (soft preference)

Set tag requirements for an order line item

PUT

https://api.gosmarter.ai

/api/company/{companyId}/order-line-items/{orderLineItemId}/tag-requirements

Replaces the required and preferred inventory-tag requirements of an order line item with the provided sets. Both lists must be supplied; pass empty lists to clear. A tag cannot be both required and preferred, and every tag must be an active inventory tag of the company.

Set tag requirements 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

Set tag requirements 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.

Set tag requirements for an order line item › Request Body

setTagRequirementsRequest

requiredTagIds

string[]

preferredTagIds

string[]

Set tag requirements for an order line item › Responses

The line item's active tag requirements after the change

orderLineItemTagRequirementItemDto[]

orderLineItemTagRequirementItemDto

orderLineItemId

string · uuid

The order line item the requirement belongs to

tagId

string · uuid

The inventory tag required or preferred of the supplying stock

requirement

string

'Required' (hard constraint) or 'Preferred' (soft preference)

PUT/api/company/{companyId}/order-line-items/{orderLineItemId}/tag-requirements

curl https://api.gosmarter.ai/api/company/:companyId/order-line-items/:orderLineItemId/tag-requirements \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "requiredTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "preferredTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Example Request Body

{
  "requiredTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "preferredTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

[
  {
    "orderLineItemId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "requirement": "requirement"
  }
]

json

application/json

Documentation Inventory v2

OrderLineItemTagRequirements

List order line item tag requirements

List order line item tag requirements › path Parameters

List order line item tag requirements › Headers

List order line item tag requirements › Responses

List tag requirements for an order line item

List tag requirements for an order line item › path Parameters

List tag requirements for an order line item › Headers

List tag requirements for an order line item › Responses

Set tag requirements for an order line item

Set tag requirements for an order line item › path Parameters

Set tag requirements for an order line item › Headers

Set tag requirements for an order line item › Request Body

Set tag requirements for an order line item › Responses