Create a label.
Content-Type
Create a label object.
Billing object: the description of billing information
PaymentMethodAccount object: the description of account information
Customs object: the description of customs information
AES object: the description of EEI Type - aes
Billing object: the description of billing information
Address object: the description of address information
Address object: the description of address information
Passport Object
This array contains additional_charges object. Additional charge to be added to the commercial invoice of this shipment. Only applies to FedEx, DHL Express, UPS currently.
(set to false if not provided)
If the shipment is document type. (set to false if not provided)
Shipment object: the description of shipment information
The money object is used to represent the currency amount.
Address object: the description of address information
Address object: An optional address object that lets you customize the ship from details shown on the shipping label.
This is only for visual display and won't change actual shipping routes or carrier operations.
Supported slug: purolator,canada-post
Address object: the description of address information
Parcels of shipment
Address object: the description of address information
Instructions to aid in prompt delivery of the shipment.
Invoice object: the description of invoice type, commercial invoice will be generated if field is present in the request body
Invoice date in YYYY-MM-DD
Invoice number
Signature name showing on invoice. Only applies to FedEx, DHL Express currently.
Declaration statement showing on invoice. Only applies to FedEx, DHL Express currently.
This array contains service_options object. Please refer to all service options and service types and service options list for details.
Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone
A user-defined order number used to identify an order.
Unique identification of the order.
Custom fields that accept an object with string field.Show all...
Files object: additional shipping documents to upload with label generation. Only applies to FedEx, DHL Express currently.
Certificate of Origin
Commercial Invoice
Customs Declaration
Whether to return the qr_code when creating a label.Show all...
When set to true, automation rules configured for the organization will be applied to this label request. Enterprise only.
OK
Meta data object.
Code of Meta
Message of Meta
Details of Meta
Whether this request will be retryable or not
Label object: the description of label object
Label ID
Files object: the description of 6 different file objects(label, qr_code, invoice, customs_declaration, packing_slip, manifest)
Rate object: the description of rate information
A formatted date.
A formatted date.
Reference information for a label
The shipper account used to create this label
Service Types
A user-defined order number used to identify an order.
This array contains service_options object. Please refer to all service options and service types and service options list for details.
Unique identification of the order.
Custom fields that accept an object with string field.Show all...
Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier.
{
"return_shipment": false,
"is_document": false,
"service_type": "ups_ground",
"paper_size": "4x6",
"shipper_account": {
"id": "3ba41ff5-59a7-4ff0-8333-64a4375c7f21"
},
"references": [
"refernce1"
],
"shipment": {
"ship_from": {
"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": "19835553752",
"email": "[email protected]"
},
"ship_to": {
"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": "19835553752",
"email": "[email protected]"
},
"parcels": [
{
"box_type": "custom",
"dimension": {
"width": 10,
"height": 10,
"depth": 10,
"unit": "cm"
},
"items": [
{
"description": "Food Bar",
"quantity": 1,
"price": {
"currency": "USD",
"amount": 100
},
"item_id": "1234567",
"origin_country": "CHN",
"weight": {
"unit": "kg",
"value": 1
},
"sku": "imac2014",
"hs_code": "100630",
"return_reason": "too big"
}
],
"description": "Food XS",
"weight": {
"unit": "kg",
"value": 1
}
}
]
},
"custom_fields": {
"ship_code": "01"
},
"print_options": {
"qr_code": {
"enabled": true
}
}
}{ "meta": { "code": 200, "message": "OK", "details": [] }, "data": { "id": "3318b97b-150f-4205-840d-a6d966b9e0ea", "status": "created", "ship_date": "2022-09-09", "tracking_numbers": [ "0000000001" ], "carrier_references": [ { "piece_tracking_numbers": [ "JD000000000000000001" ] } ], "files": { "label": { "paper_size": "4x8", "url": "https://sandbox-download.postmen.com/label/2015-11-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf", "file_type": "pdf" }, "qr_code": null, "invoice": null, "customs_declaration": null, "packing_slip": null, "manifest": null }, "rate": { "charge_weight": { "value": 3.307, "unit": "lb" }, "total_charge": { "amount": 0, "currency": "USD" }, "shipper_account": { "id": "00000000-0000-0000-0000-000000000000", "slug": "dhl", "description": "DHL Sandbox" }, "service_type": "dhl_express_0900", "service_name": "DHL Express 0900", "pickup_deadline": null, "booking_cut_off": null, "delivery_date": null, "transit_time": null, "detailed_charges": [], "error_code": null, "error_message": null, "info_message": null }, "created_at": "2022-05-09T07:54:13.024Z", "updated_at": "2022-09-09T07:54:24.569Z", "references": [ "Ref-0001" ], "shipper_account": { "id": "00000000-0000-0000-0000-000000000000", "slug": "dhl" }, "service_type": "dhl_express_0900", "order_number": "ORD-20220909-0001", "service_options": [ { "type": "paperless_invoice", "enabled": true } ], "order_id": "9b2a1f6c-5d3e-4a71-8c0f-2e5b7d9a4c13", "custom_fields": { "ship_code": "01" }, "carrier_redirect_link": null } }