Skip to content

Latest commit

 

History

History
55 lines (51 loc) · 3.17 KB

File metadata and controls

55 lines (51 loc) · 3.17 KB

ClaimOrder

Properties

Name Type Description Notes
id String The claim's ID
type TypeEnum The claim's type
paymentStatus PaymentStatusEnum The status of the claim's payment
fulfillmentStatus FulfillmentStatusEnum The claim's fulfillment status
claimItems List<ClaimItem> The items that have been claimed [optional]
additionalItems List<LineItem> Refers to the new items to be shipped when the claim order has the type `replace` [optional]
orderId String The ID of the order that the claim comes from.
order Object An order object. Available if the relation `order` is expanded. [optional]
returnOrder Object A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded [optional]
shippingAddressId String The ID of the address that the new items should be shipped to
shippingAddress Address [optional]
shippingMethods List<ShippingMethod> The shipping methods that the claim order will be shipped with. [optional]
fulfillments List<Object> The fulfillments of the new items to be shipped [optional]
refundAmount Integer The amount that will be refunded in conjunction with the claim
canceledAt OffsetDateTime The date with timezone at which the claim was canceled.
createdAt OffsetDateTime The date with timezone at which the resource was created.
updatedAt OffsetDateTime The date with timezone at which the resource was updated.
deletedAt OffsetDateTime The date with timezone at which the resource was deleted.
metadata Object An optional key-value map with additional details
noNotification Boolean Flag for describing whether or not notifications related to this should be send.
idempotencyKey String Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.

Enum: TypeEnum

Name Value
REFUND "refund"
REPLACE "replace"

Enum: PaymentStatusEnum

Name Value
NA "na"
NOT_REFUNDED "not_refunded"
REFUNDED "refunded"

Enum: FulfillmentStatusEnum

Name Value
NOT_FULFILLED "not_fulfilled"
PARTIALLY_FULFILLED "partially_fulfilled"
FULFILLED "fulfilled"
PARTIALLY_SHIPPED "partially_shipped"
SHIPPED "shipped"
PARTIALLY_RETURNED "partially_returned"
RETURNED "returned"
CANCELED "canceled"
REQUIRES_ACTION "requires_action"