Skip to main content

Shipment Contents

Within the query parameter, the goods_described group specifically targets both the description of the shipment's contents, along with any alphanumeric markings found on the shipping container itself.

{
  "data_source": "global",
  "query": {
    "group": ["goods_described"]
    "text": "clothing"
  }
}
tip

To search against only the description of the shipment's contents, use a custom_group with just the commodity_description field specified.

Custom Group Example

Use a custom_group with just the commodity_description field specified

{
  "data_source": "global",
  "query": {
    "custom_group": ["commodity_description"]
    "text": "clothing"
  }
}

Shipment Description Granularity​

Depending on the data-source of the shipment, descriptions may be available for the unique items within the shipping container or just for the whole container itself. Depending on the data available, the returned shipping record may have a single description or an array of associated items and descriptions.

tip

Review the Shipment Entity Schema for more information regarding the Shipping Record's format.