GOgoshippo
Customs Items

Retrieve a customs item

Changed on

Returns an existing customs item using an object ID

get/customs/items/{CustomsItemId}

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/customs/items/{CustomsItemId}
  • Auth
    API key in header Authorization

Path parameters

CustomsItemIdstring required

Object ID of the customs item

Query parameters

pageinteger

The page number you want to select

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Response

Customs item

descriptionstring required

Text description of your item.

eccn_ear99string

Export Control Classification Number, required on some exports from the United States.

eu_exempt_categoryboolean

Marks the item as belonging to an EU-exempt product category. Exempt items do not need product identifiers on shipments that meet the EU product identifier conditions (EU destination, non-EU origin, MERCHANDISE contents, recipient not a business).

manufacturer_codestring

Product identifier assigned by the manufacturer. Up to 100 characters; some carriers accept fewer and reject longer values at label purchase. Required together with sku_code on every non-exempt item when the shipment meets the EU product identifier conditions.

manufacturer_standard_codestring

Standardized product identifier such as a GTIN. Up to 100 characters. Never required, but recommended for EU-bound shipments when one exists.

mass_unit'g' | 'kg' | 'lb' | 'oz' required

The unit used for weight.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

net_weightstring required

Total weight of this item, i.e. quantity * weight per item.

origin_countrystring required

Country of origin of the item. Example: US or DE. All accepted values can be found on the Official ISO Website.

quantityinteger required

Quantity of this item in the shipment you send. Must be greater than 0.

sku_codestring

SKU or merchant-assigned product code of the item. Up to 100 characters; some carriers accept fewer and reject longer values at label purchase. Required together with manufacturer_code on every non-exempt item when the shipment meets the EU product identifier conditions; some carriers also use it outside the EU.

hs_codestring

HS code of the item, which is required by some carriers. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 50 character limit.

tariff_numberstring

The tariff number of the item. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 12 character limit.

value_amountstring required

Total value of this item, i.e. quantity * value per item.

value_currencystring required

Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. USD or EUR.

object_createdstring date-time

Date and time of object creation.

object_idstring

Unique identifier of the given object.

object_ownerstring

Username of the user who created the object.

object_state'VALID' | 'INVALID'

Indicates the validity of the enclosing object

object_updatedstring date-time

Date and time of last object update.

testboolean

Indicates whether the object has been created in test mode.

Example response

{
  "description": "T-Shirt",
  "manufacturer_code": "ACME-TS-001",
  "manufacturer_standard_code": "00012345678905",
  "mass_unit": "lb",
  "metadata": "Order ID \"123454\"",
  "net_weight": "5",
  "quantity": 20,
  "sku_code": "HM-123",
  "hs_code": "0901.21",
  "value_amount": "200",
  "value_currency": "USD",
  "object_created": "2014-07-17T00:49:20.631Z",
  "object_id": "d799c2679e644279b59fe661ac8fa488",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2014-07-17T00:49:20.631Z"
}

Changes

  • 0eab5a94b0c3Revision changes
    • info

      added the new optional header request parameter SHIPPO-ACCOUNT-ID

  • 76e3bda9c88bRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status