api.commodities.suggestions

POST /commodity/suggestions — ACPortal

Python

api.commodities.suggestions(*, data: CommoditySuggestionRequest | dict) -> list[Commodity]

CLI

ab commodities suggestions [--data ...]

POST /commodity/suggestions.

Args: data: Suggestion request payload with search_text. Accepts a :class:CommoditySuggestionRequest instance or a dict.

Request model: :class:CommoditySuggestionRequest

Request body — CommoditySuggestionRequest

Field

Type

Required

Description

searchText

Optional[str]

no

Free-text search query

Response

Returns a list of List[Commodity].

Field

Type

Required

Description

id

Optional[str]

no

Commodity ID

description

Optional[str]

no

Commodity description

freightClass

Optional[str]

no

Freight class

nmfcCode

Optional[str]

no

NMFC code

weightMin

Optional[float]

no

Minimum weight

weightMax

Optional[float]

no

Maximum weight


← Back to api.commodities