Courier object: the description of supported couriers
Courier object: the description of supported couriers
Courier slug, please check supported couriers for details
Display name of this courier, please check supported couriers for details
The function that this courier supports
This courier supported all paper_sizes
Customs declaration options this courier accepts. The accepted values differ by courier.
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.
Shipment purposes this courier accepts. The accepted values differ by courier. Possible values are gift, merchandise, non-merchandise, personal, repair, return and sample.
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 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.
This courier supported all servcie_types and service_names
Service type of this couirer
Service name of this couirer
Whether this service is domestic, as the string true or false. The field is omitted when the courier data holds no recognizable value.
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.
Indicates whether this service supports reverse logistics for return shipments.
Indicates whether this service integrates with Pick-Up Drop-Off (PUDO) networks, enabling parcel collection or delivery via retail points and lockers.
Indicates whether this service offers door-to-door carrier pickup for parcel collection.
Indicates whether this service allows customers to drop off their return parcels at designated carrier facilities.
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.
This courier supported all box_types
Box name of this courier
Box type of this courier
{ "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" } ] }