Create Reason Codes

ReasonCodeCreateReasonCodesResponse ReasonCodes.CreateReasonCodes(, )

POST/api/v2/public/reasoncodes

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

ParametersExpand Collapse

ReasonCodeCreateReasonCodesParams parameters

required IReadOnlyList<ReasonCode> reasonCodes

Body param: List of reason codes to create or update.

required Int DefaultReviewStatus

Default review status value. Required.

formatint32

required Boolean IsCommentMandatory

Indicates if comment is mandatory. Required.

required Boolean IsGain

Indicates if this is a gain reason code. Required.

required Boolean IsImageMandatory

Indicates if image is mandatory. Required.

required Boolean IsLoss

Indicates if this is a loss reason code. Required.

required Boolean IsOrderNumberMandatory

Indicates if order number is mandatory. Required.

required Boolean IsPickingList

Indicates if used for picking list. Required.

required Boolean IsSalesOrderDiscount

Indicates if used for sales order discount. Required.

required Boolean IsStore

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

required Int ReasonCode

Reason code identifier. Required.

formatint32

required string ReasonCodeDescription

Reason code description. Required. Max length: 250.

maxLength250

minLength1

required ReasonCodeType ReasonCodeType

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:

string? CodeDescription

Optional additional code description. Max length: 500.

maxLength500

Boolean flush

Query param: When true, existing reason codes are flushed before inserting.

ReturnsExpand Collapse

class ReasonCodeCreateReasonCodesResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create Reason Codes

ReasonCodeCreateReasonCodesParams parameters = new()
{
    ReasonCodes =
    [
        new()
        {
            DefaultReviewStatus = 0,
            IsCommentMandatory = true,
            IsGain = false,
            IsImageMandatory = false,
            IsLoss = true,
            IsOrderNumberMandatory = false,
            IsPickingList = false,
            IsSalesOrderDiscount = false,
            IsStore = true,
            ReasonCode = 101,
            ReasonCodeDescription = "Damaged on arrival",
            ReasonCodeType = ReasonCodeType.1,
            CodeDescription = "Used when product arrives damaged",
        },
    ],
};

var response = await client.ReasonCodes.CreateReasonCodes(parameters);

Console.WriteLine(response);

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

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

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

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}