CustomsInfo

Information for the processing of customs

  • contents_explanation
    Type: string

    Human readable description of content, max 255 characters. Required for certain carriers and always required if contents_type is 'other'

  • contents_type
    Type: stringenum

    Possible values:

    values
    • documents
    • gift
    • merchandise
    • returned_goods
    • sample
    • dangerous_goods
    • humanitarian_donation
    • other
  • customs_certify
    Type: boolean

    Electronically certify the information provided

  • customs_items
    Type: array object[] ยท CustomsItem[]

    Describes products being shipped

    An item included in the shipment for customs declaration purposes

    • description
      Type: string
      required

      Description of item being shipped

    • quantity
      Type: integer
      required

      Must be greater than zero

    • value
      Type: number
      required

      Total value (unit value * quantity). Must be greater than zero

    • weight
      Type: number
      required

      Total weight (unit weight * quantity). Must be greater than zero

    • code
      Type: string

      SKU, UPC or other product identifier

    • currency
      Type: string

      Three-character currency code. Defaults to 'USD'

    • eccn
      Type: string
    • hs_tariff_number
      Type: string

      Harmonized Tariff Schedule (https://hts.usitc.gov/) code used to classify goods for customs declarations. Typically 6 or 10 digits

    • id
      Type: string

      Unique, begins with 'cstitem_'

    • manufacturer
      Type: string

      Manufacturer of item

    • origin_country
      Type: string

      Two-character country code

    • printed_commodity_identifier
      Type: string

      International commodity code (https://www.gov.uk/guidance/finding-commodity-codes-for-imports-or-exports#what-a-commodity-code-is)

  • customs_signer
    Type: string

    Required if customs_certify is true

  • eel_pfc
    Type: string

    When shipping outside the US, you must provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which one you need depends on the value of the goods:

    • If the value is less than $2,500, pass the EEL code: NOEEI 30.37(a).
    • If the value is greater than $2,500, you must obtain an Automated Export System (AES) Internal Transaction Number (ITN) from AESDirect, e.g. AES X20120502123456.

    An ITN is required for any international shipment valued over $2,500 and/or requiring an export license unless an exemption applies.

    Note: The maximum number of items that can be included in customs_info with UPS is 100

  • id
    Type: string

    Unique, begins with 'cstinfo_'

  • non_delivery_option
    Type: stringenum

    Possible values:

    values
    • abandon
    • return
  • restriction_comments
    Type: string | null

    Required if restriction_type is not 'none'

  • restriction_type
    Type: stringenum

    Possible values:

    values
    • none
    • quarantine
    • sanitary_phytosanitary_inspection
    • other