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

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

ParametersExpand Collapse
code: Optional[str]

Filter by reason code.

code_description: Optional[str]

Filter by reason code description.

function_key: Optional[str]

Filter by function key.

is_gain: Optional[bool]

Filter by gain-type reason codes.

is_loss: Optional[bool]

Filter by loss-type reason codes.

is_store: Optional[bool]

Filter by store-level reason codes.

ReturnsExpand Collapse
List[ReasonCodeListReasonCodesResponseItem]
code: Optional[int]
formatint32
code_description: Optional[str]
description: Optional[str]
function_key: Optional[str]
is_comment_mandatory: Optional[bool]
is_gain: Optional[bool]
is_image_mandatory: Optional[bool]
is_loss: Optional[bool]
is_order_number_mandatory: Optional[bool]
is_picking_list: Optional[bool]
is_rollback_allowed: Optional[bool]
is_sales_order_discsount: Optional[bool]
is_store: Optional[bool]
reason_code_type: Optional[int]
formatint32
review_status: Optional[int]
formatint32
store_type: Optional[str]

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

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.reason_codes.list_reason_codes()
print(response)
[
  {
    "code": 0,
    "code_description": "code_description",
    "description": "description",
    "function_key": "function_key",
    "is_comment_mandatory": true,
    "is_gain": true,
    "is_image_mandatory": true,
    "is_loss": true,
    "is_order_number_mandatory": true,
    "is_picking_list": true,
    "is_rollback_allowed": true,
    "is_sales_order_discsount": true,
    "is_store": true,
    "reason_code_type": 0,
    "review_status": 0,
    "store_type": "store_type"
  }
]
Returns Examples
[
  {
    "code": 0,
    "code_description": "code_description",
    "description": "description",
    "function_key": "function_key",
    "is_comment_mandatory": true,
    "is_gain": true,
    "is_image_mandatory": true,
    "is_loss": true,
    "is_order_number_mandatory": true,
    "is_picking_list": true,
    "is_rollback_allowed": true,
    "is_sales_order_discsount": true,
    "is_store": true,
    "reason_code_type": 0,
    "review_status": 0,
    "store_type": "store_type"
  }
]