api.commodity_maps.create

POST /commodity-map — ACPortal

Python

api.commodity_maps.create(*, data: CommodityMapCreateRequest | dict) -> CommodityMap

CLI

ab commodity_maps create [--data ...]

POST /commodity-map.

Args: data: Commodity map creation payload with custom_name, commodity_id. Accepts a :class:CommodityMapCreateRequest instance or a dict.

Request model: :class:CommodityMapCreateRequest

Request body — CommodityMapCreateRequest

Field

Type

Required

Description

customName

Optional[str]

no

Custom commodity name

commodityId

Optional[str]

no

Linked commodity ID

Response

Returns CommodityMap.

Field

Type

Required

Description

id

Optional[str]

no

Map ID

customName

Optional[str]

no

Custom commodity name

commodityId

Optional[str]

no

Linked commodity ID


← Back to api.commodity_maps