Create Shipment
https://os.clearjet.com/version-test/api/1.1/wf/shipment
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.
The 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.
Request Body
Authorization
Token <token>
Body
{
"shipment": {
"to_address": {
"name": "John Doe",
"street1": "7000 Coliseum Way",
"street2": "",
"city": "Oakland",
"state": "CA",
"zip": "94621",
"country": "US",
"phone": "5555551234",
"email": "example@email.com"
},
"from_address": {
"name": "Shipping Company Name",
"street1": "1253 W 66th St",
"street2": "",
"city": "Los Angeles",
"state": "CA",
"zip": "90044",
"country": "US",
"phone": "5555551234",
"email": "example@email.com"
},
"item": {
"piece_count": 1,
"package_weight": 30,
"weight_unit": "kg",
"length": 5,
"width": 5,
"height": 5,
"description": "Clothing"
}
},
"instructions": "Leave at front door",
"airport_code": "AUS",
"pickup_at": "2024-03-30T17:30:30Z",
"service_name": "ClearJet Express",
"label_format": "PDF",
"Reference1": "Reference1",
"Reference2": "Reference2",
"Reference3": "Reference3",
"Reference4": "Reference4"
}Example Request
curl --location 'https://os.clearjet.com/version-test/api/1.1/wf/shipment' \
--data-raw '{
"shipment": {
"to_address": {
"name": "John Doe",
"street1": "7000 Coliseum Way",
"street2": "",
"city": "Oakland",
"state": "CA",
"zip": "94621",
"country": "US",
"phone": "5555551234",
"email": "example@email.com"
},
"from_address": {
"name": "Shipping Company Name",
"street1": "1253 W 66th St",
"street2": "",
"city": "Los Angeles",
"state": "CA",
"zip": "90044",
"country": "US",
"phone": "5555551234",
"email": "example@email.com"
},
"item": {
"piece_count": 1,
"package_weight": 30,
"weight_unit": "lb",
"length": 5,
"width": 5,
"height": 5,
"description": "Clothing"
}
},
"instructions": "Leave at front door",
"pickup_at": "2024-03-30T17:30:30Z",
"service_name": "ClearJet Express",
"label_format": "ZPL",
"Reference1": "Optional Text",
"Reference2": "Optional Text",
"Reference3": "Optional Text",
"Reference4": "Optional Text"
}'Example Response
{
"tracking_id": "CJ85007136",
"tracking_url": "https://os.clearjet.com/tracking/?tracking_id=CJ12345678",
"tracking_code": "EZ03EAS0000000013551",
"rate": {
"carrier": "ClearJet",
"service": "ClearJet Express",
"amount": "6.04"
}Date
Tue, 27 Feb 2024 22:18:46 GMT
Content-Type
application/json
Transfer-Encoding
chunked
Connection
keep-alive
x-powered-by
Express
access-control-allow-origin
*
x-bubble-perf
{"total":5917.8,"percents":{"top":{"bubble_cpu":6,"block":94.1,"capacity_rl":0,"other_pause":0,"pre_fiber":0},"sub":{"pp_userdb":3,"pp_wait_userdb":0,"http_request":57.6,"serverjson":55.1,"appserver_cache_misses_time":0,"redis":83.4,"fiber_queue":4.2,"capacity_wait":0}},"counts":{"pp_userdb":14,"http_request":3,"derived_build":2,"derived_cache_attempts":3,"derived_cache_memory_misses":3,"derived_cache_redis_misses":2,"derived_cache_postgres_misses":2,"serverjson":385,"appserver_cache_attempts":2,"appserver_mem_cache_hits":0,"appserver_cache_hits":0,"appserver_cache_misses":2,"redis":1247,"fiber_queue":480,"blocks":479},"misc":{"userdb_results":17,"userdb_data":10081,"spent_time":95123800,"derived_build_time_spent":90}}
x-bubble-capacity-used
1.463 unit-seconds used
x-bubble-capacity-limit
0 ms slower
vary
Accept-Encoding
CF-Cache-Status
DYNAMIC
Server
cloudflare
CF-RAY
85c3ce104ec33b50-IAD
Content-Encoding
br