Skip to content
Colleqtive Developer
Get started
API Reference

Reason Codes

Retrieves a list of reason codes, optionally filtered by search text.
reason_codes.list_reason_codes(ReasonCodeListReasonCodesParams**kwargs) -> ReasonCodeListReasonCodesResponse
GET/api/v2/public/reasoncodes
Create or update public v2 reason codes
reason_codes.create_reason_codes(ReasonCodeCreateReasonCodesParams**kwargs) -> ReasonCodeCreateReasonCodesResponse
POST/api/v2/public/reasoncodes
ModelsExpand Collapse
List[ReasonCodeListReasonCodesResponseItem]
code: int
formatint32
is_comment_mandatory: bool
is_gain: bool
is_image_mandatory: bool
is_loss: bool
is_order_number_mandatory: bool
is_picking_list: bool
is_rollback_allowed: bool
is_sales_order_discsount: bool
is_store: bool
reason_code_type: int
formatint32
review_status: int
formatint32
code_description: Optional[str]
description: Optional[str]
function_key: Optional[str]
store_type: Optional[str]
class ReasonCodeCreateReasonCodesResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.