ShipperAccount

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-shipper-account-v3-schema.json",
  "title": "ShipperAccount",
  "description": "ShipperAccount object: the description of shipper account information",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aftership-shipper-accounts-api-openapi.yml#/components/schemas/Shipper_account.v3",
  "x-stoplight": {
    "id": "btwx9pxk00w1m"
  },
  "type": "object",
  "x-tags": [
    "Resource"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Shipper Account ID\n"
    },
    "address": {
      "$ref": "#/$defs/Address.v3"
    },
    "slug": {
      "type": "string",
      "description": "Couirer slug"
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled",
        "deleted"
      ]
    },
    "description": {
      "type": "string",
      "description": "The description of the account\n"
    },
    "type": {
      "type": "string",
      "description": "The type of the shipper_account",
      "enum": [
        "default",
        "user"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "Shipper account timezone\n"
    },
    "created_at": {
      "type": "string",
      "description": "A formatted date.\n"
    },
    "updated_at": {
      "type": "string",
      "description": "A formatted date.\n"
    }
  },
  "$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"
            }
          }
        }
      }
    }
  }
}