v1.038
Claims for wholesale orders shipped without a shipping label can no longer be filed through the public API.
File a Shipping Claim (POST /v1/integrations/claims/shipping) and File a Fulfillment Claim (POST /v1/integrations/claims/fulfillment) now reject wholesale orders shipped without a shipping label (e.g. LTL, or no shipping method). Claims for these orders need details that these endpoints do not collect, so they are filed in the ShipMonk app. Claims for all other orders, including wholesale orders shipped with a shipping label, work as before.
🚀 New Endpoints
None
🛠 Schema & Property Updates
Renamed Claim Schemas
The schemas used by the claim endpoints got new component names. Their values, fields and types are unchanged, so request payloads stay the same. Only clients that generate code from the component names will see new type names.
- ShipMonk_Claims_Claim_Enum_ClaimDocumentType is now ShipMonk_Claims_Claim_Enum_PublicApiClaimDocumentType (used by
documents[].documentType). - ShipMonk_Claims_Claim_Enum_FulfillmentClaimProductType is now ShipMonk_Claims_Claim_Enum_PublicApiFulfillmentClaimProductType (used by
products[].type). - ShipMonk_Claims_Claim_Input_DocumentInput is now ShipMonk_Claims_Claim_Input_PublicApi_ClaimDocumentInput, with the title
Claim Document Input(used bydocuments[]).
📖 Documentation & Constraints Changes
- File a Shipping Claim (
POST /v1/integrations/claims/shipping) - a request for a wholesale order shipped without a shipping label is rejected with400and the messageClaims for wholesale orders shipped without a shipping label cannot be filed via the public API. Please file the claim in the ShipMonk app.No claim is created. - File a Fulfillment Claim (
POST /v1/integrations/claims/fulfillment) - a request for a wholesale order shipped without a shipping label is rejected the same way.
No endpoints, fields or enum values were removed. The wire format of both claim endpoints is unchanged. The only behavior change is the rejection of wholesale orders shipped without a shipping label, so integrations that file claims only for other orders need no change.