Get Started
Product
Resources
Tools & SDKs
Framework
Reference

CreateOrderChangeActionDTO

The data of the order change action to be created.

actionChangeActionType

The type of action.

order_change_idstringOptional

The associated order change's ID.

order_idstringOptional

The associated order's ID.

return_idstringOptional

The associated return's ID.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange's ID.

versionnumberOptional

The version of the order change action. Once the order change action is confirmed, this becomes the order's version.

referencestringOptional

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

reference_idstringOptional

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

internal_notenull | stringOptional

The internal note of the order change action.

amountBigNumberInputOptional

The amount of the order change action.

detailsRecord<string, unknown>Optional

The details of the order change action. This could include the returned items or their changed quantity, based on the type of this action.

appliedbooleanOptional

Whether the action has been applied.

Was this page helpful?

Edit this page