POST api/LoadUpload

New/Update Load

Request Information

URI Parameters

None.

Body Parameters

Load Data

Name	Type	Additional information
Id	string	Required
Date	date	Required
LogisticGroupCode	string	Required
CarrierCode	string	Required
CarrierName	string	Required
StopList	Collection of LoadStop	Required

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Date": "2025-12-11T12:17:06.3836078+01:00",
  "LogisticGroupCode": "sample string 3",
  "CarrierCode": "sample string 4",
  "CarrierName": "sample string 5",
  "StopList": [
    {
      "StopNumber": 1,
      "OperationType": "sample string 2",
      "DroppedNumber": 3,
      "PickedNumber": 4,
      "LocationCode": "sample string 5",
      "LocationName": "sample string 6",
      "LocationLatitude": 1.0,
      "LocationLongitude": 1.0,
      "Deliveries": [
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3836078+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        },
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3836078+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        }
      ]
    },
    {
      "StopNumber": 1,
      "OperationType": "sample string 2",
      "DroppedNumber": 3,
      "PickedNumber": 4,
      "LocationCode": "sample string 5",
      "LocationName": "sample string 6",
      "LocationLatitude": 1.0,
      "LocationLongitude": 1.0,
      "Deliveries": [
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3836078+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        },
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3836078+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        }
      ]
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentUploadResult

Name	Type	Additional information
Uploads	Collection of ShipmentUploadData	None.
FailedUploads	Collection of DeliveryError	None.
Auth	boolean	None.
Error	boolean	None.
ErrorCode	string	None.
Authenticated	boolean	None.
AuthenticatedMessage	string	None.
ErrorDescription	string	None.
ErrorStackTrace	string	None.
ErrorInnerException	string	None.
ErrorInnerExceptionExtended	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Uploads": [
    {
      "RefId": "sample string 1",
      "AccountId": "eaa0487c-28c9-43ec-be81-c2fc574eeb07",
      "Date": "2025-12-11T12:17:06.3992316+01:00",
      "LogisticGroupName": "sample string 4",
      "CarrierName": "sample string 5",
      "CarrierCode": "sample string 6",
      "PurchaseDoc": "sample string 7",
      "Deliveries": [
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3992316+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        },
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3992316+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        }
      ]
    },
    {
      "RefId": "sample string 1",
      "AccountId": "eaa0487c-28c9-43ec-be81-c2fc574eeb07",
      "Date": "2025-12-11T12:17:06.3992316+01:00",
      "LogisticGroupName": "sample string 4",
      "CarrierName": "sample string 5",
      "CarrierCode": "sample string 6",
      "PurchaseDoc": "sample string 7",
      "Deliveries": [
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3992316+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        },
        {
          "Id": "sample string 1",
          "DeliveryNumber": "sample string 2",
          "Date": "2025-12-11T12:17:06.3992316+01:00",
          "PurchaseDoc": "sample string 4",
          "SoldToCode": "sample string 5",
          "SoldToName": "sample string 6",
          "SoldToFiscalIdCode": "sample string 7",
          "Items": [
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            },
            {
              "MaterialCode": "sample string 1",
              "MaterialName": "sample string 2",
              "Batch": "sample string 3",
              "MeasureUnit": "sample string 4",
              "Qty": 5.0
            }
          ]
        }
      ]
    }
  ],
  "FailedUploads": null,
  "Auth": true,
  "Error": true,
  "ErrorCode": "sample string 3",
  "Authenticated": true,
  "AuthenticatedMessage": "sample string 5",
  "ErrorDescription": "sample string 6",
  "ErrorStackTrace": "sample string 7",
  "ErrorInnerException": "sample string 8",
  "ErrorInnerExceptionExtended": "sample string 9"
}