API ReferenceDocs
API Reference
Dashboard

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Australia Post eParcel Courier

string
enum
required
  • Australia Post eParcel: Australia Post eParcel
  • Australia Post: Deprecated. Umbrella name will be converted automatically to Australia Post eParcel when it is provided.
Allowed:
string
required
3 to 15

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

string | null

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

number

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

number

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

string
enum
required

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

Allowed:
account_details
object
required
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?