How to Manage Claims

In this document, you’ll learn how to manage claims using the admin REST APIs.

Overview

Using Medusa’s claim admin REST APIs, you can manage claims and perform related admin functionalities.

Scenario

You want to add or use the following admin functionalities:

• View an order’s claims
• Manage claims, including creating, updating, and canceling claims.
• Manage a claim’s fulfillment, including creating a fulfillment, creating a shipment, and canceling a fulfillment.

Note

You can learn about managing returns part of a claim in the Manage Returns documentation.

---

Prerequisites

Medusa Components

It is assumed that you already have a Medusa backend installed and set up. If not, you can follow our quickstart guide to get started.

JS Client

This guide includes code snippets to send requests to your Medusa backend using Medusa’s JS Client, among other methods.

If you follow the JS Client code blocks, it’s assumed you already have Medusa’s JS Client installed and have created an instance of the client.

Medusa React

This guide also includes code snippets to send requests to your Medusa backend using Medusa React, among other methods.

If you follow the Medusa React code blocks, it's assumed you already have Medusa React installed and have used MedusaProvider higher in your component tree.

Authenticated Admin User

You must be an authenticated admin user before following along with the steps in the tutorial.

You can learn more about authenticating as an admin user in the API reference.

---

View Order’s Claims

To view an order’s claims, you can retrieve the order using the Get Order API Route and access the order’s claims:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.retrieve(orderId)
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminOrder } from "medusa-react"

const Order = () => {
  const { 
    order, 
    isLoading, 
  } = useAdminOrder(orderId)

  return (
    <div>
      {isLoading && <span>Loading...</span>}
      {order && (
        <>
          <span>{order.display_id}</span>
          {order.claims?.length > 0 && (
            <ul>
              {order.claims.map((claim) => (
                <li key={claim.id}>{claim.id}</li>
              ))}
            </ul>
          )}
        </>
      )}
      
    </div>
  )
}

export default Order

fetch(`<BACKEND_URL>/admin/orders/${orderId}`, {
  credentials: "include",
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X GET '<BACKEND_URL>/admin/orders/<ORDER_ID>' \
-H 'x-medusa-access-token: <API_TOKEN>'

This request requires the order’s ID as a path parameter.

The request returns the order as an object. In that object, you can access an array of claim objects using the property claims of the order object.

---

Create Claim

You can create a claim by sending a request to the Create Claim API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.createClaim(orderId, {
  type: "refund",
  claim_items: [
    {
      item_id,
      quantity: 1,
    },
  ],
})
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminCreateClaim } from "medusa-react"

type Props = {
  orderId: string
}

const CreateClaim = ({ orderId }: Props) => {
  const createClaim = useAdminCreateClaim(orderId)
  // ...

  const handleCreate = (itemId: string) => {
    createClaim.mutate({
      type: "refund",
      claim_items: [
        {
          item_id: itemId,
          quantity: 1,
        },
      ],
    }, {
      onSuccess: ({ order }) => {
        console.log(order.claims)
      }
    })
  }

  // ...
}

export default CreateClaim

fetch(`<BACKEND_URL>/admin/orders/${orderId}/claims`, {
  credentials: "include",
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "refund",
    claim_items: [
      {
        item_id,
        quantity: 1,
      },
    ],
  }),
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "type": "refund",
    "claim_items": [
      {
        "item_id": "<ITEM_ID>",
        "quantity": 1
      }
    ]
}'

This API Route requires the order ID to be passed as a path parameter.

In the request body, the following parameters are required:

• type: a string indicating the type of claim to be created. Its value can either be replace or refund. If the type is replace, you can pass the additional_items parameter with an array of new items to send to the customer. If the type is refund, you can pass the refund_amount parameter if you want to specify a custom refund amount.
• claim_items: an array of objects, each object being the item in the order that the claim is being created for. In the object, you must pass the following properties:
  • item_id: a string indicating the ID of the line item in the order.
  • quantity: a number indicating the quantity of the claim.

There are other optional parameters that you can pass. You can also pass a return reason for each of the claim items. You can learn about the optional request body parameters in the API reference.

Note

Learn how to manage return reasons in this documentation.

The request returns the updated order as an object. You can access the order’s claims using the claims property of the order object. The value of the claims property is an array of claim objects.

---

Update a Claim

You can update a claim by sending a request to the Update Claim API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.updateClaim(orderId, claimId, {
  no_notification: true,
})
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminUpdateClaim } from "medusa-react"

type Props = {
  orderId: string
  claimId: string
}

const Claim = ({ orderId, claimId }: Props) => {
  const updateClaim = useAdminUpdateClaim(orderId)
  // ...

  const handleUpdate = () => {
    updateClaim.mutate({
      claim_id: claimId,
      no_notification: false
    }, {
      onSuccess: ({ order }) => {
        console.log(order.claims)
      }
    })
  }

  // ...
}

export default Claim

fetch(
  `<BACKEND_URL>/admin/orders/${orderId}/claims/${claimId}`,
  {
    credentials: "include",
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      no_notification: true,
    }),
  }
)
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims/<CLAIM_ID>' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "no_notification": true
}'

This API Route requires the ID of the order and the claim to be passed as path parameters.

In the request body, you can pass any of the claim’s fields that you want to update as parameters. In the example above, the no_notification field is updated.

The request returns the updated order as an object. You can access the order’s claims using the claims property of the order object. The value of the claims property is an array of claim objects.

---

Manage a Claim’s Fulfillments

View Claim’s Fulfillments

Fulfillments are available on a claim object under the fulfillments property, which is an array of fulfillment objects.

Create Fulfillment

You can create a fulfillment for a claim by sending a request to the Create Claim Fulfillment API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.fulfillClaim(orderId, claimId, {
})
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminFulfillClaim } from "medusa-react"

type Props = {
  orderId: string
  claimId: string
}

const Claim = ({ orderId, claimId }: Props) => {
  const fulfillClaim = useAdminFulfillClaim(orderId)
  // ...

  const handleFulfill = () => {
    fulfillClaim.mutate({
      claim_id: claimId,
    }, {
      onSuccess: ({ order }) => {
        console.log(order.claims)
      }
    })
  }

  // ...
}

export default Claim

fetch(`<BACKEND_URL>/admin/orders/${orderId}/claims/${claimId}/fulfillments`, {
  credentials: "include",
  method: "POST",
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims/<CLAIM_ID>/fulfillments' \
-H 'x-medusa-access-token: <API_TOKEN>'

This API Route requires the order and claim IDs as path parameters.

In the request body, you can pass optional parameters such as metadata or no_notification. These parameters will be used to create the fulfillment. You can learn more about available request body parameters in the API reference.

The request returns the updated order as an object. You can access the order’s claims using the claims property of the order object. The value of the claims property is an array of claim objects.

Create a Shipment

You can create a shipment for a claim by sending a request to the Create Claim Shipment API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.createClaimShipment(orderId, claimId, {
  fulfillment_id,
})
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminCreateClaimShipment } from "medusa-react"

type Props = {
  orderId: string
  claimId: string
}

const Claim = ({ orderId, claimId }: Props) => {
  const createShipment = useAdminCreateClaimShipment(orderId)
  // ...

  const handleCreateShipment = (fulfillmentId: string) => {
    createShipment.mutate({
      claim_id: claimId,
      fulfillment_id: fulfillmentId,
    }, {
      onSuccess: ({ order }) => {
        console.log(order.claims)
      }
    })
  }

  // ...
}

export default Claim

fetch(`<BACKEND_URL>/admin/orders/${orderId}/claims/${claimId}/shipments`, {
  credentials: "include",
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    fulfillment_id,
  }),
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims/<CLAIM_ID>/shipments' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "fulfillment_id": "<FUL_ID>"
}'

This API Route requires the order and claim IDs as path parameters.

In the request body, it’s required to pass the fulfillment_id parameter, which is the ID of the fulfillment the shipment is being created for. You can pass other optional parameters, such as an array of tracking numbers. You can learn more in the API reference.

The request returns the updated order as an object. As mentioned before, a claim’s fulfillments can be accessed using the fulfillments property of a claim object. You can access the shipments, known as tracking links, of a fulfillment using the tracking_links property of a fulfillment object. The value of tracking_links is an array of tracking link objects.

You can alternatively access the tracking numbers using the tracking_numbers property of a fulfillment object, which is an array of strings.

You can access the status of a claim’s fulfillment using the fulfillment_status property of a claim object.

Cancel Fulfillment

Note

You can’t cancel a fulfillment that has a shipment

You can cancel a fulfillment by sending a request to the Cancel Fulfillment API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.cancelClaimFulfillment(
  orderId,
  claimId,
  fulfillmentId
)
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminCancelClaimFulfillment } from "medusa-react"

type Props = {
  orderId: string
  claimId: string
}

const Claim = ({ orderId, claimId }: Props) => {
  const cancelFulfillment = useAdminCancelClaimFulfillment(
    orderId
  )
  // ...

  const handleCancel = (fulfillmentId: string) => {
    cancelFulfillment.mutate({
      claim_id: claimId,
      fulfillment_id: fulfillmentId,
    }, {
      onSuccess: ({ order }) => {
        console.log(order.claims)
      }
    })
  }

  // ...
}

export default Claim

fetch(`<BACKEND_URL>/admin/orders/${orderId}/claims/${claimId}/fulfillments/${fulfillmentId}/cancel`, {
  credentials: "include",
  method: "POST",
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims/<CLAIM_ID>/fulfillments/<FUL_ID>/cancel' \
-H 'x-medusa-access-token: <API_TOKEN>'

This API Route requires the order, claim, and fulfillment IDs to be passed as path parameters.

The request returns the updated order as an object. You can access the claims using the claims property of the order object, which is an array of claim objects.

You can check the fulfillment status of a claim using the fulfillment_status property of the claim object.

---

Cancel Claim

Note

You can’t cancel a claim that has been refunded. You must also cancel the claim’s fulfillments and return first.

You can cancel a claim by sending a request to the Cancel Claim API Route:

• Medusa JS Client
• Medusa React
• Fetch API
• cURL

medusa.admin.orders.cancelClaim(orderId, claimId)
.then(({ order }) => {
  console.log(order.claims)
})

import { useAdminCancelClaim } from "medusa-react"

type Props = {
  orderId: string
  claimId: string
}

const Claim = ({ orderId, claimId }: Props) => {
  const cancelClaim = useAdminCancelClaim(orderId)
  // ...

  const handleCancel = () => {
    cancelClaim.mutate(claimId)
  }

  // ...
}

export default Claim

fetch(`<BACKEND_URL>/admin/orders/${orderId}/claims/${claimId}/cancel`, {
  credentials: "include",
  method: "POST",
})
.then((response) => response.json())
.then(({ order }) => {
  console.log(order.claims)
})

curl -L -X POST '<BACKEND_URL>/admin/orders/<ORDER_ID>/claims/<CLAIM_ID>/cancel' \
-H 'x-medusa-access-token: <API_TOKEN>'

This API Route requires the order and claim IDs as path parameters.

The request returns the updated order as an object. You can access the claims using the claims property of the order object, which is an array of claim objects.

---

See Also

• How to manage returns
• How to manage orders