ShipperAccount

ShipperAccount object: the description of shipper account information

ShipperAccount object: the description of shipper account information

id
string

Shipper Account ID

address
Address

Address object: the description of address information

street1
string
required

address_line1 of address

country
string
required

Country in ISO 3166-1 alpha 3 code

contact_name
string
required

contact_name of address

phone
string

contact_phone of address

fax
string or null

fax_number of address

email
string or null

email of address

company_name
string or null

company_name of address

street2
string or null

address_line2 of address

street3
string or null

address_line3 of address

city
string or null

city of address

state
string or null

state of address

postal_code
string or null

postal_code of address

type
string or null

type of address

Allowed values:
residentialbusiness
tax_id
string or null

tax id

tax_id_type
string or null

tax id type

  • vat: Value-Added tax
  • gst: Goods and Service Tax
  • eori: European Union Registration and Identification
  • ioss: Import One Stop Shop
  • pan: Pan-Aarav
  • other: Other
Allowed values:
vatgsteoriiosspanother
identification_number
string or null

identification number

identification_type
string or null

identification type

  • mil: Military Number
  • nid: National Identity Card
  • pas: Passport
  • other: Other
Allowed values:
milnidpasother
eori_number
string or null

eori number

location
object or null
slug
string

Couirer slug

status
string
Allowed values:
enableddisableddeleted
description
string

The description of the account

type
string

The type of the shipper_account

Allowed value:
default
timezone
string

Shipper account timezone

settings
object

Settings object: additional settings of the shipper account. Only applies to FedEx currently.

commercial_invoice_signature
string

Signature image to generate courier's electronic commercial invoice. The max resolution is 700 pixels wide by 50 pixels long.

commercial_invoice_letterhead
string

Signature image to generate courier's electronic commercial invoice. The max resolution is 700 pixels wide by 50 pixels long.

created_at
string

A formatted date.

updated_at
string

A formatted date.

Example
preparing...