TrakIT API‎ > ‎Shipment‎ > ‎

Create Shipment

The below API is used to create new Shipment.


Request: POST

Signature: trakit.XXX.com/api/mobile/CreateShipmentV2?Token={Login_Token}

Body:

{
"AddToExisting":BOOLEAN_VARIABLE,
"BLNum":"SHIPMENT_NUMBER",
"WFCode":"WORKFLOW_NAME/CODE",
"Customer":"CONTRACTUAL_CUSTOMER_NAME",
"WOCount":NUMBER_OF_WORK_ORDERS
}

Response:

{
    "Code": 1,
    "Info": "",
    "RowsAffected": 0,
    "Scalar": "SHIPMENT_NUMBER4",
    "Identity": 0,
    "RetInfo": [
        WORK_ORDER_ID
    ]
}

Sample: xyz.trakit.com/api/mobile/CreateShipmentV2?token=VomYEMiECFFyAQ3

CASE 1: When the user is trying to create a new Shipment and the Contractual Customer is REQUIRED as defined in the Header Fields.
Body: 

{
"AddToExisting":false,
"BLNum":"TD1234",
"WFCode":"IMPORT",
"Customer":"Tom Logistics Ltd.",
"WOCount":1
}


CASE 2: When the user is trying to create a new Shipment and the Contractual Customer is NOT REQUIRED as defined in the Header Fields.
Body: 

{
"AddToExisting":false,
"BLNum":"TD1234",
"WFCode":"IMPORT",
"WOCount":1
}


CASE 3: When the user is trying to add work orders to an existing Shipment.
Body: 

{
"AddToExisting":true,
"BLNum":"TD1234",
"WOCount":1
}



Things to know about this API:

  1. These fields are mandatory while sending request body:

    • AddToExisting
    • BLNum
    • WOCount
Comments