Create a Courier

post https://public-api.easyship.com/2024-09/couriers

Creates a new courier.

201 status when created successfully.
202 status when created but requiring additional verification.

Required authorization scope: public.courier:write

Responses

Response body

object

courier

object

Courier

string

customer_reference_id

string | null

An identifier for the customer who owns the account. Available only for selected customers.

easyship_courier

boolean

Whether the courier belongs to Easyship or not.

nickname

string

3 to 15

For LYOC. Unique nickname used to identify the linked account.

origin_country_alpha2

string

Country Code in Alpha-2 format (ISO 3166-1)

AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

state

string

Courier State for LYOC only. For Royal Mail, a newly-created account will be set to pending until the account details are verified. Once verified, the account will be set to active and the associated courier services will available for Rates and Labels.

pending pending_upgrade active inactive

auth

object

Courier authentication state for LYOC accounts.

ddp_handling_fee

number

For LYOC only. DDP handling fee applied by the courier when DDP is requested.

pickup_fee

number

For LYOC only. Additional pickup fee to apply to all shipments. This fee will be added to your quoted rates.

umbrella_name

string

Umbrella Name of the Courier

filtered_account_details

object

Account details are available only for LYOC couriers. The content is different per courier.

Has additional fields

logo_url

string

URL of the Courier logo.

201courier successfully created

202courier successfully created

402over limit

422failed validations