The ClearJet API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nYou can use the ClearJet API in test mode, which doesn’t affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.
\nThe ClearJet API doesn’t support bulk updates. You can work on only one object per request.
\nThis documentation page contains relevant information about the ClearJet Systems architecture, integration processes and API references, as well as useful tips and guides to get started working and integrating with the ClearJet System.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33418322","collectionId":"7e2c947b-fc8d-4621-8f93-eb5323270765","publishedId":"2sA2xiWrh8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"2A3450","highlight":"0038E3"},"publishDate":"2025-03-06T14:51:10.000Z"},"item":[{"name":"Authentication","id":"3cc5356d-b399-403c-9fb1-8f336d7af196","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"example@email.com\",\r\n \"password\": \"5z:uV~4L\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://os.clearjet.com/version-test/api/1.1/wf/auth","description":"The ClearJet API uses API keys to authenticate requests.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\nAdditionally, please note that the access token provided with the API key is valid for a period of 24 hours only. To renew the token, you will need to repeat the API call and obtain a fresh token.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"7e2c947b-fc8d-4621-8f93-eb5323270765","id":"7e2c947b-fc8d-4621-8f93-eb5323270765","name":"ClearJet API","type":"collection"}},"urlObject":{"protocol":"https","path":["version-test","api","1.1","wf","auth"],"host":["os","clearjet","com"],"query":[],"variable":[]}},"response":[{"id":"9893305e-0e77-465e-bc5b-cc979a76821e","name":"Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"example@email.com\",\r\n \"password\": \"5z:uV~4L\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://os.clearjet.com/version-test/api/1.1/wf/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 21:58:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-bubble-perf","value":"{\"total\":121.9,\"percents\":{\"top\":{\"bubble_cpu\":23.4,\"block\":75.3,\"capacity_rl\":0,\"other_pause\":0,\"pre_fiber\":0.5},\"sub\":{\"pp_userdb\":6.6,\"pp_wait_userdb\":0,\"http_request\":0,\"serverjson\":56.2,\"appserver_cache_misses_time\":0,\"redis\":40.6,\"fiber_queue\":2.5,\"capacity_wait\":1.8}},\"counts\":{\"pp_userdb\":2,\"http_request\":0,\"derived_build\":0,\"derived_cache_attempts\":3,\"derived_cache_memory_misses\":3,\"serverjson\":24,\"appserver_cache_attempts\":1,\"appserver_mem_cache_hits\":0,\"appserver_cache_hits\":1,\"appserver_cache_misses\":0,\"redis\":56,\"fiber_queue\":54,\"blocks\":53},\"misc\":{\"userdb_results\":4,\"userdb_data\":1212,\"spent_time\":6274719}}"},{"key":"x-bubble-capacity-used","value":"0.097 unit-seconds used"},{"key":"x-bubble-capacity-limit","value":"0 ms slower"},{"key":"vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"85f5208c5cff398c-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"token\": \"bus|1709589420293x841280466847544200|1717766441661x199006252111871840\",\n \"user_id\": \"1709589420293x841280466847544200\",\n \"expires\": 86400\n }\n}"}],"_postman_id":"3cc5356d-b399-403c-9fb1-8f336d7af196"},{"name":"Rates","id":"f9fca004-5999-4ff1-89a2-f2bad479116e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API endpoint allows you to calculate shipping rates based on the provided parameters.
\nweight (decimal, required): The weight of package. Example: 15.85.
weight_unit (string, required): The unit of weight. Values: lb, kg, oz.
from_zip (string, required): for ClearJet Express: The zip code of the origin. Example: 92161.
to_zip (string, required): for ClearJet Express: The zip code of the destination. Example: 94116.
service (string, optional): The type of shipping service. Values: AirSkip, ClearJet Express, ClearJet Ground. Leave this field blank to return rates from all rate cards.
length (decimal, required): The length of the package in inches up to 2 decimals.
width (decimal, required): The width of the package in inches up to 2 decimals.
height (decimal, required): The height of the package in inches up to 2 decimals.
origin (string, optional): Only used with AirSkip service level. The IATA origin airport code of the package. Example: LAX.
destination (string, optional): Only used with AirSkip service level. The IATA destination airport code of the package. Example: EWR.
This HTTP POST request is used to create a shipment and generate a Final Mile Carrier label. The request body should contain shipment details such as addresses, items, instructions, pickup time, service name, and label format.
\nThe response will include ClearJet's internal tracking ID, ClearJet's Customer Tracking URL, the Final Mile Carrer's tracking code, confirmation that ClearJet is the carrier, the ClearJet service selected, and the rate being charged for the shipment.
\nshipment (object)
to_address (object)
name (string, required)
street1 (string, required)
street2 (string, optional)
city (string, required)
state (string, required)
zip (string, required): five digit format
country (string, optional)
phone (string, optional)
email (string, optional)
from_address (object)
name (string, required)
company (string, optional): allows for printing Company name on labels
street1 (string, required)
street2 (string, optional)
city (string, required)
state (string, required)
zip (string, required): five digit format
country (string, optional)
phone (string, optional)
email (string, optional)
item (array)
piece_count (number, required): input \"1\" only
package_weight (number, required)
weight_unit (string, required)
length (number, required): The length of the package in inches up to 2 decimals.
width (number, required): The width of the package in inches up to 2 decimals.
height (number, required): The height of the package in inches up to 2 decimals.
description (string, required)
instructions (string, optional)
pickup_at (string, required): Ship date must be within 5 days from current date. (Internal requirement for specific final mile carriers)
Service_name (string, required)
label_format (string, required): Options are ZPL, PDF, and PNG.
Reference1 (string, optional)
Reference2 (string, optional)
Reference3 (string, optional)
Reference4 (string, optional)
This API allows clients to submit a list of container level shipments typically one to three days before the planned date of operation. The main endpoint processes container information based on the manifest date which signifies the date that ClearJet takes possession of the package. The API response returns a success message and a Manifest ID upon successful processing.
\nNote: A container is a Air Cargo approved box or container that is overpacked with indvidual packages.
\nManifestDate (string, required): Date in ISO 8601 format that shipments will be transferred to ClearJet.
ServiceName (string, required): The name of the service for the shipment.
FromName (string, optional): The name of the sender.
FromCompany (string, required): The company name of the sender.
FromPhone (string, optional): The phone number of the sender.
FromEmail (string, optional): The email address of the sender.
FromAddress1 (string, optional): The address line 1 of the sender.
FromAddress2 (string, optional): The address line 2 of the sender.
FromCity (string, optional): The city of the sender.
FromState (string, optional): The state of the sender.
FromPostalCode (string, optional): The postal code of the sender.
FromCountry (string, optional): The country of the sender.
FromTerminal (string, optional): The terminal of the sender.
ToTerminal (string, optional): The terminal of the recipient.
Consignee (string, optional): The name of the recipient.
SortCode (string, optional): The sort code for the shipment.
FinalMileCarrier (string, optional): The final mile carrier for the shipment.
ContainerID (string, required): The ID of the container.
ContainerCount (string, optional): The count of containers.
Container Weight (number, optional): The weight of the container with packages in pounds.
Container Name (string, optional): The name of the container.
ContainerLength (number, required): The length of the container in inches up to 2 decimals.
ContainerWidth (number, required): The width of the container in inches up to 2 decimals.
ContainerHeight (number, required): The height of the container in inches up to 2 decimals.
ShipmentDescription (string, required): The description of the shipment.
AWB (string, optional): Air Waybill number including three digit airline code prefix.
Reference1 (string, optional): Additional reference information.
Reference2 (string, optional): Additional reference information.
Reference3 (string, optional): Additional reference information.
ContainerDetails (array, optional)
TrackingNumber(string, optional)
PackageWeight(number, optional)
PackageWeightUnit(string, optional)
PackageSizeLength (number, optional)
PackageSizeWidth (number, optional)
PackageSizeHeight (number, optional)
ToName (string, optional)
ToPhone (string, optional)
ToEmail (string, optional)
ToAddress1 (string, optional)
ToAddress2 (string, optional)
ToCity (string, optional)
ToState (string, optional)
ToPostalCode (string, optional)
ToCountry (string, optional)
This API allows clients to submit package level details for sorting and shipping. The main endpoint processes package information based on the manifest date which signifies the date that ClearJet takes possession of the package. The API response returns a success message upon successful processing. Additionally, a webhook can be triggered to notify the customer with detailed information if a webhook has been created.
\nAll users must include the following fields in their requests. Only one object is allowed per request:
\nTrackingNumber (string): Unique identifier for the package.
FinalMileCarrier (string): Final mile carrier name.
ManifestDate (string, ISO 8601 format): Date that shipments will be transferred to ClearJet.
ServiceName (string): Name of the shipping service.
FromCompany (string): Name of the company sending the package.
FromAddress1 (string): Address line 1 of the sender.
FromCity (string): City of the sender.
FromState (string): State of the sender.
FromPostalCode (string, five digit format): Postal code of the sender.
FromCountry (string): Country of the sender.
ToPostalCode (string, five digit format): Postal code of the recipient.
ShipmentDescription (string): Description of the shipment.
PackageSizeLength (number): Length of the package in inches.
PackageSizeWidth (number): Width of the package inches.
PackageSizeHeight (number): Height of the package inches.
PackageWeight (number): Weight of the package.
PackageWeightUnit (string): Unit of the weight (lb or kg).
FromName (string): Name of the sender.
FromPhone (string): Phone number of the sender.
FromEmail (string): Email address of the sender.
FromAddress2 (string): Address line 2 of the sender.
FromTerminal (string): Terminal of the sender.
ToTerminal (string): Terminal of the recipient.
Consignee (string): Name of the consignee.
SortCode (string): Sorting code specific to merchant.
ToName (string): Name of the recipient.
ToPhone (string): Phone number of the recipient.
ToEmail (string): Email address of the recipient.
ToAddress1 (string): Address line 1 of the recipient.
ToAddress2 (string): Address line 2 of the recipient.
ToCity (string): City of the recipient.
ToState (string): State of the recipient.
ToCountry (string): Country of the recipient.
ContainerID (string): Container identifier.
ContainerCount (number): Number of containers.
ContainerWeight (number): Weight of the container.
ContainerName (string): Name of the container.
ContainerLength (number): Length of the container in inches.
ContainerWidth (number): Width of the container in inches.
ContainerHeight (number): Height of the container in inches.
AWB (string, 11 digit format): Air Waybill number including three digit airline code prefix in format.
Reference1 (string): Additional reference information.
Reference2 (string): Additional reference information.
Reference3 (string): Additional reference information.
Reference4 (string): Additional reference information.
If a webhook has been created for the customer, a notification will be sent to the specified address containing the following information:
\nmanifest_id (string): Unique identifier for the manifest.
package_count (integer): Number of packages processed.
tracking_numbers (array of strings): List of tracking numbers of the packages.
Example Webhook Payload:
\n{\n \"manifest_id\": \"manifest_123456\",\n \"package_count\": 2,\n \"tracking_numbers\": [\n \"1ZX87W790398226211\",\n \"1ZX87W790398226212\"\n ]\n}\n\nTo set up a webhook for receiving notifications, the customer must create a webhook specific for package sorting events. This webhook is separate from the existing tracking webhook in the system.
\nThe sorting service will process packages based on the ManifestDate provided for general requests.
Ensure all mandatory fields are included in the request.
\nThis HTTP POST request is used to track a workflow using ClearJet's tracking ID. The request should include a JSON payload with the tracking ID.
\nUpon successful execution, the response will include the latest status along with the historical list of events related to the tracking ID. Available statuses are configurable and available upon request. The date/time returned is UTC+0.
\ntracking_id: (string) The tracking ID for the workflow.This HTTP Post enables you to submit a receiver URL where ClearJet will send shipment tracking status.
\n","urlObject":{"protocol":"https","path":["version-test","api","1.1","wf","webhook"],"host":["os","clearjet","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccfd06e6-cb4f-4df3-b464-539e490b24fa"},{"name":"Create webhook","id":"66386305-d611-4328-b59e-47f95abb36f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"