QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Update a shipper account's settings
patch
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Volume
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Courier

Courier object: the description of supported couriers

Courier slug, please check [supported couriers](https://www.aftership.com/docs/shipping/carrier-guide-supported-couriers) for details

Courier object: the description of supported couriers

Courier slug, please check [supported couriers](https://www.aftership.com/docs/shipping/carrier-guide-supported-couriers) for details
slug
string
required

Courier slug, please check supported couriers for details

name
string
required

Display name of this courier, please check supported couriers for details

operations
object
required

The function that this courier supports

post@labels
boolean
post@cancel-labels
boolean
post@rates
boolean
post@manifests
boolean
ship_from
string
ship_to
string
paper_sizes
array[string]
required

This courier supported all paper_sizes

customs
object

Customs declaration options this courier accepts. The accepted values differ by courier.

terms_of_trade
array[string]

Incoterms this courier accepts. The accepted values differ by courier. Possible values are cfr, cif, cip, cpt, dap, dat, ddp, ddu, dpu, exw, fca and fob.

purpose
array[string]

Shipment purposes this courier accepts. The accepted values differ by courier. Possible values are gift, merchandise, non-merchandise, personal, repair, return and sample.

features
object

Courier-level capability container. Each key describes one capability of this courier and its parameters. More capabilities may be added as sibling keys over time, so check for the key you need instead of assuming this object only holds qr_code. Existing top-level fields such as operations, paper_sizes and customs are not moved in here.

qr_code
object

QR code capability of this courier. Always returned. Read it together with courier_service_types[].support_qr_code: the service-level flag says whether that service can produce a QR code return label at all, while countries below says which origin countries AfterShip commits to.

courier_service_types
array[object]
required

This courier supported all servcie_types and service_names

service_type
string

Service type of this couirer

service_name
string

Service name of this couirer

is_domestic
string

Whether this service is domestic, as the string true or false. The field is omitted when the courier data holds no recognizable value.

ship_from.country
string

Where this service can ship from. The field name contains a dot; it is a flat field, not a nested object. The value is a three-letter country code such as USA or GBR, and a service that ships from several countries returns them as a comma-separated list such as IDN,THA.

support_return
boolean

Indicates whether this service supports reverse logistics for return shipments.

support_pudo
boolean

Indicates whether this service integrates with Pick-Up Drop-Off (PUDO) networks, enabling parcel collection or delivery via retail points and lockers.

support_pickup
boolean

Indicates whether this service offers door-to-door carrier pickup for parcel collection.

support_return_dropoff
boolean

Indicates whether this service allows customers to drop off their return parcels at designated carrier facilities.

support_qr_code
boolean

Indicates whether this service can produce a QR code return label through AfterShip. true: creating a label with this service returns a QR code. false: it does not, either because the courier has no such capability or because AfterShip has not integrated it. The field is absent when this service's QR code capability has not been verified yet — treat that as unknown, not as false. Origin-country and label-generation details are on the courier-level features.qr_code object.

courier_box_types
array[object]
required

This courier supported all box_types

box_name
string

Box name of this courier

box_type
string

Box type of this courier

Example
{ "slug": "string", "name": "string", "operations": { "post@labels": true, "post@cancel-labels": true, "post@rates": true, "post@manifests": true }, "ship_from": "string", "ship_to": "string", "paper_sizes": [ "string" ], "customs": { "terms_of_trade": [ "string" ], "purpose": [ "string" ] }, "features": { "qr_code": { "enabled": true, "support_usage": "both", "countries": [ null ] } }, "courier_service_types": [ { "service_type": "string", "service_name": "string", "is_domestic": "string", "ship_from.country": "string", "support_return": true, "support_pudo": true, "support_pickup": true, "support_return_dropoff": true, "support_qr_code": true } ], "courier_box_types": [ { "box_name": "string", "box_type": "string" } ] }