Commodities

class ab.api.endpoints.commodities.CommoditiesEndpoint(client)[source]

Commodity operations (ACPortal API).

Parameters:: client (HttpClient)

get(commodity_id)[source]

GET /commodity/{id}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodities/get.html Response model: Commodity

Parameters:: commodity_id (str)
Return type:: Commodity

update(commodity_id, *, data)[source]

PUT /commodity/{id}.

Parameters:

commodity_id (str) – Commodity identifier.
data (CommodityUpdateRequest | dict) – Commodity update payload with description, freight_class, nmfc_code. Accepts a CommodityUpdateRequest instance or a dict.

Return type:

Commodity

Request model: CommodityUpdateRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodities/update.html Request model: CommodityUpdateRequest Response model: Commodity

create(*, data)[source]

POST /commodity.

Parameters:: data (CommodityCreateRequest | dict) – Commodity creation payload with description, freight_class, nmfc_code, weight_min, weight_max. Accepts a CommodityCreateRequest instance or a dict.
Return type:: Commodity

Request model: CommodityCreateRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodities/create.html Request model: CommodityCreateRequest Response model: Commodity

search(*, data)[source]

POST /commodity/search.

Parameters:: data (CommoditySearchRequest | dict) – Search payload with search_text, page, page_size. Accepts a CommoditySearchRequest instance or a dict.
Return type:: list[Commodity]

Request model: CommoditySearchRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodities/search.html Request model: CommoditySearchRequest Response model: List[Commodity]

suggestions(*, data)[source]

POST /commodity/suggestions.

Parameters:: data (CommoditySuggestionRequest | dict) – Suggestion request payload with search_text. Accepts a CommoditySuggestionRequest instance or a dict.
Return type:: list[Commodity]

Request model: CommoditySuggestionRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodities/suggestions.html Request model: CommoditySuggestionRequest Response model: List[Commodity]

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.commodities.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

search / suggestions

POST /commodity/search and POST /commodity/suggestions — Search and suggest commodities.

Returns: list[Commodity]`

results = api.commodities.search(searchText="furniture")
suggestions = api.commodities.suggestions(searchText="chair")

get / create / update

Standard CRUD operations on commodity records.

Returns: Commodity

Commodity Maps

class ab.api.endpoints.commodity_maps.CommodityMapsEndpoint(client)[source]

Commodity map operations (ACPortal API).

Parameters:: client (HttpClient)

get(map_id)[source]

GET /commodity-map/{id}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodity_maps/get.html Response model: CommodityMap

Parameters:: map_id (str)
Return type:: CommodityMap

update(map_id, *, data)[source]

PUT /commodity-map/{id}.

Parameters:

map_id (str) – Commodity map identifier.
data (CommodityMapUpdateRequest | dict) – Commodity map update payload with custom_name, commodity_id. Accepts a CommodityMapUpdateRequest instance or a dict.

Return type:

CommodityMap

Request model: CommodityMapUpdateRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodity_maps/update.html Request model: CommodityMapUpdateRequest Response model: CommodityMap

delete(map_id)[source]

DELETE /commodity-map/{id}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodity_maps/delete.html Response model: ServiceBaseResponse

Parameters:: map_id (str)
Return type:: ServiceBaseResponse

create(*, data)[source]

POST /commodity-map.

Parameters:: data (CommodityMapCreateRequest | dict) – Commodity map creation payload with custom_name, commodity_id. Accepts a CommodityMapCreateRequest instance or a dict.
Return type:: CommodityMap

Request model: CommodityMapCreateRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodity_maps/create.html Request model: CommodityMapCreateRequest Response model: CommodityMap

search(*, data)[source]

POST /commodity-map/search.

Parameters:: data (CommodityMapSearchRequest | dict) – Search payload with search_text, page, page_size. Accepts a CommodityMapSearchRequest instance or a dict.
Return type:: list[CommodityMap]

Request model: CommodityMapSearchRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/commodity_maps/search.html Request model: CommodityMapSearchRequest Response model: List[CommodityMap]

Methods

search / get / create / update / delete

Standard CRUD operations on commodity mapping records.

Returns: CommodityMap

maps = api.commodity_maps.search(searchText="test")