cce2b3827e
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
146 lines
3.9 KiB
YAML
146 lines
3.9 KiB
YAML
title: Claim Order
|
|
description: >-
|
|
Claim Orders represent a group of faulty or missing items. Each claim order
|
|
consists of a subset of items associated with an original order, and can
|
|
contain additional information about fulfillments and returns.
|
|
type: object
|
|
required:
|
|
- canceled_at
|
|
- created_at
|
|
- deleted_at
|
|
- fulfillment_status
|
|
- id
|
|
- idempotency_key
|
|
- metadata
|
|
- no_notification
|
|
- order_id
|
|
- payment_status
|
|
- refund_amount
|
|
- shipping_address_id
|
|
- type
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The claim's ID
|
|
type: string
|
|
example: claim_01G8ZH853Y6TFXWPG5EYE81X63
|
|
type:
|
|
description: The claim's type
|
|
type: string
|
|
enum:
|
|
- refund
|
|
- replace
|
|
payment_status:
|
|
description: The status of the claim's payment
|
|
type: string
|
|
enum:
|
|
- na
|
|
- not_refunded
|
|
- refunded
|
|
default: na
|
|
fulfillment_status:
|
|
description: The claim's fulfillment status
|
|
type: string
|
|
enum:
|
|
- not_fulfilled
|
|
- partially_fulfilled
|
|
- fulfilled
|
|
- partially_shipped
|
|
- shipped
|
|
- partially_returned
|
|
- returned
|
|
- canceled
|
|
- requires_action
|
|
default: not_fulfilled
|
|
claim_items:
|
|
description: The items that have been claimed
|
|
type: array
|
|
items:
|
|
$ref: ./ClaimItem.yaml
|
|
additional_items:
|
|
description: >-
|
|
Refers to the new items to be shipped when the claim order has the type
|
|
`replace`
|
|
type: array
|
|
items:
|
|
$ref: ./LineItem.yaml
|
|
order_id:
|
|
description: The ID of the order that the claim comes from.
|
|
type: string
|
|
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
order:
|
|
description: An order object. Available if the relation `order` is expanded.
|
|
nullable: true
|
|
type: object
|
|
return_order:
|
|
description: >-
|
|
A return object. Holds information about the return if the claim is to be
|
|
returned. Available if the relation 'return_order' is expanded
|
|
nullable: true
|
|
type: object
|
|
shipping_address_id:
|
|
description: The ID of the address that the new items should be shipped to
|
|
nullable: true
|
|
type: string
|
|
example: addr_01G8ZH853YPY9B94857DY91YGW
|
|
shipping_address:
|
|
description: Available if the relation `shipping_address` is expanded.
|
|
nullable: true
|
|
$ref: ./Address.yaml
|
|
shipping_methods:
|
|
description: The shipping methods that the claim order will be shipped with.
|
|
type: array
|
|
items:
|
|
$ref: ./ShippingMethod.yaml
|
|
fulfillments:
|
|
description: The fulfillments of the new items to be shipped
|
|
type: array
|
|
items:
|
|
type: object
|
|
refund_amount:
|
|
description: The amount that will be refunded in conjunction with the claim
|
|
nullable: true
|
|
type: integer
|
|
example: 1000
|
|
canceled_at:
|
|
description: The date with timezone at which the claim was canceled.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|
|
deleted_at:
|
|
description: The date with timezone at which the resource was deleted.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|
|
no_notification:
|
|
description: >-
|
|
Flag for describing whether or not notifications related to this should be
|
|
send.
|
|
nullable: true
|
|
type: boolean
|
|
example: false
|
|
idempotency_key:
|
|
description: >-
|
|
Randomly generated key used to continue the completion of the cart
|
|
associated with the claim in case of failure.
|
|
nullable: true
|
|
type: string
|
|
externalDocs:
|
|
url: >-
|
|
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
|
description: Learn more how to use the idempotency key.
|