POST api/UpdateShipmentContainer_V1

Update shipment package Container ID

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Shipments.UpdateShipmentContainerRequest

Name	Description	Type	Additional information
WS_Key	Required - Webservice Key provided by 2ship support	string	None.
CarrierId	Optional - If provided it should match the shipment carrier id	integer	None.
FindByType	Required - Indicate what field is used in the search for updating the shipment with container ID	WS_Repository.Models.Requests.Shipments.FindByType	None.
LicencePlate	Required if FindByType = ByLicencePlate - Licence Plate number to identify the package/skid to update the Container ID	string	None.
TrackingNumber	Required if FindByType = ByTrackingNumber - Tracking Number to identify the package/skid to update the Container ID	string	None.
ContainerID	Required - Container ID to updated on the package/skid	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "CarrierId": 2,
  "FindByType": 0,
  "LicencePlate": "sample string 3",
  "TrackingNumber": "sample string 4",
  "ContainerID": "sample string 5"
}

application/xml, text/xml

Sample:

<UpdateShipmentContainerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Shipments">
  <CarrierId>2</CarrierId>
  <ContainerID>sample string 5</ContainerID>
  <FindByType>ByLicencePlate</FindByType>
  <LicencePlate>sample string 3</LicencePlate>
  <TrackingNumber>sample string 4</TrackingNumber>
  <WS_Key>sample string 1</WS_Key>
</UpdateShipmentContainerRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.Shipments.UpdateShipmentContainerRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Shipments.UpdateShipmentContainerResponse

Name	Description	Type	Additional information
SuccessfullyUpdated	Indicate if the update was successfully or not	boolean	None.
ErrorMessage	Error Message if the SuccessfullyUpdated = false	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SuccessfullyUpdated": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<UpdateShipmentContainerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Shipments">
  <ErrorMessage>sample string 2</ErrorMessage>
  <SuccessfullyUpdated>true</SuccessfullyUpdated>
</UpdateShipmentContainerResponse>