Skip to main content
GET
/
commodityList
Get commodities available in the system
curl --request GET \
  --url https://app.coverwhale.com/api/v1/commodityList \
  --header 'Accept: <accept>' \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: <content-type>'
{
  "status": "success",
  "commodities": "['agricultural_equipment': 'Agricultural Equipment', 'alcoholic_beverages': 'Alcoholic beverages (except beer and wine)', 'appliances': 'Appliances (except TV and stereos)', 'arms_ammunition_fireworks': 'Arms, ammunition, fireworks']"
}

Authorizations

​
AccessToken
string
header
required

AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.

Headers

​
Content-Type
string
required
​
Accept
string
required
​
AccessToken
string
required

Response

return list of commodities

​
status
string

Status of the request (success)

​
commodities
string[]

list of all commodities stored