Authorization details for any section can be found here: Authentication
\nPlease refer to the details below:
\nStaging (Sandbox) Environment:
https://sandbox-customerapi.tfmex.com/
Contact IT team for testing credientials
Production (Live) Environment:
https://customerapi.tfmex.com/
To obtain production credentials, please contact the IT Team or CRT Team.
Alternatively, you may use the same credentials used to log in to the TFM Shipper Portal at:
https://customer.tfmex.com/
Note on Phone Number Validation:
\nWe have introduced phone number validation for the ConsigneeMobile and ConsigneeTelephone fields based on the country selected. Users can input the phone number in any format, including with or without the country code. For example, if the country is UAE:
971501231234 (with country code) or simply 501231234 (without country code), as long as the number is correct and matches the required format for the chosen country.We have introduced phone number validation for the ConsigneeMobile and ConsigneeTelephone fields based on the selected country.
Users can input phone numbers in any format, including with or without the country code.
Example for UAE:
A valid phone number can be entered as 971501231234 (with country code) or 501231234 (without country code).
As long as the number matches the required format for the chosen country, it will be accepted.
\nThe consigneeStreetName and consigneeBuildingName fields have been added to better structure the consignee's address.
consigneeStreetName: The street name of the consignee’s location (e.g., \"Street 24\").
consigneeBuildingName: The name of the building where the consignee is located (e.g., \"Silver Tower\").
Generates an authentication token required for accessing secured endpoints. This method also returns essential information, including the Shipper ID, which is necessary for creating new pickups and shipments.
\n","urlObject":{"protocol":"https","path":["api","v1","Token"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"772c5abe-cf58-43aa-a69d-728bbb39ff0a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"userName\": \"userName\",\n \"password\": \"string(*&12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://sandbox-customerapi.tfmex.com/api/v1/Token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"POST Request successful.\",\n \"isError\": false,\n \"result\": {\n \"userId\": 8745,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJNYW5pZmVzdGluZ1NvdXJjZSI6IkFQSSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiMjg1NCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJvbWFyc2hpcDI4NTQiLCJTdWJBY2NvdW50SWQiOiIwIiwiU3ViQWNjb3VudCI6IiIsIlN1YkFjY291bnRzIjoiW10iLCJqdGkiOiJiY2RhNTViNi0wMjFiLTRhYTktYTQyMS03MDljOTM1NjQ0MTYiLCJodHRwOi8vc2NoZW1hcy5taWNyVVSSaA3AqfHvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoie1wiU2hpcHBlcklkXCI6Mjg1NCxcIlNoaXBwZXJBY2NvdW50TnVtYmVyXCI6XCJSNTExXCIsXCJXZWlnaHRUeXBlXCI6MSxcIkNoYXJnZVR5cGVcIjozLFwiUGlja3VwQWRkcmVzc1wiOlwiNzAzIFRob21hcyBQYXJrUG9ydCBEYXJyeWxtb3V0aCwgVlQgNjM3NDBcIixcIlNoaXBwZXJHcm91cElkXCI6MixcIkRlbGl2ZXJ5U2VydmljZXNcIjpbMSwzNywyMSwxMywxNiwyOSwxMSwxMiwzMywzOCwxNSwxOCwy$#5LDMyLDIzLDMxXSxcIlBhcmVudEFjY291bnRJZFwiOjAsXCJCdWxrQ29sbGVjdFwiOnRydWUsXCJQcmljaW5nSWRcIjowLFwiU2FsZXNFeGVjXCI6MTA3LFwiU2FsZXNFeGVjTmFtZVwiOlwiRFJTIER1YmFpXCIsXCJJc1Rlc3RcIjpmYWxzZSxcIklzU2hpcHBlclN0YWZmXCI6ZmFsc2UsXCJUb3RhbFN1YkFjY291bnRzXCI6MCxcIklkXCI6Mjg1NCxcIkxlZGdlcklkXCI6MTIzNDUsXCJVc2VyTmFtZVwiOlwib21hcnNoaXAyODU0XCIsXCJFbWFpbFwiOlwib21hci5zaGFoaWRlZWU5OTg4QHRhaWZjby5jb21cIixcIlBob25lTnVtYmVyXCI6XCIxMTExMTExMTU1NDNcIixcIlBob25lTnVtYmVyQ29uZmlybWVkXCI6ZmFsc2UsXCJUd29GYWN0b3JFbmFibGVkXCI6ZmFsc2UsXCJEYXRlT2ZCaXJ0aFwiOlwiMjAwNS0xMi0yMVQwNzowMTo1NVwiLFwiTmFtZVwiOlwib21hcjExMVwiLFwiQWRkcmVzc1wiOlwiMzg3OTYgUmljaGFyZCBWaWxsYWdlIFN1aXRlIDA5NlNjb3R0cG9ydC0gTVAgNTY5OTVcIixcIkNvdW50cnlOYW1lXCI6XCJVbml0ZWQgQXJhYiBFbWlyYXRlc1wiLFwiQ291bnRyeUlkXCI6MjMxLFwiU3RhdGVPclByb3ZpbmNlTmFtZVwiOlwiXCIsXCJDaXR5TmFtZVwiOlwiRHViYWlcIixcIkNpdHlJZFwiOjksXCJOYXRpb25hbGl0eU5hbWVcIjpcIlwiLFwiU3RhdGlvbklkXCI6MCxcIlN0YXRpb25Db2RlXCI6XCJcIixcIlN0YXRpb25OYW1lXCI6XCJcIixcIlN0YXR1c0lkXCI6MyxcIkRldmljZVRva2V2dhjR2XCJmdklZSExHVFRPNm9BUzdMNWIwYTVpOkFQQTkxYkZTSHdCYUNfY1NfY0hlT3phUDdRZFd5QWwxRlZlUWJSYzY4akkxNnJNTjFSYTVmQnQ4bE1BMm1UNGZaNWIyffeeaoTFgtUWw5ZmtuU2pLNktKOF9SZHNUMHZwaWtqT0FKQUVFbVNWUm1aVFprc3JVdW1rT3NvT2M2UlF4QUNrcFVab3R2NFVSXCIsXCJHb29nbGVNYXBBcGlcIjp7XCJVUkxcIjpcIlwiLFwiS2V5XCI6XCJcIn0sXCJUb2tlblwiOntcIlVzZXJJZFwiOjAsXCJUb2tlblwiOlwiXCIsXCJFeHBpcmVzXCI6XCIwMDAxLTAxLTAxVDAwOjAwOjAwXCIsXCJSZWZyZXNoVG9rZW5cIjpcIlwiLFwiRXhwaXJlc1VuaXhUaW1lU3RhbXBcIjowLFwiVG9rZW5UeXBlXCI6XCJcIn0sXCJDdXJyZW5jeUNvZGVcIjpcIkFFRFwiLFwiTWFudWFsQVdCUHJlZml4XCI6XCJcIixcIklzUmlkZXJcIjpmYWxzZSxcIkNDQXZlbnVlTWVyY2hhbnRJZFwiOlwiXCJ9IiwiU2hpcHBlclN0YWZmIjoiRmFsc2UiLCJleHAiOjE3NjE1NTQwNTcsImlzcyI6Imh0dHBzOi8vc2FuZGJveC1jdXN0b21lcmFwaS50Zm1leC5jb20vIiwiYXVkIjoiaHR0cHM6Ly9zYW5kYm94LWN1c3RvbWVyYXBpLnRmbWV4LmNvbS8ifQ.Xvc4UYXeOzjxujRcx-DbaP3xWFWAGQR2bhB8KsZYwmQ\",\n \"expires\": \"2025-08-27T08:34:17Z\",\n \"refreshToken\": \"yLAgbjLnMv9a+6LM2PqSHcWymDbuCZKdS3jXoiZpeyiVEutlDxNJ6OK1iMunw3Gho7lTabjxRBpcWqULUC7TumQ==\",\n \"expiresUnixTimeStamp\": 1761554057,\n \"tokenType\": \"bearer\"\n }\n}"},{"id":"76638791-bc23-438e-9459-28d873261d29","name":"Invalid Credentials","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"userName\": \"userName233\",\n \"password\": \"string(*223er3&12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://sandbox-customerapi.tfmex.com/api/v1/Token"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"isError\": true,\n \"errors\": null,\n \"validationErrors\": null,\n \"details\": null,\n \"type\": \"https://httpstatuses.com/404\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"Enter Valid UserName & Password\",\n \"instance\": \"/api/v1/Token\"\n}"}],"_postman_id":"8ca52031-1125-4526-bf25-83465389e4fe"},{"name":"Countries","id":"3531aa52-0747-4fa2-aacf-c4009a5c4abf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"text/plain"}],"url":"https://sandbox-customerapi.tfmex.com/api/v1/Lookup/country","description":"Provides a list of all countries available for use within the system.
\nTo call this api you need JWT Token which you can get from Authentication
\n","urlObject":{"protocol":"https","path":["api","v1","Lookup","country"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"3e28b110-5a48-4456-91f0-9f4cc0261d3f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerReturns a list of all cities available in the specified country. The country code or ID must be provided as a parameter.
\nTo call this api you need JWT Token which you can get from Authentication
\n","urlObject":{"protocol":"https","path":["api","v1","Lookup","citybycountryid"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"30ba02ee-2814-4759-b01f-a9af36300685","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerRetrieves a list of all available delivery services.
\nTo call this api you need JWT Token which you can get from Authentication
\n","urlObject":{"protocol":"https","path":["api","v1","Lookup","deliveryservice"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"ba78e782-dd9e-4d0b-a135-06b81ab3065b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerReturns the shipping cost calculated according to the specified package weight.
\nTo call this api you need JWT Token which you can get from Authentication
\n","urlObject":{"protocol":"https","path":["api","v1","Pricing","calculatebyweight"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"5d12ef89-e0f8-4547-9bbf-0ef82085f180","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerCalculates the shipping price based on volumetric weight.
\nTo call this api you need JWT Token which you can get from Authentication
\n","urlObject":{"protocol":"https","path":["api","v1","Pricing","calculatebyvolumeweight"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"b4df3966-6e2a-430f-8fe6-bc4fc45b57c0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerTo call this api you need JWT Token which you can get from Authentication
\nDescription:
Schedules a new pickup request within the system based on the provided pickup details. This method allows users to specify the pickup address, time, and other relevant details for the scheduled collection.
Field Descriptions:
\n","urlObject":{"protocol":"https","path":["api","v1","Pickup","new"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"e624beb5-7862-4fc8-85bf-d0965c95496d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerTo call this api you need JWT Token which you can get from Authentication
\nDescription:
Cancels an existing pickup request within the system using a unique pickupCollectionId and other relevant details. This method can also accept proof of collection documents (in Base64 encoding or file path), along with additional remarks for canceling the pickup.
Field Descriptions
\nTo call this api you need JWT Token which you can get from Authentication
\nCreates a single new shipment. This API method allows you to specify the details of the shipment, such as the consignee information, delivery service, item details, and handling instructions.
If a subAccountId is provided, a corresponding pickup will be automatically created for the shipment.
If you don’t have a Sub Account(s) / Seller(s) yet, you can create by using the Create Seller endpoint.
subAccountId: When a subAccountId is specified, a pickup is automatically scheduled for the shipment. Ensure that this ID is valid. Defaults to 0 if no sub-account is used.
deliveryServiceCode: The chosen delivery method (e.g., \"COD\" for Cash on Delivery).A list of available delivery service codes can be found in the Delivery Service
consigneeMobile / consigneeTelePhone: Mobile / Telephone number of the consignee. It must be a valid phone number. At least one of these fields must be provided.
\nvalueAmount: For all International payments the ValueAmount field is required.
cod: For any amount to be collected cod field is required.
Note on Phone Number Validation: The consigneeMobile and consigneeTelephone fields must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nCreates a single new shipment. This API method allows you to specify the details of the shipment, such as the consignee information, delivery service, item details, and handling instructions.
If a subAccountId is provided, a corresponding pickup will be automatically created for the shipment.
If you don’t have a Sub Account(s) / Seller(s) yet, you can create by using the Create Seller endpoint.
If shipperName is provided, the shipment will use that name, otherwise the shipment will be created under the default shipper name set in your account.
shipperCity and shipperAddress are specific to UAE-based shipments only.
If these fields are provided, the shipment will be saved with these values.
\nIf not provided, the system will automatically use the default shipper details assigned to your account.
\nsubAccountId: When a subAccountId is specified, a pickup is automatically scheduled for the shipment. Ensure that this ID is valid. Defaults to 0 if no sub-account is used.
deliveryServiceCode: The chosen delivery method (e.g., \"COD\" for Cash on Delivery).A list of available delivery service codes can be found in the Delivery Service
consigneeMobile / consigneeTelePhone: Mobile / Telephone number of the consignee. It must be a valid phone number. At least one of these fields must be provided.
\nvalueAmount: For all International payments the ValueAmount field is required.
cod: For any amount to be collected cod field is required.
Note on Phone Number Validation: The consigneeMobile and consigneeTelephone fields must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nCreates multiple shipment waybills (Skybills) in a single request.
This API is ideal for bulk shipment creation where multiple consignments need to be generated at once, reducing repetitive single requests.
Each Skybill inside the skybills array represents a single shipment and follows the same structure as the Create Skybill API.
If a subAccountId is provided, a corresponding pickup will be automatically created for the shipment.
If you don’t have a Sub Account(s) / Seller(s) yet, you can create by using the Create Seller endpoint.
Note on Phone Number Validation: The consigneeMobile and consigneeTelephone fields must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nCreates a Return Pickup (RPU) request. This API is used to generate an RPU shipment by providing sender details (the pickup point) along with package information such as weight, volume, and reference data.
If a subAccountId is provided, a corresponding pickup will be automatically created for the shipment.
If you don’t have a Sub Account(s) / Seller(s) yet, you can create by using the Create Seller endpoint.
Note on Phone Number Validation: The consigneeMobile and consigneeTelephone fields must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nCreates a CHQ-RPU (Cheque Collection Return Pickup) service request. This API allows you to initiate a cheque-based return pickup by providing sender (pickup) details and shipment information such as weight, volume, and reference data.
If a subAccountId is provided, a corresponding pickup will be automatically created for the shipment.
If you don’t have a Sub Account(s) / Seller(s) yet, you can create by using the Create Seller endpoint.
Note on Phone Number Validation: The consigneeMobile and consigneeTelephone fields must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nThe revoke method is used to remove previously created shipments that have not yet been checked in.
\nThis operation allows users to cancel shipments that are in create state. Any shipment that has already been checked in cannot be revoked.
\nTo call this api you need JWT Token which you can get from Authentication
Generates a printable file based on the provided AWB number.
Printmode 2: Generates an A4-sized print file.
\nPrintmode 3: Generates a label-sized print file.
\nTo call this api you need JWT Token which you can get from Authentication
Retrieves the current tracking status and history of a shipment using its Air Waybill (AWB) number.
To call this api you need JWT Token which you can get from Authentication
\nRetrieves tracking information for multiple shipments by providing a batch of AWB numbers.
\n","urlObject":{"protocol":"https","path":["api","v1","SkyBill","bulktrackbyawb"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"3834771c-08b9-4222-a975-8c924427d76a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerTo call this api you need JWT Token which you can get from Authentication
\nCreates a new seller (sub-account) under the main account.
Each seller represents a separate shipping entity or business unit that can generate shipments, pickups, and waybills under the parent account.
This API allows you to define seller details such as name, contact information, and address.
The returned subAccountId can then be used in shipment creation methods like:
Password must meet the following criteria:
\nMinimum 12 characters
\nAt least one uppercase letter (A–Z)
\nAt least one lowercase letter (a–z)
\nAt least one digit (0–9)
\nAt least one special character (e.g., @, #, $, %, !, \\\\\\\\\\\\*, etc.)
Example of a valid password:SpecialCH@123454
Note on Phone Number Validation: The phoneNumberfield must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nUpdates a existing seller (sub-account) under the main account using their subAccountId.
Each seller represents a separate shipping entity or business unit that can generate shipments, pickups, and waybills under the parent account.
Note on Phone Number Validation: The phoneNumberfield must contain a valid phone number. Users can input the number with or without the country code (e.g., 971505412358 for UAE or 505412358 without the country code). As long as the number matches the format for the respective country, it will be accepted.
To call this api you need JWT Token which you can get from Authentication
\nDeletes an existing seller from the system using their subAccountId.
To call this api you need JWT Token which you can get from Authentication
\nRetrieves a list of all sellers (sub-accounts) associated with the authenticated shipper (main account).
\n","urlObject":{"protocol":"https","path":["api","v1","User","seller"],"host":["sandbox-customerapi","tfmex","com"],"query":[],"variable":[]}},"response":[{"id":"59538e0c-a473-43a6-81e9-9dbde13fff48","name":"Success","originalRequest":{"method":"POST","header":[],"url":"https://sandbox-customerapi.tfmex.com/api/v1/User/seller"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"POST Request successful.\",\n \"isError\": false,\n \"result\": [\n {\n \"subAccountId\": 9565,\n \"name\": \"Test\",\n \"email\": \"Test@example.com\",\n \"phoneNumber\": \"12345678999\",\n \"userName\": \"oommaarr\",\n \"address\": \"55 Oasis\",\n \"cityName\": \"Dubai\"\n },\n {\n \"subAccountId\": 9711,\n \"name\": \"Larue Goyette\",\n \"email\": \"larue@example.com\",\n \"phoneNumber\": \"123456789\",\n \"userName\": \"oomm1\",\n \"address\": \"dfhhh\",\n \"cityName\": \"Dubai\"\n }\n ]\n}"},{"id":"4c50dfcf-0d2c-4634-95f8-454d7e2fe52b","name":"Seller Details","originalRequest":{"method":"POST","header":[],"url":"https://sandbox-customerapi.tfmex.com/api/v1/User/seller"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"isError\": true,\n \"errors\": null,\n \"validationErrors\": null,\n \"details\": null,\n \"type\": \"https://httpstatuses.com/401\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"detail\": \"\",\n \"instance\": \"/api/v1/User/seller\"\n}"}],"_postman_id":"57c9d6b2-cb4e-463a-9f1c-78febb552e81"}],"event":[{"listen":"prerequest","script":{"id":"e7e3afa6-a898-4341-aa0b-66ca64f51083","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"d0a61fc3-ee23-47cf-9fc1-69d2b1bbe798","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"/"},{"key":"version","value":"string"},{"key":"bearerToken","value":"","type":"default"}]}