Create or update public v2 reason codes

reason_codes.create_reason_codes() -> ReasonCodeCreateReasonCodesResponse

POST/api/v2/public/reasoncodes

Creates or updates reason codes. See request schema for required fields and enum details.

ParametersExpand Collapse

reason_codes: Iterable[ReasonCode]

List of reason codes to create or update.

default_review_status: int

Default review status value. Required.

formatint32

is_comment_mandatory: bool

Indicates if comment is mandatory. Required.

is_gain: bool

Indicates if this is a gain reason code. Required.

is_image_mandatory: bool

Indicates if image is mandatory. Required.

is_loss: bool

Indicates if this is a loss reason code. Required.

is_order_number_mandatory: bool

Indicates if order number is mandatory. Required.

is_picking_list: bool

Indicates if used for picking list. Required.

is_sales_order_discount: bool

Indicates if used for sales order discount. Required.

is_store: bool

Indicates if the reason code is store-visible. Required.

reason_code: int

Reason code identifier. Required.

formatint32

reason_code_description: str

Reason code description. Required. Max length: 250.

maxLength250

minLength1

reason_code_type: Literal[1, 2, 3, 6 more]

Allowed values:
1 = LossReasonCode (Loss Reason Code)
2 = RejectionReasonCode (Rejection Reason Code)
3 = MovementReasonCode (Movement Reason Code)
4 = SalesOrderDiscountReasonCode (Sales Order Discount Reason Code)
5 = LocationTags (Location Tags Code)
6 = CountReasonCode (Count Reason Code)
7 = GainLossReasonCode (Gain Loss Code)
8 = SalesOrderTypeReasonCode (Sales Order Type)
9 = DeliveryOrderTypeReasonCode (Delivery Order Type)

formatint32

One of the following:

code_description: Optional[str]

Optional additional code description. Max length: 500.

maxLength500

flush: Optional[bool]

When true, existing reason codes are flushed before inserting.

ReturnsExpand Collapse

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.

Create or update public v2 reason codes

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.create_reason_codes(
    reason_codes=[{
        "reason_code": 101,
        "reason_code_description": "Damaged on arrival",
        "is_store": True,
        "code_description": "Used when product arrives damaged",
        "is_loss": True,
        "is_comment_mandatory": True,
        "is_image_mandatory": False,
        "is_order_number_mandatory": False,
        "is_picking_list": False,
        "is_sales_order_discount": False,
        "default_review_status": 0,
        "reason_code_type": 1,
        "is_gain": False,
    }],
)
print(response.success)

{
  "success": true,
  "data": "data",
  "message": "message"
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}