cj logo

Create Package Manifest

https://os.clearjet.com/version-test/api/1.1/wf/manifestfusce donec et.

Copied!
copy

Overview

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.pellentesque eget.

Common Request Fields

All users must include the following fields in their requests. Only one object is allowed per request:

Required Fields

TrackingNumber

(string)

Unique identifier for the package.

ManifestDate

(string, ISO 8601 format)

Date and time when the manifest is created.

ServiceName

(string)

The name of the service for the shipment.

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.

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.

WeightUnit

(string)

Unit of the weight (lb or kg).

Optional Fields

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.

FinalMileCarrier

(string)

Final mile carrier name.

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.

Webhook Notification

If a webhook has been created for the customer, a notification will be sent to the specified address containing the following information:

manifest_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:

json
Copied!
copy
{
    "manifest_id": "manifest_123456",
    "package_count": 2,
    "tracking_numbers": [
        "1ZX87W790398226211",
        "1ZX87W790398226212"
    ]
}

Webhook Setup

To 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.

Important Notes

  • The sorting service will process packages based on the ManifestDate provided for general requests.
  • Ensure all mandatory fields are included in the request.

Authorization

Token   <token>

HEADERS

Content-Type   application/json

Body

raw (json)
json
Copied!
copy
{
    "package": {
        "TrackingNumber": "1ZX87W790398226211",
        "ManifestDate": "2024-08-30T17:30:30Z",
        "ServiceName": "AirSkip",
        "FromCompany": "Fashion",
        "FromAddress1": "address line 1",
        "FromCity": "Missisauga",
        "FromState": "ON",
        "FromPostalCode": "L5T 2H7",
        "FromCountry": "CA",
        "ToPostalCode": "99361",
        "ShipmentDescription": "text",
        "PackageSizeLength": 0,
        "PackageSizeWidth": 0,
        "PackageSizeHeight": 0,
        "PackageWeight": 5,
        "WeightUnit": "lb"
    }
}

Example Request

package
curl
Copied!
copy
curl --location 'https://os.clearjet.com/version-test/api/1.1/wf/package' \
--header 'Content-Type: application/json' \
--data '{
    "package": {
        "TrackingNumber": "1ZX87W790398226211",
        "ManifestDate": "2024-08-30T17:30:30Z",
        "ServiceName": "AirSkip",
        "FromCompany": "Fashion",
        "FromAddress1": "address line 1",
        "FromCity": "Missisauga",
        "FromState": "ON",
        "FromPostalCode": "L5T 2H7",
        "FromCountry": "CA",
        "ToPostalCode": "99361",
        "ShipmentDescription": "text",
        "PackageSizeLength": 0,
        "PackageSizeWidth": 0,
        "PackageSizeHeight": 0,
        "PackageWeight": 5,
        "WeightUnit": "lb"
    }
}
'

Example Response

Body
Headers (1)
json
Copied!
copy
{
  "IsSuccess": true
}

Content-Type

application/json