docs: update order module's conceptual guides (#7893)

* fixes + add return document

* update order conceptual guides

* resolve todo

* re-generate files map
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-07-09 18:14:30 +03:00
1 parent d46f9fda21
commit 3e4a96a31c
13 files changed
+297 -338

No files matched your search

@@ -0,0 +1,58 @@
export const metadata = {
title: `Order Claim`,
}
# {metadata.title}
In this document, you’ll learn about order claims.
## What is a Claim?
When a customer receives a defective or incorrect item, the merchant can create a claim to refund or replace the item.
The [Claim data model](/references/order/models/Claim) represents a claim.
---
## Claim Type
The `Claim` data model has a `type` property whose value indicates the type of the claim:
- `refund`: the items are returned, and the customer is refunded.
- `replace`: the items are returned, and the customer receives new items.
---
## Old and Replacement Items
When the claim is created, a return is also created to handle receiving the old items from the customer.
<Note>
Learn more about returns in [this guide](../return/page.mdx).
</Note>
If the claim’s type is `replace`, replacement items are represented by the [ClaimItem data model](/references/order/models/ClaimItem).
---
## Claim Shipping Methods
An exchange uses shipping methods to send the replacement items to the customer. These methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderShippingMethod).
The items returned from the customer are handled by the associated return.
---
## Claim Refund
If the claim’s type is `refund`, the amount to be refunded is stored in the `refund_amount` property.
The [Transaction data model](/references/order/models/Transaction) represents the refunds made for the claim.
---
## How Claims Impact an Order’s Version
When an exchange is created, the order’s version is incremented.