CreateOrderClaimDTO

The claim to be created.

order_idstring

The associated order's ID.

The type of the claim.

return_idstringOptional

The associated return's ID.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange's ID.

descriptionstringOptional

The description of the action.

internal_notestringOptional

The internal note of the action.

referencestringOptional

The name of the data model the action references. For example, return.

reference_idstringOptional

The ID of the record of the data model specified in reference. For example, if reference is return, the value is return_123.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

claim_itemsBaseOrderBundledItemActionsDTO & object[]Optional

The items of the claim.

The items to be sent to the customer in replacement, if the claim's type is replace.

shipping_methodsstring[] | Omit<CreateOrderShippingMethodDTO, "order_id">[]Optional

The shipping methods used to send the additional items to the customer, if the claim's type is replace.

return_shippingstring | Omit<CreateOrderShippingMethodDTO, "order_id">Optional

The shipping methods used to send the items to be returned from the customer, if the claim's type is replace.

refund_amountBigNumberInputOptional

The amount to be refunded.

no_notificationbooleanOptional

Whether the customer should receive notifications related to updates on the claim.

created_bynull | stringOptional

The id of the user that creates the order claim

Was this page helpful?