docs.postmen.comAPI Overview - Postmen - Postmen API Docs

Options Select a carrier... APC Overnight Aramex Asendia Germany Asendia Hong Kong Australia Post Blue Dart Bonds Couriers Bpost Bpost International Bring Canada Post Canpar Correos Spain Courex Couriers Please Delhivery Deutsche Post DHL DHL eCommerce Asia DHL Express DHL Express (Postmen account) Dotzot DPD Belgium DPD NL DPD UK DPEX DTDC Endicia Fastway Australia FedEx FedEx Smartpost GLS Ireland Grab Hermesworld Hong Kong Post Landmark Global Malaysia Post Mondial Relay New Zealand Post Newgistics Nightline Ninja Van onTrac Pitney Bowes Purolator Quantium S.F. Express S.F. IBS S.F. International S.F. ISP SEKO OmniParcel Sendle SkyNet Worldwide Spanish Seur StarTrack Tai Wan Global Business Taqbin HK TIPSA TNT UPS UPS Mail Innovation USPS Whistl Yamato Japan Yodel Yun Express APC Overnight Aramex Asendia Germany Asendia Hong Kong Australia Post Blue Dart Bonds Couriers Bpost Bpost International Bring Canada Post Canpar Correos Spain Courex Couriers Please Delhivery Deutsche Post DHL DHL eCommerce Asia DHL Express DHL Express (Postmen account) Dotzot DPD Belgium DPD NL DPD UK DPEX DTDC Endicia Fastway Australia FedEx FedEx Smartpost GLS Ireland Grab Hermesworld Hong Kong Post Landmark Global Malaysia Post Mondial Relay New Zealand Post Newgistics Nightline Ninja Van onTrac Pitney Bowes Purolator Quantium S.F. Express S.F. IBS S.F. International S.F. ISP SEKO OmniParcel Sendle SkyNet Worldwide Spanish Seur StarTrack Tai Wan Global Business Taqbin HK TIPSA TNT UPS UPS Mail Innovation USPS Whistl Yamato Japan Yodel Yun Express Select SDK language Curl C# Java Node PHP Python Ruby API Resources Rates Calculate rates List all rates Retrieve rates Labels Create a label Retrieve a label List all labels Manifests Create a manifest List all manifests Retrieve a manifest Cancel Labels Cancel a label List all cancel labels Retrieve a cancel label Shipper Accounts Create a shipper account Delete a shipper account List all shipper accounts Retrieve a shipper account Update a shipper account credentials Update a shipper account information Update a shipper account Bulk Downloads Create a bulk download List all bulk downloads Retrieve a bulk download Address Validations (Beta) Create an address validation Objects Billing Customs Shipment Address Parcel Item SDKS Node.js PHP Python .NET Java Overview Rate limit Errors Webhooks Security Contact Support API Overview - Postmen Postmen API All entities are defined in the JSON schema format. Download the schemas to be able to validate your code. Download JSON schema API Key Before you can start using our REST API services, you&aposll need to obtain an API key. How to get your API Key? Login to your Postmen account (Sign up free) Go to https://secure.postmen.com/api-keys/sandbox to view and manage your api-keys. Making requests Once you&aposve registered your API key it&aposs easy to start requesting data from Postmen. All endpoints are only accessible via https. Sandbox: https://sandbox-api.postmen.com/v3 Production: https://production-api.postmen.com/v3 Request header All API calls must include the postmen-api-key header in order to authenticate the usage of Postmen API. Replace YOUR_API_KEY with your own key. Content-Type for all calls should be application/json . The charset parameter provided in Content-Type header is by default set to UTF-8 , it DOES NOT support any other encodings such like ISO-8859-1 postmen-api-key: YOUR_API_KEY Content-Type: application/json Request body All requests and responses are in JSON. The Envelope To make each response as predictable as possible, each response is contained in an envelope with two keys: meta and data . { "meta": { "code": 200 }, "data": { ... } } META The meta key is used to communicate extra information about the response. If all goes well, you&aposll only ever see a code key with value 200. If something goes wrong for some reason, you&aposll get a response like: { "meta": { "code": 401, "message": "Invalid API key.", "details": [], "retryable": false }, "data": {} } DATA The data key is the meat of the response and is where you&aposll find the requested data. Here is the example for a GET /labels { "meta": { "code": 200 }, "data": { "labels": [ { ... ... ... } ] } }...