API-Based Claims Requiring Additional Information Updates

This guide shows how shippers can automate fetching and updating elgible Claims (shipments) with required information to file with carriers, without integrating their full manifest shipment-order data with ShipScience.

For UPS and FedEx, ShipScience requires product description and value (what's in the box) in order to file claims. USPS also requires recipient details, since that information is not available in the invoice. DHL eCom requires the recipient's name only.

Step 1: Turn AutoClaims on in SimpleClaims Settings

Turn AutoClaims on in SimpleClaims Settings (https://app.shipscience.com/simple_claims/config_default). Within 24 hours, ShipScience will create claim records for eligible shipments, and they'll be Draft - Incomplete Information status.

Step 2: Retrieve shipments via API

Retrieve via API the shipments in "incomplete_information" status using the list SimpleClaims endpoint, with the param sub_status. https://docs.shipscience.com/reference/get_api-v1-simple-claims

Step 3: Update claim records with required information

Update those claim records with required information using the update endpoint. https://docs.shipscience.com/reference/put_api-v1-simple-claims-tracking-number