Create Manifest
https://os.clearjet.com/version-test/api/1.1/wf/manifest
Create Manifest
This endpoint allows you to submit a list of shipments typically one to three days before the planned date of operation.
Request Body
TrackingNumber
(text, optional)
The tracking number for the shipment
ServiceName
(string, required)
The name of the service for the shipment.
FromName
(text, optional)
The name of the sender.
FromCompany
(text, optional)
The company name of the sender.
FromPhone
(text, optional)
The phone number of the sender.
FromEmail
(text, optional)
The email address of the sender.
FromAddress1
(text, optional)
The address line 1 of the sender.
FromAddress2
(text, optional)
The address line 2 of the sender.
FromCity
(text, optional)
The city of the sender.
FromState
(text, optional)
The state of the sender.
FromPostalCode
(text, optional)
The postal code of the sender.
FromCountry
(text, optional)
The country of the sender.
FromTerminal
(text, optional)
The terminal of the sender.
ToTerminal
(text, optional)
The terminal of the recipient.
Consignee
(text, optional)
The name of the recipient.
SortCode
(text, optional)
The sort code for the shipment.
FinalMileCarrier
(text, optional)
The final mile carrier for the shipment.
ToName
(text, optional)
The name of the recipient.
ToPhone
(text, optional)
The phone number of the recipient
ToEmail
(text, optional)
The email address of the recipient.
ToAddress1
(text, optional)
The address line 1 of the recipient.
ToAddress2
(text, optional)
The address line 2 of the recipient.
ToCity
(text, optional)
The city of the recipient.
ToState
(text, optional)
The state of the recipient.
ToPostalCode
(text, optional)
The postal code of the recipient.
ToCountry
(text, optional)
The country of the recipient.
ContainerID
(text, optional)
The ID of the container.
ContainerCount
(text, optional)
The count of containers.
Container Weight
(number, optional)
The weight of the container with packages.
Container Name
(string, optional)
The name of the container.
ContainerLength
(number, optional)
The length of the container in inches.
ContainerWidth
(number, optional)
The width of the container in inches.
ContainerHeight
(number, optional)
The height of the container in inches.
ShipmentDescription
(text, optional)
The description of the shipment.
PackageSizeLength
(text, optional)
The length of the package.
PackageSizeWidth
(text, optional)
The width of the package.
PackageSizeHeight
(text, optional)
The height of the package.
PackageWeight
(text, optional)
The weight of the package.
AWB
(text, optional)
The air waybill number.
Reference1
(text, optional)
Additional reference information.
Reference2
(text, optional)
Additional reference information.
Reference3
(text, optional)
Additional reference information.
Reference4
(text, optional)
Additional reference information.
Authorization
Token <token>
Body
{
"TrackingNumber": "1ZX87W790398226211",
"ServiceName": "AirSkip",
"FromName": "John Doe",
"FromCompany": "Shipping Company Name",
"FromPhone": "+1111119999",
"FromEmail": "example@email.com",
"FromAddress1": "address line 1",
"FromAddress2": "address line 2",
"FromCity": "Los Angeles",
"FromState": "ON",
"FromPostalCode": "90044",
"FromCountry": "CA",
"FromTerminal": "ORD",
"ToTerminal": "LAX",
"Consignee": "Red",
"SortCode": "LAX_EWR_CDL_GROUND",
"FinalMileCarrier": "UPS",
"ToName": "Bean",
"ToPhone": "122",
"ToEmail": "ar",
"ToAddress1": "1",
"ToAddress2": "12",
"ToCity": "Los Angeles",
"ToState": "CA",
"ToPostalCode": "99361",
"ToCountry": "US",
"ContainerID": "1234",
"ContainerCount": 2,
"Container Weight": 7,
"Container Name": 2,
"ContainerLength": 2,
"ContainerWidth": 5,
"ContainerHeight": 6,
"ShipmentDescription": "text",
"PackageSizeLength": 1,
"PackageSizeWidth": 1,
"PackageSizeHeight": 1,
"PackageWeight": 5,
"AWB": "01612245678",
"Reference1": "#1111--22-33",
"Reference2": "#order-1234",
"Reference3": "SS01-158532",
"Reference4": "B1009"
}Example Request
curl --location 'https://os.clearjet.com/version-test/api/1.1/wf/manifest' \
--data-raw '{
"TrackingNumber": "1ZX87W790398226211",
"ServiceName": "ClearJet Express",
"FromName": "John Doe",
"FromCompany": "Shipping Company Name",
"FromPhone": "3108888888",
"FromEmail": "example@email.com",
"FromAddress1": "address line 1",
"FromAddress2": "address line 2",
"FromCity": "Los Angeles",
"FromState": "CA",
"FromPostalCode": "90044",
"FromCountry": "US",
"FromTerminal": "LAX",
"ToTerminal": "DFW",
"Consignee": "Name of Consignee",
"SortCode": "LAX_DFW_Veho_GROUND",
"FinalMileCarrier": "Veho",
"ToName": "Jane Doe",
"ToPhone": "2148888888",
"ToEmail": "example@email.com",
"ToAddress1": "Address 1",
"ToAddress2": "Address 2",
"ToCity": "Dallas",
"ToState": "TX",
"ToPostalCode": "75244",
"ToCountry": "US",
"ContainerID": "1234",
"ContainerCount": 2,
"Container Weight": 7,
"Container Name": "EH",
"ContainerLength": 2,
"ContainerWidth": 5,
"ContainerHeight": 6,
"ShipmentDescription": "Wearing Apparel",
"PackageSizeLength": 1,
"PackageSizeWidth": 1,
"PackageSizeHeight": 1,
"PackageWeight": 5,
"AWB": "01612245678",
"Reference1": "Optional Text",
"Reference2": "Optional Text",
"Reference3": "Optional Text",
"Reference4": "Optional Text"
}'Example Response
{
"IsSuccess": true
}Date
Mon, 04 Mar 2024 22:39:34 GMT
Content-Type
application/json
Transfer-Encoding
chunked
Connection
keep-alive
x-powered-by
Express
access-control-allow-origin
*
x-bubble-perf
{"total":997.5,"percents":{"top":{"bubble_cpu":21.1,"block":79,"capacity_rl":0,"other_pause":0,"pre_fiber":0.1},"sub":{"pp_userdb":15.9,"pp_wait_userdb":0,"http_request":0,"serverjson":91.3,"appserver_cache_misses_time":0,"redis":52.6,"fiber_queue":3.6,"capacity_wait":0}},"counts":{"pp_userdb":18,"http_request":0,"derived_build":1,"derived_cache_attempts":3,"derived_cache_memory_misses":3,"derived_cache_redis_misses":1,"derived_cache_postgres_misses":1,"serverjson":110,"appserver_cache_attempts":1,"appserver_mem_cache_hits":0,"appserver_cache_hits":1,"appserver_cache_misses":0,"redis":201,"fiber_queue":218,"blocks":217},"misc":{"userdb_results":23,"userdb_data":13750,"spent_time":68611358,"derived_build_time_spent":46}}
x-bubble-capacity-used
1.056 unit-seconds used
x-bubble-capacity-limit
0 ms slower
vary
Accept-Encoding
CF-Cache-Status
DYNAMIC
Server
cloudflare
CF-RAY
85f55ce8fbbc2d1e-IAD
Content-Encoding
br