API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Reason Codes

Retrieves a list of reason codes, optionally filtered by search text.

GET/api/v2/public/reasoncodes

Create or update public v2 reason codes

POST/api/v2/public/reasoncodes

ModelsExpand Collapse

ReasonCodeListReasonCodesResponse = array of object { code, is_comment_mandatory, is_gain, 13 more }

code: number

formatint32

is_comment_mandatory: boolean

is_gain: boolean

is_image_mandatory: boolean

is_loss: boolean

is_order_number_mandatory: boolean

is_picking_list: boolean

is_rollback_allowed: boolean

is_sales_order_discsount: boolean

is_store: boolean

reason_code_type: number

formatint32

review_status: number

formatint32

code_description: optional string

description: optional string

function_key: optional string

store_type: optional string

ReasonCodeCreateReasonCodesResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.