PUT api/ShipmentStop/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
PutStopBindingViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressId | integer |
Required |
|
| CompanyName | string |
None. |
|
| TypeId | integer |
Required |
|
| StreetAddress | string |
None. |
|
| ContactName | string |
None. |
|
| Phone | string |
None. |
|
| Fax | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| ZipCode | string |
None. |
|
| Country | string |
None. |
|
| string |
None. |
||
| ActualArrivalDate | date |
None. |
|
| ActualDepartDate | date |
None. |
|
| AppointmentDateFrom | date |
None. |
|
| AppointmentDateTo | date |
None. |
|
| ScheduleDateFrom | date |
None. |
|
| ScheduleDateTo | date |
None. |
|
| Instruction | string |
None. |
|
| ReferenceNumber | string |
None. |
|
| VesselEtaDate | date |
None. |
|
| AvailableEtaDate | date |
None. |
|
| IsDropRecovery | boolean |
None. |
|
| DropDate | date |
None. |
|
| RecoveryDate | date |
None. |
|
| LoadedDate | date |
None. |
|
| DepartureDate | date |
None. |
|
| DeliveryAppointmentFromDate | date |
None. |
|
| DeliveryAppointmentToDate | date |
None. |
|
| Pod | string |
None. |
|
| ShipDate | date |
None. |
|
| MustArriveByDate | date |
None. |
|
| DeliveryNumber | string |
None. |
|
| PickupNumber | string |
None. |
|
| SealNumber | string |
None. |
|
| SpecialReq | Collection of string |
None. |
|
| IsAppointed | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"AddressId": 1,
"CompanyName": "sample string 2",
"TypeId": 3,
"StreetAddress": "sample string 4",
"ContactName": "sample string 5",
"Phone": "sample string 6",
"Fax": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"ZipCode": "sample string 10",
"Country": "sample string 11",
"Email": "sample string 12",
"ActualArrivalDate": "2025-12-05T23:15:25.2287656-08:00",
"ActualDepartDate": "2025-12-05T23:15:25.2287656-08:00",
"AppointmentDateFrom": "2025-12-05T23:15:25.2287656-08:00",
"AppointmentDateTo": "2025-12-05T23:15:25.2287656-08:00",
"ScheduleDateFrom": "2025-12-05T23:15:25.2287656-08:00",
"ScheduleDateTo": "2025-12-05T23:15:25.2297712-08:00",
"Instruction": "sample string 13",
"ReferenceNumber": "sample string 14",
"VesselEtaDate": "2025-12-05T23:15:25.2297712-08:00",
"AvailableEtaDate": "2025-12-05T23:15:25.2297712-08:00",
"IsDropRecovery": true,
"DropDate": "2025-12-05T23:15:25.2297712-08:00",
"RecoveryDate": "2025-12-05T23:15:25.2297712-08:00",
"LoadedDate": "2025-12-05T23:15:25.2297712-08:00",
"DepartureDate": "2025-12-05T23:15:25.2307714-08:00",
"DeliveryAppointmentFromDate": "2025-12-05T23:15:25.2307714-08:00",
"DeliveryAppointmentToDate": "2025-12-05T23:15:25.2307714-08:00",
"Pod": "sample string 15",
"ShipDate": "2025-12-05T23:15:25.2307714-08:00",
"MustArriveByDate": "2025-12-05T23:15:25.2307714-08:00",
"DeliveryNumber": "sample string 16",
"PickupNumber": "sample string 17",
"SealNumber": "sample string 18",
"SpecialReq": [
"sample string 1",
"sample string 2"
],
"IsAppointed": true
}
application/xml, text/xml
Sample:
<PutStopBindingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shipments.Models.Stops">
<ActualArrivalDate>2025-12-05T23:15:25.2287656-08:00</ActualArrivalDate>
<ActualDepartDate>2025-12-05T23:15:25.2287656-08:00</ActualDepartDate>
<AddressId>1</AddressId>
<AppointmentDateFrom>2025-12-05T23:15:25.2287656-08:00</AppointmentDateFrom>
<AppointmentDateTo>2025-12-05T23:15:25.2287656-08:00</AppointmentDateTo>
<AvailableEtaDate>2025-12-05T23:15:25.2297712-08:00</AvailableEtaDate>
<City>sample string 8</City>
<CompanyName>sample string 2</CompanyName>
<ContactName>sample string 5</ContactName>
<Country>sample string 11</Country>
<DeliveryAppointmentFromDate>2025-12-05T23:15:25.2307714-08:00</DeliveryAppointmentFromDate>
<DeliveryAppointmentToDate>2025-12-05T23:15:25.2307714-08:00</DeliveryAppointmentToDate>
<DeliveryNumber>sample string 16</DeliveryNumber>
<DepartureDate>2025-12-05T23:15:25.2307714-08:00</DepartureDate>
<DropDate>2025-12-05T23:15:25.2297712-08:00</DropDate>
<Email>sample string 12</Email>
<Fax>sample string 7</Fax>
<Instruction>sample string 13</Instruction>
<IsAppointed>true</IsAppointed>
<IsDropRecovery>true</IsDropRecovery>
<LoadedDate>2025-12-05T23:15:25.2297712-08:00</LoadedDate>
<MustArriveByDate>2025-12-05T23:15:25.2307714-08:00</MustArriveByDate>
<Phone>sample string 6</Phone>
<PickupNumber>sample string 17</PickupNumber>
<Pod>sample string 15</Pod>
<RecoveryDate>2025-12-05T23:15:25.2297712-08:00</RecoveryDate>
<ReferenceNumber>sample string 14</ReferenceNumber>
<ScheduleDateFrom>2025-12-05T23:15:25.2287656-08:00</ScheduleDateFrom>
<ScheduleDateTo>2025-12-05T23:15:25.2297712-08:00</ScheduleDateTo>
<SealNumber>sample string 18</SealNumber>
<ShipDate>2025-12-05T23:15:25.2307714-08:00</ShipDate>
<SpecialReq xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</SpecialReq>
<State>sample string 9</State>
<StreetAddress>sample string 4</StreetAddress>
<TypeId>3</TypeId>
<VesselEtaDate>2025-12-05T23:15:25.2297712-08:00</VesselEtaDate>
<ZipCode>sample string 10</ZipCode>
</PutStopBindingViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.