List Commodity Codes for a Type

Learn about listing commodity codes for a type.

List commodity code for a type

EndpointMethodKey valueRequired fields
/config/v2/commodity-codes/{type}GETtypetype

This request returns a list of commodity codes available for a particular type ordered by code. You can filter by name using contains String Function. Case-insensitive search is supported.

For example:

contains(name, 'Iced tea').

Sample response - List commodity code for a type

{
  "commodityCodes": [
    {
      "type": "string",
      "code": "string",
      "name": "string",
      "userDefined": false,
      "mappings": [
        {
          "taxabilityCategoryId": "123e4567-e89b-12d3-a456-426614174000",
          "categoryName": "string",
          "categoryDescription": "string",
          "mappingNote": "string",
          "startDate": "2022-01-01",
          "endDate": "2022-12-31"
        }
      ]
    }
  ],
  "count": 0,
  "truncated": true
}