Files
medusa-store/www/docs/content/user-guide/orders/claims.mdx
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770)
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

174 lines
9.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
sidebar_position: 9
description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Order's Claims
In this document, youll learn what claims are, how to create them, and more.
## Overview
If a customer receives a faulty or incorrect item(s) for an order they placed, you can create a claim to either refund or replace the item(s).
When a claim is created, you can choose whether the claim will be resolved through a refund or by replacing the item(s).
---
## Create a Claim
:::caution
If you create a claim of type Refund, a refund is issued to the customer right after the claim is created. Before you can create a claim for an order, you must capture the orders payment, and create fulfillment in the order for the items included in the claim.
:::
:::info
The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
1. Open the order details page.
2. In the Timeline section, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right.
3. Click on Register Claim in the dropdown.
4. In the new window that opens:
- Choose the items you want to create the claim for. For each item you pick, you must select the reason for the claim:
- Click on the Select Reason button below the item.
- Choose the Reason from the options in the Reason field.
- Optionally add a Note or upload images as part of the reason.
- Click on the Add button.
- Choose the Shipping method to use to return the item.
- You can add a custom price for the shipping method by clicking on the Add custom price button.
- You can remove the custom price by clicking on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon next to the price.
- For the Location field, you can optionally choose the location that the items should be returned to.
- Choose whether the type of the claim is “Refund” or “Replace”. If you choose “Replace”:
- Choose the products you want to send to the customer by clicking Add Product and choosing the product you want to add.
- You can remove a product from the “items to send” list by clicking on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
- If you want to send the items to another address, click on “Ship to a different address” and fill out the shipping address info.
- Choose the Shipping Method that will be used to deliver the replacement items.
- If you dont want the customer to receive an email that a claim has been created, uncheck the “Send notifications” checkbox.
5. Once youre done, click on the Complete button.
---
## View Claim Details
To view an orders claim details:
1. Open the order details page.
2. In the Timeline section, find the claim and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
3. Click on More Details in the dropdown.
---
## Manage a Claims Returns
### Receive a Claims Return
To mark a claims return as received:
1. Open the order details page.
2. In the Timeline section, find the return requested.
3. Click on the Receive Return button.
4. Check or uncheck the items that have been received.
5. Click the Complete button.
### Cancel a Claims Return
:::caution
Canceling a return cant be undone.
:::
To cancel a return of a claim:
1. Open the order details page.
2. In the Timeline section, find the return requested and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
3. Click on “Cancel return” in the dropdown.
---
## Manage a Claims Fulfillments
:::caution
This section only applies if the Claims type is Replace.
:::
### Create a Fulfillment for a Claim
You can create fulfillment for items in the claim that you are sending to the customer as a replacement. You can create more than one fulfillment, with each having at least one item.
To create a fulfillment for a claim:
1. Open the order details page.
2. In the Timeline section, find the claim and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
3. Click on Fulfill Claim in the dropdown.
4. In the window that opens:
- Choose the items you want to fulfill. You can change the quantity of the items youre fulfilling using the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> and <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons.
- Optionally add under Metadata any additional information that might be necessary for the fulfillment.
- If you dont want the customer to receive an email that a fulfillment for the claim items has been created, uncheck the “Send notifications” checkbox.
5. Once youre done, click on the Complete button.
### Mark a Claims Fulfillment Shipped
To mark a claims fulfillment as shipped:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to mark as shipped. A claims fulfillments title should be prefixed with “Claim fulfillment”.
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to it.
5. Click on Mark Shipped in the dropdown.
6. In the new window that opens:
- Enter a tracking number for the shipment.
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
- If you dont want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
7. Once youre done, click the Complete button.
Shipment details can be seen in the Timeline section.
### Cancel a Claims Fulfillment
:::caution
If you cancel a fulfillment, it cant be reverted. Only a fulfillment that hasnt been marked as shipped can be canceled.
:::
To cancel a claims fulfillment:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to cancel. A claims fulfillments title should be prefixed with “Claim fulfillment”.
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to it.
5. Click on Cancel Fulfillment in the dropdown.
6. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
---
## Cancel a Claim
### For Refund Claims
A claim of type Refund can be canceled by just [canceling the return of the claim](#cancel-a-claims-return). However, the refund can not be reverted.
### For Replace Claims
:::caution
Canceling a claim cant be undone. The [return of the claim must be canceled](#cancel-a-claims-return) before the claim itself is canceled.
:::
To cancel a claim of type Replace:
1. Open the order details page.
2. In the Timeline section, find the claim and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
3. Click on Cancel Claim in the dropdown.
4. Confirm canceling the fulfillment by clicking the “Yes, remove” button in the pop-up.