Create a shipper account - AfterShip Shipping API

This endpoint allows you to create your shipper account via API. You can integrate our API with your system and manage the shipper account according to your needs.

Please ensure that your account credentials are correct. Different carriers have different requirements for account credentials, you can refer to Shipper account's credentials for more details.

Please refer to [Shipper account's credentials](../docs/enum/shipper-accounts-credentials.md)

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Create a shipper account

slug

string

description

string

timezone

string

credentials

object

Please refer to Shipper account's credentials

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

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. Only applies to DHL Express, DHL eCommerce US, DHL eCommerce UK.

vat: Value-Added tax
gst: Goods and Service Tax
eori: European Union Registration and Identification
ioss: Import One Stop Shop
pan: Pan-Aarav
ukims: UK Internal Market Scheme
other: Other

Allowed values:

vatgsteoriiosspanukimsother

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

Responses

200

Create a shipper account

Body

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

integer

required

Code of Meta

message

string

required

Message of Meta

details

array[Error]

Details of Meta

retryable

boolean

Whether this request will be retryable or not

data

ShipperAccount

ShipperAccount object: the description of shipper account information

string

Shipper Account ID

address

Address

Address object: the description of address information

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 values:

defaultuser

timezone

string

Shipper account timezone

created_at

string

A formatted date.

updated_at

string

A formatted date.

Auth

Parameters

Body

{
  "slug": "dhl",
  "description": "My Shipper Account",
  "timezone": "Asia/Hong_Kong",
  "credentials": {
    "account_number": "******",
    "password": "******",
    "site_id": "******"
  },
  "address": {
    "contact_name": "AfterShip Shipping",
    "company_name": "AfterShip Shipping",
    "street1": "230 W 200 S LBBY",
    "city": "Salt Lake City",
    "state": "UT",
    "postal_code": "84101",
    "country": "USA",
    "phone": "123456789",
    "email": "[email protected]"
  }
}

Response Example

{
  "meta": {
    "code": 200,
    "message": "OK",
    "details": []
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "My Shipper Account",
    "slug": "dhl",
    "status": "enabled",
    "timezone": "Asia/Hong_Kong",
    "type": "default",
    "created_at": "2016-02-12T10:30:50+00:00",
    "updated_at": "2016-09-23T04:56:26+00:00",
    "address": {
      "country": "HKG",
      "contact_name": "Sir Foo",
      "phone": "11111111",
      "fax": "+1 206-654-3100",
      "email": "[email protected]",
      "company_name": "Foo Store",
      "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
      "street2": "18 Cheung Shun Street, Lai Chi Kok",
      "city": "Lai Chi Kok",
      "type": "business",
      "postal_code": null,
      "state": null,
      "street3": null,
      "tax_id": null
    }
  }
}