POST shipment/externalShipment

Action will make a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

Request Information

URI Parameters

None.

Body Parameters

External Shipment request object.

ExternalShipmentDto

Name	Description	Type	Additional information
CompanyCarrierId		string	None.
TrackingNumbers		string	None.
ShipDate		date	None.
ShipmentFromAddress	Ship From Address	Address	None.
ShipmentToAddress	Ship To address	Address	None.
EstimatedDeliveryDate		date	None.
Items		Collection of ExternalShipmentItemDto	None.
ProductDetails		Collection of ExternalShipmentProductDetailsDto	None.
ItnNumber		string	None.
TrackNote		string	None.
UserDefinedField		string	None.
Cost		string	None.
Service		string	None.
Carrier		string	None.
ReferenceOne		string	None.
ReferenceTwo		string	None.
Reference3		string	None.
Reference4		string	None.
Reference5		string	None.
Reference6		string	None.
OrderNumber		string	None.
Payer		string	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyCarrierId": "sample string 1",
  "TrackingNumbers": "sample string 2",
  "ShipDate": "2024-11-20T23:32:52.7168014-08:00",
  "ShipmentFromAddress": {
    "AttentionTo": "sample string 1",
    "City": "sample string 2",
    "CompanyId": "sample string 3",
    "Company": "sample string 4",
    "Country": "sample string 5",
    "Email": "sample string 6",
    "State": "sample string 7",
    "Street1": "sample string 8",
    "Street2": "sample string 9",
    "Phone": "sample string 10",
    "Zip": "sample string 11",
    "OrderType": "sample string 12"
  },
  "ShipmentToAddress": {
    "AttentionTo": "sample string 1",
    "City": "sample string 2",
    "CompanyId": "sample string 3",
    "Company": "sample string 4",
    "Country": "sample string 5",
    "Email": "sample string 6",
    "State": "sample string 7",
    "Street1": "sample string 8",
    "Street2": "sample string 9",
    "Phone": "sample string 10",
    "Zip": "sample string 11",
    "OrderType": "sample string 12"
  },
  "EstimatedDeliveryDate": "2024-11-20T23:32:52.7168014-08:00",
  "Items": [
    {
      "PackageQuantity": 1,
      "PackageType": 1,
      "TotalWeight": 2.1,
      "FreightClass": "sample string 3",
      "Length": 4.1,
      "Width": 5.1,
      "Height": 6.1,
      "Unit": "sample string 7",
      "Hazmat": true,
      "Nmfc": "sample string 9",
      "CommodityDescription": "sample string 10",
      "CustomerPackageId": "sample string 11",
      "AutoTransportDetail": {
        "Vin": "sample string 1",
        "BuyerId": "sample string 2",
        "Year": "sample string 3",
        "Stock": "sample string 4",
        "Make": "sample string 5",
        "PicturesLink": "sample string 6",
        "Model": "sample string 7",
        "Vehicle": "sample string 8",
        "VehicleCondition": 0,
        "HaulerType": 0
      }
    },
    {
      "PackageQuantity": 1,
      "PackageType": 1,
      "TotalWeight": 2.1,
      "FreightClass": "sample string 3",
      "Length": 4.1,
      "Width": 5.1,
      "Height": 6.1,
      "Unit": "sample string 7",
      "Hazmat": true,
      "Nmfc": "sample string 9",
      "CommodityDescription": "sample string 10",
      "CustomerPackageId": "sample string 11",
      "AutoTransportDetail": {
        "Vin": "sample string 1",
        "BuyerId": "sample string 2",
        "Year": "sample string 3",
        "Stock": "sample string 4",
        "Make": "sample string 5",
        "PicturesLink": "sample string 6",
        "Model": "sample string 7",
        "Vehicle": "sample string 8",
        "VehicleCondition": 0,
        "HaulerType": 0
      }
    }
  ],
  "ProductDetails": [
    {
      "Quantity": "sample string 1",
      "ItemNumber": "sample string 2",
      "Description": "sample string 3",
      "UnitPrice": "sample string 4",
      "HTSCode": "sample string 5",
      "Country": "sample string 6",
      "OrderNumber": "sample string 7",
      "Unit": "sample string 8",
      "DDTCUnit": "sample string 9",
      "PackageId": "sample string 10",
      "ExpectedDate": "2024-11-20T23:32:52.7177979-08:00",
      "RequiredArrivalDate": "2024-11-20T23:32:52.7177979-08:00",
      "ItemWeight": 1.0,
      "Quantity2": 1,
      "UnitPrice2": 1.0,
      "Quantity3": 1,
      "UnitPrice3": 1.0,
      "Quantity4": 1,
      "UnitPrice4": 1.0,
      "Eccn": "sample string 11",
      "LicenseNo": "sample string 12"
    },
    {
      "Quantity": "sample string 1",
      "ItemNumber": "sample string 2",
      "Description": "sample string 3",
      "UnitPrice": "sample string 4",
      "HTSCode": "sample string 5",
      "Country": "sample string 6",
      "OrderNumber": "sample string 7",
      "Unit": "sample string 8",
      "DDTCUnit": "sample string 9",
      "PackageId": "sample string 10",
      "ExpectedDate": "2024-11-20T23:32:52.7177979-08:00",
      "RequiredArrivalDate": "2024-11-20T23:32:52.7177979-08:00",
      "ItemWeight": 1.0,
      "Quantity2": 1,
      "UnitPrice2": 1.0,
      "Quantity3": 1,
      "UnitPrice3": 1.0,
      "Quantity4": 1,
      "UnitPrice4": 1.0,
      "Eccn": "sample string 11",
      "LicenseNo": "sample string 12"
    }
  ],
  "ItnNumber": "sample string 4",
  "TrackNote": "sample string 5",
  "UserDefinedField": "sample string 6",
  "Cost": "sample string 7",
  "Service": "sample string 8",
  "Carrier": "sample string 9",
  "ReferenceOne": "sample string 10",
  "ReferenceTwo": "sample string 11",
  "Reference3": "sample string 12",
  "Reference4": "sample string 13",
  "Reference5": "sample string 14",
  "Reference6": "sample string 15",
  "OrderNumber": "sample string 16",
  "Payer": "sample string 17"
}

Response Information

Resource Description

ShipmentResponse

Name	Description	Type	Additional information
Data	Shipment response object info	ShipmentResponseObject	None.
Code	Response code returned by api	HttpStatusCode	None.
Message	Human readable message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "RateId": "sample string 1",
    "ShipmentId": "sample string 2",
    "QuoteAmount": "sample string 3",
    "Documents": [
      {
        "Type": "sample string 1",
        "Format": "sample string 2",
        "Url": "sample string 3",
        "Number": "sample string 4"
      },
      {
        "Type": "sample string 1",
        "Format": "sample string 2",
        "Url": "sample string 3",
        "Number": "sample string 4"
      }
    ],
    "ZPLDocuments": [
      {
        "Type": "sample string 1",
        "Format": "sample string 2",
        "Url": "sample string 3",
        "Number": "sample string 4"
      },
      {
        "Type": "sample string 1",
        "Format": "sample string 2",
        "Url": "sample string 3",
        "Number": "sample string 4"
      }
    ],
    "TrackingNumbers": [
      "sample string 1",
      "sample string 2"
    ],
    "PickupNumber": "sample string 4",
    "Errors": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Code": 100,
  "Message": "sample string 1"
}