PUT api/shipments/UpdateClaim

updated isClaimed field for expired Claims

Request Information

URI Parameters

None.

Body Parameters

Collection of ShipmentsClaimUpdateRequest
Name Type Description Additional information
PackageTrackingNumber string

IsClaimed boolean

Request Formats

application/json, text/json

Sample:
[
  {
    "PackageTrackingNumber": "sample string 1",
    "IsClaimed": true
  },
  {
    "PackageTrackingNumber": "sample string 1",
    "IsClaimed": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfShipmentsClaimUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ShipmentsClaimUpdateRequest>
    <PackageTrackingNumber>sample string 1</PackageTrackingNumber>
    <IsClaimed>true</IsClaimed>
  </ShipmentsClaimUpdateRequest>
  <ShipmentsClaimUpdateRequest>
    <PackageTrackingNumber>sample string 1</PackageTrackingNumber>
    <IsClaimed>true</IsClaimed>
  </ShipmentsClaimUpdateRequest>
</ArrayOfShipmentsClaimUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentClaimUpdateResponse
Name Type Description Additional information
Errors Collection of ShipmentError

Response Formats

application/json, text/json

Sample:
{
  "Errors": [
    {
      "PackageTrackingNumber": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "PackageTrackingNumber": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ShipmentClaimUpdateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Errors>
    <ShipmentError>
      <PackageTrackingNumber>sample string 1</PackageTrackingNumber>
      <Message>sample string 2</Message>
    </ShipmentError>
    <ShipmentError>
      <PackageTrackingNumber>sample string 1</PackageTrackingNumber>
      <Message>sample string 2</Message>
    </ShipmentError>
  </Errors>
</ShipmentClaimUpdateResponse>