Skip to content

Latest commit

 

History

History
47 lines (42 loc) · 22.3 KB

customsitem.md

File metadata and controls

47 lines (42 loc) · 22.3 KB

CustomsItem

Example Usage

import { CustomsItem } from "shippo/models/components";

let value: CustomsItem = {
  description: "T-Shirt",
  massUnit: "lb",
  metadata: "Order ID \"123454\"",
  netWeight: "5",
  originCountry: "<value>",
  quantity: 20,
  skuCode: "HM-123",
  hsCode: "0901.21",
  valueAmount: "200",
  valueCurrency: "USD",
  objectCreated: new Date("2014-07-17T00:49:20.631Z"),
  objectId: "d799c2679e644279b59fe661ac8fa488",
  objectOwner: "[email protected]",
  objectUpdated: new Date("2014-07-17T00:49:20.631Z"),
};

Fields

Field Type Required Description Example
description string ✔️ Text description of your item. T-Shirt
eccnEar99 string ➖ Export Control Classification Number, required on some exports from the United States.
massUnit components.WeightUnitEnum ✔️ The unit used for weight. lb
metadata string ➖ A string of up to 100 characters that can be filled with any additional information you
want to attach to the object.		 Order ID "123454"
netWeight string ✔️ Total weight of this item, i.e. quantity * weight per item. 5
originCountry string ✔️ Country of origin of the item. Example: US or DE.
All accepted values can be found on the Official ISO Website.
quantity number ✔️ Quantity of this item in the shipment you send. Must be greater than 0. 20
skuCode string ➖ SKU code of the item, which is required by some carriers. HM-123
hsCode string ➖ 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. 0901.21
tariffNumber string ➖ 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.
valueAmount string ✔️ Total value of this item, i.e. quantity * value per item. 200
valueCurrency string ✔️ Currency used for value_amount. The official ISO 4217
currency codes are used, e.g. USD or EUR.		 USD
objectCreated Date ➖ Date and time of object creation. 2014-07-17T00:49:20.631Z
objectId string ➖ Unique identifier of the given object. d799c2679e644279b59fe661ac8fa488
objectOwner string ➖ Username of the user who created the object. [email protected]
objectState components.ObjectStateEnum ➖ Indicates the validity of the enclosing object
objectUpdated Date ➖ Date and time of last object update. 2014-07-17T00:49:20.631Z
test boolean ➖ Indicates whether the object has been created in test mode.