POST api/Integration/MarkPickedUp

Request Information

URI Parameters

None.

Body Parameters

MarkPickupParm
NameDescriptionTypeAdditional information
FromCompanyGUID

string

None.

FromShipmentGUID

string

None.

FromShipmentNumber

integer

None.

ToCompanyGUID

string

None.

ToShipmentGUID

string

None.

PickupDateTimeUTC

date

None.

Latitude

decimal number

None.

Longitude

decimal number

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",
  "PickupDateTimeUTC": "2024-12-27T23:22:43.2741193+00:00",
  "Latitude": 1.0,
  "Longitude": 1.0
}

application/xml, text/xml

Sample:
<MarkPickupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <FromCompanyGUID>sample string 1</FromCompanyGUID>
  <FromShipmentGUID>sample string 2</FromShipmentGUID>
  <FromShipmentNumber>3</FromShipmentNumber>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <PickupDateTimeUTC>2024-12-27T23:22:43.2741193+00:00</PickupDateTimeUTC>
  <ToCompanyGUID>sample string 4</ToCompanyGUID>
  <ToShipmentGUID>sample string 5</ToShipmentGUID>
</MarkPickupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

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/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>