Action

Tenders API

Introduction to the Tenders API. Use these endpoints to manage tenders.

Get Tender

Details about get an tenders. Include request/response examples, required fields, and validation rules here.

GET /tmsapi/getOrders HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
page_size Numeric Body @Optional Records limit, like Number of records for each request
Response:
Success code: 200 
{
    "page_size": 1,
    "results": [
        {
            "tender_id": "T123456",
            "sender_id": "SXUSA",
            "receiver_id": "SXUSAdmin",
            "customer_id": "C789",
            "timezone": "America\/New_York",
            "timeoffset": "-5",
            "order_id": "O101112",
            "tender_type": "Open",
            "tender_status": "Active",
            "dangerousGoods": "No",
            "temperatureRequirements": "None",
            "priceNegotiable": "Yes",
            "datesNegotiable": "No",
            "pickup_startdatetime": "2025-01-30 08:00:00",
            "pickup_enddatetime": "2025-01-30 10:00:00",
            "pickup_company": "ABC Logistics",
            "pickup_country": "USA",
            "pickup_city": "New York",
            "pickup_province": "NY",
            "pickup_pincode": "10001",
            "pickup_address1": "123 5th Ave",
            "pickup_address2": "Suite 200",
            "delivery_startdatetime": "2025-02-01 08:00:00",
            "delivery_enddatetime": "2025-02-01 10:00:00",
            "delivery_company": "XYZ Couriers",
            "delivery_country": "USA",
            "delivery_city": "Los Angeles",
            "delivery_province": "CA",
            "delivery_pincode": "90001",
            "delivery_address1": "456 Sunset Blvd",
            "delivery_address2": "Unit 501",
            "package_count": "10",
            "total_weight": "500",
            "gross_weight_uom": "kg",
            "total_volume": "5",
            "volume_uom": "m3",
            "goods_value": "20000",
            "currency": "USD",
            "freight_cost": "1500",
            "dedicated_vehicle": "Yes",
            "transport_mode": "Truck",
            "vehicle_type": "Flatbed",
            "createdon": "2025-01-25 14:00:00",
            "tender_expiration": "2025-02-05 00:00:00",
            "tender_instructions": "Handle with care.",
            "packages": [
                {
                    "package_type": "Box",
                    "item_name": "Electronics",
                    "description": "Smartphones and accessories",
                    "quantity": "10",
                    "weight": "50",
                    "weight_uom": "kg",
                    "volume": "0.5",
                    "volume_uom": "m3",
                    "length": "0.5",
                    "length_uom": "m",
                    "width": "0.4",
                    "width_uom": "m",
                    "height": "0.3",
                    "height_uom": "m",
                    "stackable": "Yes",
                    "hazardous": "No"
                }
            ],
            "tender_references": [
                {
                    "name": "DQ",
                    "value": "1234"
                },
                {
                    "name": "SD",
                    "value": "5678"
                }
            ],
            "involved_carriers": [
                {
                    "carrier_company": "Global Freight Co.",
                    "email": "contact@globalfreight.com",
                    "contact_number": "+1-800-555-1234",
                    "country": "USA",
                    "city": "Chicago",
                    "province": "IL",
                    "pincode": "60606",
                    "address_area1": "789 Industrial Rd",
                    "address_area2": "Warehouse 3"
                }
            ]
        }
    ],
    "total_count": 1,
    "total_pages": 1
}
Failure code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Create Tender

Details about creating a tender. Include request/response examples here.

POST /tmsapi/createTender HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "tender_id": "TDR123456",
    "sender_id": "SXUSA",
    "receiver_id": "SXUSAdmin",
    "customer_id": "C789",
    "timezone": "America\/New_York",
    "timeoffset": "-5",
    "order_id": "O101112",
    "tender_type": "Open",
    "tender_status": "Active",
    "pickup_startdatetime": "2025-01-30 08:00:00",
    "pickup_enddatetime": "2025-01-30 10:00:00",
    "pickup_company": "ABC Logistics",
    "pickup_country": "USA",
    "pickup_city": "New York",
    "pickup_province": "NY",
    "pickup_pincode": "10001",
    "pickup_address1": "123 5th Ave",
    "pickup_address2": "Suite 200",
    "delivery_startdatetime": "2025-02-01 08:00:00",
    "delivery_enddatetime": "2025-02-01 10:00:00",
    "delivery_company": "XYZ Couriers",
    "delivery_country": "USA",
    "delivery_city": "Los Angeles",
    "delivery_province": "CA",
    "delivery_pincode": "90001",
    "delivery_address1": "456 Sunset Blvd",
    "delivery_address2": "Unit 501",
    "currency": "USD",
    "transport_mode": "Truck",
    "vehicle_type": "Flatbed",
    "createdon": "2025-01-25 14:00:00",
    "packages": [
        {
            "package_type": "Box",
            "item_name": "Electronics",
            "description": "Smartphones and accessories",
            "quantity": "10",
            "weight": "50",
            "weight_uom": "kg",
            "volume": "0.5",
            "volume_uom": "m3",
            "length": "0.5",
            "length_uom": "m",
            "width": "0.4",
            "width_uom": "m",
            "height": "0.3",
            "height_uom": "m",
            "stackable": "Yes",
            "hazardous": "No"
        }
    ],
    "tender_references": [
        {
            "name": "DQ",
            "value": "1234"
        },
        {
            "name": "SD",
            "value": "5678"
        }
    ],
    "involved_carriers": [
        {
            "carrier_company": "Global Freight Co.",
            "email": "contact@globalfreight.com",
            "contact_number": "+1-800-555-1234",
            "country": "USA",
            "city": "Chicago",
            "province": "IL",
            "pincode": "60606",
            "address_area1": "789 Industrial Rd",
            "address_area2": "Warehouse 3"
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
tender_id String/Numeric Body @Required Customer Tender Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
customer_id String/Numeric Body @Optional Customer Identification Number
timezone Timezone Body @Optional Country Timezone like Asia/Kolkata
timeoffset String Body @Optional Country Timezone offset value in hours, like IST+05.30
order_id String/Numeric Body @Optional Customer Order Reference Number
tender_type String Body @Optional Type of the tender
tender_status String Body @Required Status of the tender
pickup_startdatetime Datetime Body @Optional Order Early Pickup Datetime
pickup_enddatetime Datetime Body @Optional Order Late Pickup Datetime
pickup_company String Body @Optional Pickup Location Company Name
pickup_country String Body @Optional Pickup Location Country Name
pickup_city String Body @Optional Pickup Location City Name
pickup_province String Body @Optional Pickup Location Province/State Name
pickup_pincode String/Numeric Body @Optional Pickup Location Postal Code
pickup_address1 String Body @Optional Pickup Location Address Line 1
pickup_address2 String Body @Optional Pickup Location Address Line 2
delivery_startdatetime Datetime Body @Optional Order Early Delivery Datetime
delivery_enddatetime Datetime Body @Optional Order Late Delivery Datetime
delivery_company String Body @Optional Delivery Location Company Name
delivery_country String Body @Optional Delivery Location Country Name
delivery_city String Body @Optional Delivery Location City Name
delivery_province String Body @Optional Delivery Location Province/State Name
delivery_pincode String/Numeric Body @Optional Delivery Location Postal Code
delivery_address1 String Body @Optional Delivery Location Address Line 1
delivery_address2 String Body @Optional Delivery Location Address Line 2
currency String Body @Optional Currency Code like USD
transport_mode String Body @Optional Mode of Transport (ROAD, AIR, SEA, RAIL)
vehicle_type String Body @Optional Expected/Required Vehicle Type for transportation
createdon Datetime Body @Optional Order Transaction Datetime
dedicated_vehicle String Body @Optional Dedicated Vehicle required or not (example: true/false)
order_status String Body @Optional Order Current Status like OPEN/ACTIVE
package_type String Body @Required Type of Packages like Bag,Box,Carton/Piece,Crate,Drum,Pallet/Skid,Roll,Tube
item_name String Body @Required Item Name
description String Body @Optional Item Description
stackable String Body @Optional Is this required Stackable, value like like true/false
hazardous String Body @Optional Is this Hazardous Material, value like true/false
allow_mixed_freight String Body @Optional Mixed freight is allowed in shipping, value like true/false
cargo_type String Body @Optional Inner cargo type
goods_description String Body @Optional Inner cargo item description
quantity Numeric Body @Optional Quantity
scanned_quantity Numeric Body @Optional Scanned Quantity
name Datetime String @Optional Order Reference Name
value String Body @Optional Order Reference Value
party_type String Body @Optional Involved party type name like Shipper/Consignee/Freight Payer/Carrier,etc
party_name String Body @Optional Involved party name
party_company String Body @Optional Involved party company name
email String Body @Optional Involved party email id
contact_number String Body @Optional Involved party contact number
country String Body @Optional Involved party country name
city String Body @Optional Involved party city name
province String Body @Optional Involved party province name
pincode Numeric/String Body @Optional Involved party pincode
address_area1 String Body @Optional Involved party address line 1
address_area2 String Body @Optional Involved party address line 2
packages package_type: String
item_name: String
description: String
quantity: Numeric
weight: Numeric
weight_uom: String
volume: Numeric
volume_uom: String
length: Numeric
length_uom: String
width: Numeric
width_uom: String
height: Numeric
height_uom: String
stackable: Numeric
hazardous: String 		Body @Optional Details about the packages, including dimensions, weight, and other attributes
tender_references Fields:
name: String
value: String 		Body @Optional Additional references related to the tender (e.g., DQ, SD)
involved_carriers Fields:
carrier_company: String
email: String
contact_number: String
country: String
city: String
province: String
pincode: Numeric
address_area1: String
address_area2: String 		Body @Optional Details about the carriers involved in the tender
Response:
Success code: 200 
{
    "results": {
        "status": true,
        "message": "Tender created successfully.",
        "tender_id": "TDR123456"
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Update Tender

Details about updating a tender. Include request/response examples here.

POST /tmsapi/updateTender HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "tender_id": "TDR123456",
    "sender_id": "SXUSA",
    "receiver_id": "SXUSAdmin",
    "customer_id": "C789",
    "timezone": "America\/New_York",
    "timeoffset": "-5",
    "order_id": "O101112",
    "tender_type": "Open",
    "tender_status": "Active",
    "pickup_startdatetime": "2025-01-30 08:00:00",
    "pickup_enddatetime": "2025-01-30 10:00:00",
    "pickup_company": "ABC Logistics",
    "pickup_country": "USA",
    "pickup_city": "New York",
    "pickup_province": "NY",
    "pickup_pincode": "10001",
    "pickup_address1": "123 5th Ave",
    "pickup_address2": "Suite 200",
    "delivery_startdatetime": "2025-02-01 08:00:00",
    "delivery_enddatetime": "2025-02-01 10:00:00",
    "delivery_company": "XYZ Couriers",
    "delivery_country": "USA",
    "delivery_city": "Los Angeles",
    "delivery_province": "CA",
    "delivery_pincode": "90001",
    "delivery_address1": "456 Sunset Blvd",
    "delivery_address2": "Unit 501",
    "currency": "USD",
    "transport_mode": "Truck",
    "vehicle_type": "Flatbed",
    "createdon": "2025-01-25 14:00:00",
    "packages": [
        {
            "package_type": "Box",
            "item_name": "Electronics",
            "description": "Smartphones and accessories",
            "quantity": "10",
            "weight": "50",
            "weight_uom": "kg",
            "volume": "0.5",
            "volume_uom": "m3",
            "length": "0.5",
            "length_uom": "m",
            "width": "0.4",
            "width_uom": "m",
            "height": "0.3",
            "height_uom": "m",
            "stackable": "Yes",
            "hazardous": "No"
        }
    ],
    "tender_references": [
        {
            "name": "DQ",
            "value": "1234"
        },
        {
            "name": "SD",
            "value": "5678"
        }
    ],
    "involved_carriers": [
        {
            "carrier_company": "Global Freight Co.",
            "email": "contact@globalfreight.com",
            "contact_number": "+1-800-555-1234",
            "country": "USA",
            "city": "Chicago",
            "province": "IL",
            "pincode": "60606",
            "address_area1": "789 Industrial Rd",
            "address_area2": "Warehouse 3"
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
tender_id String/Numeric Body @Required Customer Tender Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
customer_id String/Numeric Body @Optional Customer Identification Number
timezone Timezone Body @Optional Country Timezone like Asia/Kolkata
timeoffset String Body @Optional Country Timezone offset value in hours, like IST+05.30
order_id String/Numeric Body @Optional Customer Order Reference Number
tender_type String Body @Optional Type of the tender
tender_status String Body @Required Status of the tender
pickup_startdatetime Datetime Body @Optional Order Early Pickup Datetime
pickup_enddatetime Datetime Body @Optional Order Late Pickup Datetime
pickup_company String Body @Optional Pickup Location Company Name
pickup_country String Body @Optional Pickup Location Country Name
pickup_city String Body @Optional Pickup Location City Name
pickup_province String Body @Optional Pickup Location Province/State Name
pickup_pincode String/Numeric Body @Optional Pickup Location Postal Code
pickup_address1 String Body @Optional Pickup Location Address Line 1
pickup_address2 String Body @Optional Pickup Location Address Line 2
delivery_startdatetime Datetime Body @Optional Order Early Delivery Datetime
delivery_enddatetime Datetime Body @Optional Order Late Delivery Datetime
delivery_company String Body @Optional Delivery Location Company Name
delivery_country String Body @Optional Delivery Location Country Name
delivery_city String Body @Optional Delivery Location City Name
delivery_province String Body @Optional Delivery Location Province/State Name
delivery_pincode String/Numeric Body @Optional Delivery Location Postal Code
delivery_address1 String Body @Optional Delivery Location Address Line 1
delivery_address2 String Body @Optional Delivery Location Address Line 2
currency String Body @Optional Currency Code like USD
transport_mode String Body @Optional Mode of Transport (ROAD, AIR, SEA, RAIL)
vehicle_type String Body @Optional Expected/Required Vehicle Type for transportation
createdon Datetime Body @Optional Order Transaction Datetime
dedicated_vehicle String Body @Optional Dedicated Vehicle required or not (example: true/false)
order_status String Body @Optional Order Current Status like OPEN/ACTIVE
package_type String Body @Required Type of Packages like Bag,Box,Carton/Piece,Crate,Drum,Pallet/Skid,Roll,Tube
item_name String Body @Required Item Name
description String Body @Optional Item Description
stackable String Body @Optional Is this required Stackable, value like like true/false
hazardous String Body @Optional Is this Hazardous Material, value like true/false
allow_mixed_freight String Body @Optional Mixed freight is allowed in shipping, value like true/false
cargo_type String Body @Optional Inner cargo type
goods_description String Body @Optional Inner cargo item description
quantity Numeric Body @Optional Quantity
scanned_quantity Numeric Body @Optional Scanned Quantity
name Datetime String @Optional Order Reference Name
value String Body @Optional Order Reference Value
party_type String Body @Optional Involved party type name like Shipper/Consignee/Freight Payer/Carrier,etc
party_name String Body @Optional Involved party name
party_company String Body @Optional Involved party company name
email String Body @Optional Involved party email id
contact_number String Body @Optional Involved party contact number
country String Body @Optional Involved party country name
city String Body @Optional Involved party city name
province String Body @Optional Involved party province name
pincode Numeric/String Body @Optional Involved party pincode
address_area1 String Body @Optional Involved party address line 1
address_area2 String Body @Optional Involved party address line 2
packages package_type: String
item_name: String
description: String
quantity: Numeric
weight: Numeric
weight_uom: String
volume: Numeric
volume_uom: String
length: Numeric
length_uom: String
width: Numeric
width_uom: String
height: Numeric
height_uom: String
stackable: Numeric
hazardous: String 		Body @Optional Details about the packages, including dimensions, weight, and other attributes
tender_references Fields:
name: String
value: String 		Body @Optional Additional references related to the tender (e.g., DQ, SD)
involved_carriers Fields:
carrier_company: String
email: String
contact_number: String
country: String
city: String
province: String
pincode: Numeric
address_area1: String
address_area2: String 		Body @Optional Details about the carriers involved in the tender
Response:
Success code: 200 
{
    "results": {
        "status": true,
        "message": "Tender updated successfully.",
        "tender_id": "TDR123456"
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Delete Tender

Details about deleting a tender. Include request/response examples here.

POST /tmsapi/deleteTender HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "tender_id": "TDR123456",
    "order_id": "O101112"
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
tender_id String/Numeric Body @Required Customer Tender Reference Number
order_id String/Numeric Body @Optional Customer Order Reference Number
Response:
Success code: 200 
{
    "results": {
        "status": true,
        "message": "Tender deleted successfully.",
        "tender_id": "TDR123456"
    }
}
Success code: 400 
{
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Tender Carrier Quote

Details about tender carrier quote. Include request/response examples here.

POST /tmsapi/tenderCarrierQuote HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "tender_id": "TDR123456",
    "sender_id": "SXUSA",
    "receiver_id": "SXUSAdmin",
    "timezone": "GMT-5",
    "timeoffset": "-300",
    "tenderRate": "300",
    "currency": "USD",
    "response_datetime": "2025-01-23 14:30:00",
    "carrier_id": "874961",
    "additional_services": [
        {
            "service_name": "Fragile Handling",
            "service_price": "150"
        },
        {
            "service_name": "Insurance",
            "service_price": "200"
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
tender_id String/Numeric Body @Required Customer Tender Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
timezone String Body @Optional Time Zone (e.g., GMT-5)
timeoffset String/Numeric Body @Optional Time Offset in Minutes (e.g., -300 for GMT-5)
tenderRate String/Numeric Body @Required Tender Rate
currency String Body @Optional Currency Code (e.g., USD)
response_datetime String (ISO 8601) Body @Optional Response DateTime (e.g., 2025-01-23 14:30:00)
carrier_id String/Numeric Body @Required Carrier Identification Number
additional_services Array Body @Optional List of Additional Services
service_name String Body @Optional Name of Additional Service (e.g., Fragile Handling)
service_price String/Numeric Body @Optional Price of Additional Service
Response:
Success code: 200 
{
    "results": {
        "status": true,
        "message": "Carrier Quote added successfully.",
        "tender_id": "TDR123456",
        "carrier_id": "874961"
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Tender Confirm Carrier Quote

Details about tender confirm carrier quote. Include request/response examples here.

POST /tmsapi/tenderConfirmCarrierQuote HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "tender_id": "TDR123456",
    "sender_id": "SXUSA",
    "receiver_id": "SXUSAdmin",
    "timezone": "GMT-5",
    "timeoffset": "-300",
    "tenderRate": "400",
    "currency": "USD",
    "response_datetime": "2025-01-23T14:30:00Z",
    "carrier_id": "874961",
    "status": "accept"
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
tender_id String/Numeric Body @Required Customer Tender Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
timezone String Body @Optional Time Zone (e.g., GMT-5)
timeoffset String/Numeric Body @Optional Time Offset in Minutes (e.g., -300 for GMT-5)
tenderRate String/Numeric Body @Required Tender Rate
currency String Body @Optional Currency Code (e.g., USD)
response_datetime String (ISO 8601) Body @Optional Response DateTime (e.g., 2025-01-23 14:30:00)
carrier_id String/Numeric Body @Required Carrier Identification Number
status String Body @Required Status of the tender response (e.g., accept/reject)
Response:
Success code: 200 
{
    "results": {
        "status": true,
        "message": "The quote has been successfully accepted.",
        "tender_id": "TDR123456",
        "carrier_id": "874961"
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}