Create Container Manifest

https://os.clearjet.com/version-test/api/1.1/wf/manifest

Copied!

Create a Container Manifest

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.

Note: A container is a Air Cargo approved box or container that is overpacked with indvidual packages.

Request Body

ManifestDate

(text, required)

Date that shipments will be transferred to ClearJet.

ServiceName

(text, required)

The name of the service for the shipment.

FromName

(text, optional)

The name of the sender.

FromCompany

(text, required)

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 postal code 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.

ContainerID

(text, required)

The ID of the container.

ContainerCount

(text, required)

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, 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 yo 2 decimals.

ShipmentDescription

(text, required)

The description of the shipment.

AWB

(string, 11 digit format)

Air Waybill number including three digit airline code prefix in format.

Reference1

(text, optional)

Additional reference information.

Reference2

(text, optional)

Additional reference information.

Reference3

(text, optional)

Additional reference information.

ContainerDetails

(array, optional)

TrackingNumber (text, optional)

Weight (number, optional)

PackageSizeLength (number, optional)

PackageSizeWidth (number, optional)

PackageSizeHeight (number, optional)

ToName (text, optional)

ToPhone (text, optional)

ToEmail (text, optional)

ToAddress1 (text, optional)

ToAddress2 (text, optional)

ToCity (text, optional)

ToState (text, optional)

ToPostalCode (text, optional)

ToCountry (text, optional)

Authorization

Token <token>

Body

raw (json)

json

Copied!

{
  "ManifestDate": "07/08/2024",
  "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",
  "ContainerID": "1234",
  "ContainerCount": 2,
  "Container Weight": 7,
  "Container Name": 2,
  "ContainerLength": 2,
  "ContainerWidth": 5,
  "ContainerHeight": 6,
  "ShipmentDescription": "text",
  "AWB": "01612245678",
  "Reference1": "#1111--22-33",
  "Reference2": "#order-1234",
  "Reference3": "SS01-158532",
  "Reference4": "B1009",
  "ContainerDetails": [
      {
      "TrackingNumber": "1ZX87W790398226211",
      "Weight": 5,
      "PackageSizeLength": 1.1,
      "PackageSizeWidth": 1.2,
      "PackageSizeHeight": 1,
      "ToName": "Jane Doe",
      "ToPhone": "2148888888",
      "ToEmail": "example@email.com",
      "ToAddress1": "Address 1",
      "ToAddress2": "Address 2",
      "ToCity": "Dallas",
      "ToState": "TX",
      "ToPostalCode": "75244",
      "ToCountry": "US"
      }
  ]
}

Example Request

curl

Copied!

curl --location 'https://os.clearjet.com/version-test/api/1.1/wf/manifest' \
--data-raw '{
  "ManifestDate": "07/08/2024",
  "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",
  "ContainerID": "1234",
  "ContainerCount": 2,
  "Container Weight": 7,
  "Container Name": 2,
  "ContainerLength": 2,
  "ContainerWidth": 5,
  "ContainerHeight": 6,
  "ShipmentDescription": "text",
  "AWB": "01612245678",
  "Reference1": "#1111--22-33",
  "Reference2": "#order-1234",
  "Reference3": "SS01-158532",
  "Reference4": "B1009",
  "ContainerDetails": [
      {
      "TrackingNumber": "1ZX87W790398226211",
      "Weight": 5,
      "PackageSizeLength": 1.1,
      "PackageSizeWidth": 1.2,
      "PackageSizeHeight": 1,
      "ToName": "Jane Doe",
      "ToPhone": "2148888888",
      "ToEmail": "example@email.com",
      "ToAddress1": "Address 1",
      "ToAddress2": "Address 2",
      "ToCity": "Dallas",
      "ToState": "TX",
      "ToPostalCode": "75244",
      "ToCountry": "US"
      }
  ]
}'

Example Response

json

Copied!

{
  "IsSuccess": true
}

Date

Mon, 08 Jul 2024 18:09:32 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

x-powered-by

Express

access-control-allow-origin

x-bubble-perf

{"total":204.3,"percents":{"top":{"bubble_cpu":52.3,"block":46.4,"capacity_rl":0,"other_pause":0,"pre_fiber":0.3},"sub":{"pp_userdb":14.7,"pp_wait_userdb":0,"http_request":0,"serverjson":13.1,"appserver_cache_misses_time":0,"redis":119.7,"fiber_queue":4.8,"capacity_wait":0}},"counts":{"pp_userdb":5,"http_request":0,"derived_build":0,"serverjson":46,"appserver_cache_attempts":0,"appserver_mem_cache_hits":0,"appserver_cache_hits":0,"appserver_cache_misses":0,"redis":54,"fiber_queue":51,"blocks":50},"misc":{"userdb_results":6,"userdb_data":4066,"spent_time":24022822}}

x-bubble-capacity-used

0.37 unit-seconds used

x-bubble-capacity-limit

0 ms slower

vary

Accept-Encoding

CF-Cache-Status

DYNAMIC

Server

cloudflare

CF-RAY

8a0206a2ec222d0b-IAD

Content-Encoding

alt-svc

h3=":443"; ma=86400



Create shipment

Create Package Manifest

