Create or update public v2 reason codes

POST/api/v2/public/reasoncodes

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

Query ParametersExpand Collapse

flush: optional boolean

When true, existing reason codes are flushed before inserting.

Body ParametersJSONExpand Collapse

reason_codes: array of object { default_review_status, is_comment_mandatory, is_gain, 10 more }

List of reason codes to create or update.

default_review_status: number

Default review status value. Required.

formatint32

is_comment_mandatory: boolean

Indicates if comment is mandatory. Required.

is_gain: boolean

Indicates if this is a gain reason code. Required.

is_image_mandatory: boolean

Indicates if image is mandatory. Required.

is_loss: boolean

Indicates if this is a loss reason code. Required.

is_order_number_mandatory: boolean

Indicates if order number is mandatory. Required.

is_picking_list: boolean

Indicates if used for picking list. Required.

is_sales_order_discount: boolean

Indicates if used for sales order discount. Required.

is_store: boolean

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

reason_code: number

Reason code identifier. Required.

formatint32

reason_code_description: string

Reason code description. Required. Max length: 250.

maxLength250

minLength1

reason_code_type: 1 or 2 or 3 or 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 string

Optional additional code description. Max length: 500.

maxLength500

ReturnsExpand Collapse

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.

Create or update public v2 reason codes

curl https://api.colleqtive.net/api/v2/public/reasoncodes \
    -H 'Content-Type: application/json' \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" \
    -d '{
          "reason_codes": [
            {
              "default_review_status": 0,
              "is_comment_mandatory": true,
              "is_gain": false,
              "is_image_mandatory": false,
              "is_loss": true,
              "is_order_number_mandatory": false,
              "is_picking_list": false,
              "is_sales_order_discount": false,
              "is_store": true,
              "reason_code": 101,
              "reason_code_description": "Damaged on arrival",
              "reason_code_type": 1,
              "code_description": "Used when product arrives damaged"
            }
          ]
        }'

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

Returns Examples

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