{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-customs-v3-schema.json",
  "title": "Customs",
  "description": "Customs object: the description of customs information",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aftership-labels-api-openapi.yml#/components/schemas/Customs.v3",
  "x-stoplight": {
    "id": "11cjtizuozw2n"
  },
  "type": "object",
  "x-tags": [
    "Primitive"
  ],
  "required": [
    "purpose"
  ],
  "properties": {
    "purpose": {
      "type": "string",
      "enum": [
        "gift",
        "merchandise",
        "personal",
        "sample",
        "return",
        "repair",
        "non-merchandise"
      ]
    },
    "terms_of_trade": {
      "type": "string",
      "enum": [
        "dat",
        "ddu",
        "ddp",
        "dap",
        "exw",
        "fca",
        "fob",
        "cip",
        "cif",
        "cpt",
        "cfr",
        "dpu"
      ]
    },
    "eei": {
      "description": "EEI",
      "oneOf": [
        {
          "$ref": "#/$defs/Aes.v3"
        },
        {
          "$ref": "#/$defs/No_eei.v3"
        }
      ]
    },
    "billing": {
      "$ref": "#/$defs/Billing.v3"
    },
    "importer_address": {
      "$ref": "#/$defs/Address.v3"
    },
    "broker_address": {
      "$ref": "#/$defs/Address.v3",
      "x-stoplight": {
        "id": "8djt33ak5cn15"
      }
    },
    "passport": {
      "type": "object",
      "description": "Passport Object",
      "properties": {
        "number": {
          "type": "string",
          "description": "Passport Number"
        },
        "issue_date": {
          "type": "string",
          "description": "Issue Date in YYYY-MM-DD"
        }
      }
    },
    "additional_charges": {
      "type": "array",
      "description": "This array contains additional_charges object. Additional charge to be added to the commercial invoice of this shipment. Only applies to FedEx, DHL Express, UPS currently.",
      "x-stoplight": {
        "id": "qt0kscrrlaouw"
      },
      "maxItems": 3,
      "items": {
        "x-stoplight": {
          "id": "6tyw0klcpr1cu"
        },
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "x-stoplight": {
              "id": "49qh2pv3p384p"
            },
            "enum": [
              "insurance",
              "freight",
              "other"
            ]
          },
          "charge": {
            "$ref": "#/$defs/Money.v3",
            "description": "Money object: additional charge to be added to the commercial invoice of this shipment.",
            "x-stoplight": {
              "id": "l4jm0oe5wytlv"
            }
          }
        }
      }
    }
  },
  "$defs": {
    "Address.v3": {
      "type": "object",
      "x-stoplight": {
        "id": "c01e28f80783b"
      },
      "title": "Address",
      "description": "Address object: the description of address information",
      "x-tags": [
        "Primitive"
      ],
      "required": [
        "street1",
        "country",
        "contact_name"
      ],
      "properties": {
        "street1": {
          "type": "string",
          "description": "address_line1 of address\n"
        },
        "country": {
          "type": "string",
          "description": "Country in ISO 3166-1 alpha 3 code"
        },
        "contact_name": {
          "type": "string",
          "description": "contact_name of address"
        },
        "phone": {
          "type": "string",
          "description": "contact_phone of address"
        },
        "fax": {
          "type": [
            "string",
            "null"
          ],
          "description": "fax_number of address"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "email of address"
        },
        "company_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "company_name of address"
        },
        "street2": {
          "type": [
            "string",
            "null"
          ],
          "description": "address_line2 of address"
        },
        "street3": {
          "type": [
            "string",
            "null"
          ],
          "description": "address_line3 of address"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "city of address"
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "state of address"
        },
        "postal_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "postal_code of address"
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "type of address",
          "enum": [
            "residential",
            "business"
          ]
        },
        "tax_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "tax id"
        },
        "tax_id_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "tax id type. Only applies to DHL Express, DHL eCommerce US, DHL eCommerce UK.\n- vat: Value-Added tax\n- gst: Goods and Service Tax\n- eori: European Union Registration and Identification\n- ioss: Import One Stop Shop\n- pan: Pan-Aarav\n- ukims: UK Internal Market Scheme\n- other: Other\n",
          "x-stoplight": {
            "id": "7rtl96ei81zeb"
          },
          "enum": [
            "vat",
            "gst",
            "eori",
            "ioss",
            "pan",
            "ukims",
            "other"
          ]
        },
        "identification_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "identification number",
          "x-stoplight": {
            "id": "u1nqwj1dvhw67"
          }
        },
        "identification_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "identification type\n- mil: Military Number\n- nid: National Identity Card\n- pas: Passport\n- other: Other",
          "x-stoplight": {
            "id": "gh9ttmhi0xmik"
          },
          "enum": [
            "mil",
            "nid",
            "pas",
            "other"
          ]
        },
        "eori_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "eori number"
        },
        "location": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "lat": {
              "type": "number",
              "description": "latitude number"
            },
            "lng": {
              "type": "number",
              "description": "longitude number"
            }
          }
        }
      }
    },
    "Aes.v3": {
      "title": "AES",
      "x-stoplight": {
        "id": "k4c9cd1hj6q8g"
      },
      "type": "object",
      "description": "AES object: the description of EEI Type - aes",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "aes"
          ]
        },
        "itn_number": {
          "type": "string",
          "description": "ITN Number"
        }
      },
      "required": [
        "type"
      ]
    },
    "Billing.v3": {
      "title": "Billing",
      "x-stoplight": {
        "id": "bfc477642fe69"
      },
      "type": "object",
      "description": "Billing object: the description of billing information",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "paid_by": {
          "type": "string",
          "enum": [
            "shipper",
            "third_party",
            "recipient"
          ]
        },
        "method": {
          "$ref": "#/$defs/Payment_method_account.v3"
        }
      },
      "required": [
        "paid_by"
      ]
    },
    "Money.v3": {
      "title": "Money",
      "x-stoplight": {
        "id": "okc04k6a0ua3b"
      },
      "type": "object",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "enum": [
            "AED",
            "AFN",
            "ALL",
            "AMD",
            "ANG",
            "AOA",
            "ARS",
            "AUD",
            "AWG",
            "AZN",
            "BAM",
            "BBD",
            "BDT",
            "BGN",
            "BHD",
            "BIF",
            "BMD",
            "BND",
            "BOB",
            "BOV",
            "BRL",
            "BSD",
            "BTN",
            "BWP",
            "BYN",
            "BZD",
            "CAD",
            "CDF",
            "CHE",
            "CHF",
            "CHW",
            "CLF",
            "CLP",
            "CNY",
            "COP",
            "COU",
            "CRC",
            "CUC",
            "CUP",
            "CVE",
            "CZK",
            "DJF",
            "DKK",
            "DOP",
            "DZD",
            "EGP",
            "ERN",
            "ETB",
            "EUR",
            "FJD",
            "FKP",
            "GBP",
            "GEL",
            "GHS",
            "GIP",
            "GMD",
            "GNF",
            "GTQ",
            "GYD",
            "HKD",
            "HNL",
            "HRK",
            "HTG",
            "HUF",
            "IDR",
            "ILS",
            "INR",
            "IQD",
            "IRR",
            "ISK",
            "JMD",
            "JOD",
            "JPY",
            "KES",
            "KGS",
            "KHR",
            "KMF",
            "KPW",
            "KRW",
            "KWD",
            "KYD",
            "KZT",
            "LAK",
            "LBP",
            "LKR",
            "LRD",
            "LSL",
            "LYD",
            "MAD",
            "MDL",
            "MGA",
            "MKD",
            "MMK",
            "MNT",
            "MOP",
            "MRU",
            "MUR",
            "MVR",
            "MWK",
            "MXN",
            "MXV",
            "MYR",
            "MZN",
            "NAD",
            "NGN",
            "NIO",
            "NOK",
            "NPR",
            "NZD",
            "OMR",
            "PAB",
            "PEN",
            "PGK",
            "PHP",
            "PKR",
            "PLN",
            "PYG",
            "QAR",
            "RON",
            "RSD",
            "RUB",
            "RWF",
            "SAR",
            "SBD",
            "SCR",
            "SDG",
            "SEK",
            "SGD",
            "SHP",
            "SLL",
            "SOS",
            "SRD",
            "SSP",
            "STN",
            "SVC",
            "SYP",
            "SZL",
            "THB",
            "TJS",
            "TMT",
            "TND",
            "TOP",
            "TRY",
            "TTD",
            "TWD",
            "TZS",
            "UAH",
            "UGX",
            "USD",
            "USN",
            "UYI",
            "UYW",
            "UYU",
            "UZS",
            "VES",
            "VND",
            "VUV",
            "WST",
            "XAF",
            "XAU",
            "XBA",
            "XBB",
            "XBC",
            "XBD",
            "XCD",
            "XDR",
            "XOF",
            "XPD",
            "XPF",
            "XPT",
            "XSU",
            "XTS",
            "XXX",
            "YER",
            "ZAR",
            "ZMW",
            "ZWL"
          ],
          "description": "Currency of Money"
        },
        "amount": {
          "type": "number",
          "description": "Amount of Money"
        }
      },
      "description": "The money object is used to represent the currency amount."
    },
    "No_eei.v3": {
      "title": "NOEEI",
      "x-stoplight": {
        "id": "190bfme3fnjwm"
      },
      "type": "object",
      "description": "NOEEI object: the description of NOEEI Type",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Accepts: no_eei."
        },
        "ftr_exemption": {
          "type": "string",
          "enum": [
            "noeei_30_37_a",
            "noeei_30_37_h",
            "noeei_30_36"
          ]
        }
      },
      "required": [
        "type"
      ]
    },
    "Payment_method_account.v3": {
      "title": "PaymentMethodAccount",
      "x-stoplight": {
        "id": "ubj0avtyvpifn"
      },
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Accepts: account."
        },
        "account_number": {
          "type": "string",
          "description": "account number"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal code"
        },
        "country": {
          "type": "string",
          "description": "Country in ISO 3166-1 alpha 3 code",
          "enum": [
            "ABW",
            "AFG",
            "AGO",
            "AIA",
            "ALA",
            "ALB",
            "AND",
            "ANT",
            "ARE",
            "ARG",
            "ARM",
            "ASM",
            "ATA",
            "ATF",
            "ATG",
            "AUS",
            "AUT",
            "AZE",
            "BDI",
            "BEL",
            "BEN",
            "BES",
            "BFA",
            "BGD",
            "BGR",
            "BHR",
            "BHS",
            "BIH",
            "BLM",
            "BLR",
            "BLZ",
            "BMU",
            "BOL",
            "BRA",
            "BRB",
            "BRN",
            "BTN",
            "BVT",
            "BWA",
            "CAF",
            "CAN",
            "CCK",
            "CHE",
            "CHL",
            "CHN",
            "CIV",
            "CMR",
            "COD",
            "COG",
            "COK",
            "COL",
            "COM",
            "CPV",
            "CRI",
            "CUB",
            "CUW",
            "CXR",
            "CYM",
            "CYP",
            "CZE",
            "DEU",
            "DJI",
            "DMA",
            "DNK",
            "DOM",
            "DZA",
            "ECU",
            "EGY",
            "ERI",
            "ESH",
            "ESP",
            "EST",
            "ETH",
            "FIN",
            "FJI",
            "FLK",
            "FRA",
            "FRO",
            "FSM",
            "GAB",
            "GBR",
            "GEO",
            "GGY",
            "GHA",
            "GIB",
            "GIN",
            "GLP",
            "GMB",
            "GNB",
            "GNQ",
            "GRC",
            "GRD",
            "GRL",
            "GTM",
            "GUF",
            "GUM",
            "GUY",
            "HKG",
            "HMD",
            "HND",
            "HRV",
            "HTI",
            "HUN",
            "IDN",
            "IMN",
            "IND",
            "IOT",
            "IRL",
            "IRN",
            "IRQ",
            "ISL",
            "ISR",
            "ITA",
            "JAM",
            "JEY",
            "JOR",
            "JPN",
            "KAZ",
            "KEN",
            "KGZ",
            "KHM",
            "KIR",
            "KNA",
            "KOR",
            "KWT",
            "LAO",
            "LBN",
            "LBR",
            "LBY",
            "LCA",
            "LIE",
            "LKA",
            "LSO",
            "LTU",
            "LUX",
            "LVA",
            "MAC",
            "MAF",
            "MAR",
            "MCO",
            "MDA",
            "MDG",
            "MDV",
            "MEX",
            "MHL",
            "MKD",
            "MLI",
            "MLT",
            "MMR",
            "MNE",
            "MNG",
            "MNP",
            "MOZ",
            "MRT",
            "MSR",
            "MTQ",
            "MUS",
            "MWI",
            "MYS",
            "MYT",
            "NAM",
            "NCL",
            "NER",
            "NFK",
            "NGA",
            "NIC",
            "NIU",
            "NLD",
            "NOR",
            "NPL",
            "NRU",
            "NZL",
            "OMN",
            "PAK",
            "PAN",
            "PCN",
            "PER",
            "PHL",
            "PLW",
            "PNG",
            "POL",
            "PRI",
            "PRK",
            "PRT",
            "PRY",
            "PSE",
            "PYF",
            "QAT",
            "REU",
            "ROU",
            "RUS",
            "RWA",
            "SAU",
            "SDN",
            "SEN",
            "SGP",
            "SGS",
            "SHN",
            "SJM",
            "SLB",
            "SLE",
            "SLV",
            "SMR",
            "SOM",
            "SPM",
            "SRB",
            "SSD",
            "STP",
            "SUR",
            "SVK",
            "SVN",
            "SWE",
            "SWZ",
            "SXM",
            "SYC",
            "SYR",
            "TCA",
            "TCD",
            "TGO",
            "THA",
            "TJK",
            "TKL",
            "TKM",
            "TLS",
            "TON",
            "TTO",
            "TUN",
            "TUR",
            "TUV",
            "TWN",
            "TZA",
            "UGA",
            "UKR",
            "UMI",
            "UNK",
            "URY",
            "USA",
            "UZB",
            "VAT",
            "VCT",
            "VEN",
            "VGB",
            "VIR",
            "VNM",
            "VUT",
            "WLF",
            "WSM",
            "YEM",
            "ZAF",
            "ZMB",
            "ZWE"
          ]
        }
      },
      "required": [
        "type",
        "account_number"
      ],
      "x-tags": [
        "Primitive"
      ],
      "description": "PaymentMethodAccount object: the description of account information"
    }
  }
}