> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# carrierClaimCreate

> File a carrier claim for a package in the store, found by its tracking number, as the return page or the order's fulfillment page would. Returns null if no package in the store has that number, or none of a kind the caller may file: return packages need the app's File carrier claims permission and outbound ones Receive order updates, and an API key has its maker's. Fails with `AMBIGUOUS_PACKAGE`, listing the matches in `extensions.candidates`, when more than one package does; pass a candidate's `packageId`, or `orderName`, to pick one. Fails with `CLAIM_EXISTS` if the package already has a claim, `CARRIER_NOT_SUPPORTED` if Redo can't claim with its carrier, and `NOT_CLAIMABLE` if its label wasn't bought through Redo. Fails with `EVIDENCE_REQUIRED` (422) when the claim needs evidence the request lacks, each listed in `extensions.missing` by its `evidence`, such as `PHOTOS`; new `evidence` values may be added, so handle unknown ones. A damage claim needs photos, which the API doesn't take yet. Fails with `CLAIM_IN_PROGRESS` (503) while another request is filing a claim for the same package; retry after a short wait.

**Required scopes:** [`carrier_claims_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-carrier_claims_write)

## Arguments

**input** `[CarrierClaimCreateInput!](/docs/api-reference/v3/reference/returns/carrier-claim-create-input)` *required*

The package to claim and what went wrong.

**fields**

**notes** `String`

What happened, in the store's words.

**orderName** `String`

Only match a package on this order, such as `#1001`. Needed for the second or later box of a multi-package outbound shipment.

**packageId** `String`

Only match this package, by the `packageId` an `AMBIGUOUS_PACKAGE` error listed.

**reason** `[CarrierClaimReason!](/docs/api-reference/v3/reference/returns/carrier-claim-reason)` *required*

What went wrong. `DAMAGED` fails with `EVIDENCE_REQUIRED` until the API takes photos.

**trackingNumber** `String!` *required*

The package's carrier tracking number, matched in the store as typed or upper-cased with spaces removed.

## Returns

**carrierClaimCreate** `[CarrierClaim](/docs/api-reference/v3/reference/returns/carrier-claim)`

A claim the store filed with a carrier for a lost, late, stolen, or damaged package.

**fields**

**carrier** `String!` *required*

The carrier's code, such as `USPS` or `FedEx`.

**id** `ID!` *required*

The id of this claim.

**kind** `[CarrierClaimKind!](/docs/api-reference/v3/reference/returns/carrier-claim-kind)` *required*

Whether the package was a return or an outbound package.

**notes** `String`

What happened, as the store described it.

**orderName** `String!` *required*

The name of the order the package belongs to.

**reason** `[CarrierClaimReason!](/docs/api-reference/v3/reference/returns/carrier-claim-reason)` *required*

What went wrong with the package.

**status** `[CarrierClaimStatus!](/docs/api-reference/v3/reference/returns/carrier-claim-status)` *required*

Where the claim is with Redo and the carrier.

**submittedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the claim was filed with Redo.

**trackingNumber** `String!` *required*

The claimed package's carrier tracking number.

## Example

```graphql theme={null}
mutation {
  carrierClaimCreate(input: { ... }) {
    carrier
    id
    kind
    notes
    orderName
    reason
    status
    submittedAt
    # ...
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.