POST api/Integration/MarkDelivered

Use this method mark a shipment delivered

Request Information

URI Parameters

None.

Body Parameters

MarkDeliveredParm
NameDescriptionTypeAdditional information
FromCompanyGUID

string

None.

FromShipmentGUID

string

None.

FromShipmentNumber

integer

None.

ToCompanyGUID

string

None.

ToShipmentGUID

string

None.

DeliveryDateTimeUTC

date

None.

DeliverySignature

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FromCompanyGUID": "sample string 1",
  "FromShipmentGUID": "sample string 2",
  "FromShipmentNumber": 3,
  "ToCompanyGUID": "sample string 4",
  "ToShipmentGUID": "sample string 5",
  "DeliveryDateTimeUTC": "2024-09-19T09:35:13.5228702-07:00",
  "DeliverySignature": "sample string 7"
}

application/xml, text/xml

Sample:
<MarkDeliveredParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <DeliveryDateTimeUTC>2024-09-19T09:35:13.5228702-07:00</DeliveryDateTimeUTC>
  <DeliverySignature>sample string 7</DeliverySignature>
  <FromCompanyGUID>sample string 1</FromCompanyGUID>
  <FromShipmentGUID>sample string 2</FromShipmentGUID>
  <FromShipmentNumber>3</FromShipmentNumber>
  <ToCompanyGUID>sample string 4</ToCompanyGUID>
  <ToShipmentGUID>sample string 5</ToShipmentGUID>
</MarkDeliveredParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

boolean

None.

ErrorMessage

The error message if method call was not successful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>