Submit a partner claim

Requires Authorization: Bearer YOUR_PRIVATE_TOKEN from a backend and partner claims enabled by Mulberry for that retailer. All records are scoped to the token's retailer and visible orders. Submit customer incident details with optional evidence into Mulberry's existing adjudication workflow. No claim decision or payout instruction is accepted. A new reference returns 201, an identical retry returns 200, and reuse with different input returns 409. Initial evidence and the claim commit together. If processing_pending is true, the saved claim needs an identical POST retry to repair pending background dispatch. Normalized input (including received_at) and the same initial filenames/content must match; attachment order may differ. Retries remain valid after a claim changes status. Use the documents endpoint for later evidence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

API preview — rollout pending

This contract is published for integration planning. The new claims endpoints are not yet deployed. Before testing, confirm availability and partner-claims enablement with Mulberry for your staging or production account.

See Submit claims through the API for enablement, examples, retries, and reconciliation.

Body Params
string
required
length between 1 and 128

Your stable, retailer-scoped claim reference. Reuse the exact normalized payload and initial attachments when retrying. The same reference with different data returns 409; do not generate a new reference after a timeout.

string
required
length between 1 and 32

Public warranty ID from GET /api/v2/orders: data[].warranties[].id. This is not the order ID or an internal database ID.

length between 1 and 32

Covered unit ID from the same warranty's line_items[].id. Required for a multi-item warranty; may be omitted only when the warranty has exactly one covered unit.

date
required

Date the incident occurred (YYYY-MM-DD). A local date up to tomorrow in UTC is accepted to accommodate timezones.

string
required
length between 1 and 5000

What happened and the damage reported by the customer. Leading/trailing whitespace is removed.

Optional original time your system received the claim, as an ISO 8601 string with timezone. Defaults to Mulberry's receipt time. At most five minutes in the future.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Invalid JSON, field, query, attachment or multipart request. Extra input fields are rejected.

401

Missing or invalid private retailer bearer token.

403

Private retailer token required, retailer inactive, or partner claims not enabled.

404

Claim, warranty or covered item not found within this retailer's visible orders.

409

external_claim_id already used with different input, or warranty no longer claimable.

413

Entire request exceeds 10 MiB (including multipart overhead).

422

The covered item cannot take a claim (for example already replaced, removed, or incident before coverage begins). The response includes message and reason.

503

Temporary storage/conversion failure or another request is processing this claim. Retry the identical request with backoff; do not change external_claim_id.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json