Jobs API

Developing

POST

https://{{subscriber_name}}.masi-leap.com/v1/x-masi-api/create-job

Some notes:

1.

subscriber_name for above mentioned URL will be provided by MASI

2.

NEW_JOB_API_KEY for request headers will be provided by MASI

Request

Header Params

Authorization

string

required

NEW_JOB_API_KEY - Will be provided by MASI

Example:

{{NEW_JOB_API_KEY}}

Content-Type

string

required

Example:

application/json

Accept

string

required

Example:

application/json

Body Params application/json

processType

enum<string>

required

Enum field which accepts only listed values. Any other value will be rejected by API

Allowed values:

INT_IMPORTINT_EXPORT_BOOKERINT_IMPORTINT_EXPORT_ORIGININT_EXPORT_PICKUPLOCALLONG_DISTANCE

shippingMode

enum<string>

optional

Enum field which accepts only listed values

Allowed values:

AIRSEALANDRAIL

shippingMethod

enum<string>

optional

Enum field which accepts only listed values

Allowed values:

AIRFCLLCLLTLFTLRO_RO

insurance

enum<string>

optional

Enum field which accepts only listed values

Allowed values:

INSURANCENO_INSURANCE

portFees

enum<string>

optional

Enum field which accepts only listed values

Allowed values:

paidByAgentpaidByCustomer

nonInclusiveDeliveryFees

enum<string>

optional

Enum field which accepts only listed values

Allowed values:

paidByAgentpaidByCustomer

serviceType

array[string]

optional

Field that accepts array of listed values

Values explanation:
DTD - Door to Door
DTP - Door to Port
DTW - Door to Warehouse
PTP - Port to Port
PTD - Port to Door
PTW - Port to Warehouse
WTW - Warehouse to Warehouse
WTD - Warehouse to Door
WTP - Warehouse to Port

Allowed values:

DTDDTPDTWPTPPTDPTWWTWWTDWTP

returnDateFrom

string <YYYY/MM/DD>

optional

returnDateTo

string <YYYY/MM/DD>

optional

departureDate

string <YYYY/MM/DD>

optional

Shipment departure date from port/terminal of loading.

arrivalDate

string <YYYY/MM/DD>

optional

Shipment arrival date to port/terminal of delivery.

arrivalDatePortDelivery

string <YYYY/MM/DD>

optional

Shipment arrival date to port/terminal of discharge.

deliveryDate

string <YYYY/MM/DD>

optional

Delivery date to customer

reference

string

optional

Booker reference number

<= 60 characters

billOfLanding

string

optional

B/L number

<= 60 characters

houseBillOfLanding

string

optional

House B/L number

<= 60 characters

volumeImperialQuoted

number

optional

Quoted shipment volume in qubic feet

volumeMetricQuoted

number

optional

Quoted shipment volume in qubic meters

weightImperialQuoted

number

optional

Quoted shipment weight in pounds/lbs

weightMetricQuoted

number

optional

Quoted shipment weight in kg

aesNumber

string

optional

Automated Export System (AES) number

<= 40 characters

vesselCarrierName

string

optional

Name of the vessel/carrier of the shipment

<= 60 characters

voyageNumber

string

optional

A Voyage Number is a unique identifier assigned to a specific journey or trip undertaken by a vessel, typically a ship or a maritime transport conveyance

<= 60 characters

cargoControlNumber

string

optional

Cargo Control Number is unique identifiers assigned to each freight shipment. It serves as a tracking tool to ensure shipments are easily identified, monitored, and processed throughout the entire shipping journey

<= 60 characters

itnNumber

string

optional

Internal Transaction Number (ITN)

<= 60 characters

bookingNumber

string

optional

Booking number

<= 60 characters

awbNumber

string

optional

Air waybill number (AWB Number)

<= 60 characters

serviceProfileNotes

string

optional

Job notes

<= 500 characters

specialItems

string

optional

Special items can be listed in this field separated by ","

<= 300 characters

isfNumber

string

optional

Importer Security Filing (ISF) number

<= 60 characters

movingFrom

object

optional

Shipment MOVING FROM address details

fullAddress

string

optional

Full address

<= 100 characters

apartment

string

optional

Appartment/Flat number

<= 10 characters

unitNo

string

optional

Unit number

<= 10 characters

buzzersCode

string

optional

Buzzer Code is a numeric code used to access a building's entry system, usually in apartment buildings or gated complexes

<= 10 characters

floor

string

optional

Floor number

<= 10 characters

notes

string

optional

Address notes, additional details

<= 100 characters

movingTo

object

optional

Shipment MOVING TO address details

fullAddress

string

optional

Full address

<= 100 characters

apartment

string

optional

Appartment/Flat number

<= 10 characters

unitNo

string

optional

Unit number

<= 10 characters

buzzersCode

string

optional

Buzzer Code is a numeric code used to access a building's entry system, usually in apartment buildings or gated complexes

<= 10 characters

floor

string

optional

Floor number

<= 10 characters

notes

string

optional

Address notes, additional details

<= 100 characters

customerDetails

object

optional

Customer details

name

string

optional

Customer full name

<= 50 characters

emails

array [object {2}]

optional

Array of customer emails, can be one or many, if you pass email object both value and type fields are mandatory.

phones

array [object {2}]

optional

Array of customer phones, can be one or many, if you pass phone object both value and type fields are mandatory.

Example

{
  "processType": "INT_IMPORT",
  "shippingMode": "AIR",
  "shippingMethod": "AIR",
  "insurance": "INSURANCE",
  "portFees": "paidByAgent",
  "nonInclusiveDeliveryFees": "paidByAgent",
  "serviceType": [
    "DTD"
  ],
  "returnDateFrom": "string",
  "returnDateTo": "string",
  "departureDate": "string",
  "arrivalDate": "string",
  "arrivalDatePortDelivery": "string",
  "deliveryDate": "string",
  "reference": "string",
  "billOfLanding": "string",
  "houseBillOfLanding": "string",
  "volumeImperialQuoted": 0,
  "volumeMetricQuoted": 0,
  "weightImperialQuoted": 0,
  "weightMetricQuoted": 0,
  "aesNumber": "string",
  "vesselCarrierName": "string",
  "voyageNumber": "string",
  "cargoControlNumber": "string",
  "itnNumber": "string",
  "bookingNumber": "string",
  "awbNumber": "string",
  "serviceProfileNotes": "string",
  "specialItems": "string",
  "isfNumber": "string",
  "movingFrom": {
    "fullAddress": "string",
    "apartment": "string",
    "unitNo": "string",
    "buzzersCode": "string",
    "floor": "string",
    "notes": "string"
  },
  "movingTo": {
    "fullAddress": "string",
    "apartment": "string",
    "unitNo": "string",
    "buzzersCode": "string",
    "floor": "string",
    "notes": "string"
  },
  "customerDetails": {
    "name": "string",
    "emails": [
      {
        "value": "string",
        "type": "string"
      }
    ],
    "phones": [
      {
        "value": "string",
        "type": "string"
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://{{subscriber_name}}.masi-leap.com/v1/x-masi-api/create-job' \
--header 'Authorization: {{NEW_JOB_API_KEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "processType": "INT_IMPORT",
    "shippingMode": "AIR",
    "shippingMethod": "AIR",
    "insurance": "INSURANCE",
    "portFees": "paidByAgent",
    "nonInclusiveDeliveryFees": "paidByAgent",
    "serviceType": [
        "DTD"
    ],
    "returnDateFrom": "string",
    "returnDateTo": "string",
    "departureDate": "string",
    "arrivalDate": "string",
    "arrivalDatePortDelivery": "string",
    "deliveryDate": "string",
    "reference": "string",
    "billOfLanding": "string",
    "houseBillOfLanding": "string",
    "volumeImperialQuoted": 0,
    "volumeMetricQuoted": 0,
    "weightImperialQuoted": 0,
    "weightMetricQuoted": 0,
    "aesNumber": "string",
    "vesselCarrierName": "string",
    "voyageNumber": "string",
    "cargoControlNumber": "string",
    "itnNumber": "string",
    "bookingNumber": "string",
    "awbNumber": "string",
    "serviceProfileNotes": "string",
    "specialItems": "string",
    "isfNumber": "string",
    "movingFrom": {
        "fullAddress": "string",
        "apartment": "string",
        "unitNo": "string",
        "buzzersCode": "string",
        "floor": "string",
        "notes": "string"
    },
    "movingTo": {
        "fullAddress": "string",
        "apartment": "string",
        "unitNo": "string",
        "buzzersCode": "string",
        "floor": "string",
        "notes": "string"
    },
    "customerDetails": {
        "name": "string",
        "emails": [
            {
                "value": "string",
                "type": "string"
            }
        ],
        "phones": [
            {
                "value": "string",
                "type": "string"
            }
        ]
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}