POST api/logistics/CreateFreightShipment

Create a freight shipment

Request Information

URI Parameters

None.

Body Parameters

FreightCreateShipmentRequest
Name Type Description Additional information
shipperZip string

shipperCountry string

consigneeZip string

consigneeCountry string

shipmentMode string

equipmentType string

items Collection of CreateShipmentItem

shipperAddress string

shipperName string

shipperContact string

shipperEmail string

shipperPhone string

consigneeAddress string

consigneeName string

consigneeContact string

consigneeEmail string

consigneePhone string

poReference string

pickupDate date

Request Formats

application/json, text/json

Sample: 
{
  "shipperZip": "sample string 1",
  "shipperCountry": "sample string 2",
  "consigneeZip": "sample string 3",
  "consigneeCountry": "sample string 4",
  "shipmentMode": "sample string 5",
  "equipmentType": "sample string 6",
  "items": [
    {
      "class": "sample string 1",
      "pieces": 2,
      "weight": 3.1,
      "isHazardous": true,
      "packaging": "sample string 5",
      "billed": 6.1
    },
    {
      "class": "sample string 1",
      "pieces": 2,
      "weight": 3.1,
      "isHazardous": true,
      "packaging": "sample string 5",
      "billed": 6.1
    }
  ],
  "shipperAddress": "sample string 7",
  "shipperName": "sample string 8",
  "shipperContact": "sample string 9",
  "shipperEmail": "sample string 10",
  "shipperPhone": "sample string 11",
  "consigneeAddress": "sample string 12",
  "consigneeName": "sample string 13",
  "consigneeContact": "sample string 14",
  "consigneeEmail": "sample string 15",
  "consigneePhone": "sample string 16",
  "poReference": "sample string 17",
  "pickupDate": "2025-01-18T05:17:24.3155679+00:00"
}

application/xml, text/xml

Sample: 
<FreightCreateShipmentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <test>true</test>
  <shipperZip>sample string 1</shipperZip>
  <shipperCountry>sample string 2</shipperCountry>
  <consigneeZip>sample string 3</consigneeZip>
  <consigneeCountry>sample string 4</consigneeCountry>
  <shipmentMode>sample string 5</shipmentMode>
  <equipmentType>sample string 6</equipmentType>
  <items>
    <CreateShipmentItem>
      <class>sample string 1</class>
      <pieces>2</pieces>
      <weight>3.1</weight>
      <isHazardous>true</isHazardous>
      <packaging>sample string 5</packaging>
      <billed>6.1</billed>
    </CreateShipmentItem>
    <CreateShipmentItem>
      <class>sample string 1</class>
      <pieces>2</pieces>
      <weight>3.1</weight>
      <isHazardous>true</isHazardous>
      <packaging>sample string 5</packaging>
      <billed>6.1</billed>
    </CreateShipmentItem>
  </items>
  <shipperAddress>sample string 7</shipperAddress>
  <shipperName>sample string 8</shipperName>
  <shipperContact>sample string 9</shipperContact>
  <shipperEmail>sample string 10</shipperEmail>
  <shipperPhone>sample string 11</shipperPhone>
  <consigneeAddress>sample string 12</consigneeAddress>
  <consigneeName>sample string 13</consigneeName>
  <consigneeContact>sample string 14</consigneeContact>
  <consigneeEmail>sample string 15</consigneeEmail>
  <consigneePhone>sample string 16</consigneePhone>
  <poReference>sample string 17</poReference>
  <pickupDate>2025-01-18T05:17:24.3155679+00:00</pickupDate>
</FreightCreateShipmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FreightCreateShipmentResponse
Name Type Description Additional information
loadId integer

Response Formats

application/json, text/json

Sample: 
{
  "loadId": 1
}

application/xml, text/xml

Sample: 
<FreightCreateShipmentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <loadId>1</loadId>
</FreightCreateShipmentResponse>