Enable Custom Reason dropdown

This REST API is used to enable sellers to input Custom Reason dropdown, Maninly at order details page for return reasons at reverse pickup creation and Cancellation reason at cancellation action in Uniware.

Tip

It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Basic Information

NAME DETAILS
Endpoint: /services/rest/v1/uiCustomList/createOrUpdate
Request Type: POST
Level: Facility
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa
Header (Facility): facility code as in Uniware (refer FAQs)

Request Payload for Return Reason Dropdown

{
   "name" : "editSaleOrder:ReturnReason",
   "value" : "{\"Value1\":\"Value1\",\"Value2\":\"Value2\",\"Others\":\"Others\"}"
}

Request Payload for Cancellation Reason Dropdown

{
   "name" : "editSaleOrder:CancelReason",
   "value" : "{\"Value1\":\"Value1\",\"Value2\":\"Value2\",\"Others\":\"Others\"}"
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 name string For cancellation reason “editSaleOrder:CancelReason” and for return reason “editSaleOrder:ReturnReason” Yes Fixed, Must be passed as in format
2 value string List of reason vaules must be passed as in format e.g. {”All Product Ok”:”All Product Ok”,”Damaged Product”:”Damaged Product,”Others”:”Others”} Yes -

NOTE:

Kindly note that the key-value pairs in both action must be matched but name must be different for both cancellation reason and return reason.

Response Payload

{
   "successful": true,
   "message": "string",
   "errors": [
      {
         "code": 0,
         "fieldName": "string",
         "description": "string",
         "message": "string",
         "errorParams": {
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
         }
      }
   ],
   "warnings": [
      {
         "code": 0,
         "message": "string",
         "description": "string"
      }
   ]
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION NOTES
1 successful true Request success status -
2 message string Response message -
3 errors list List of errors (if any) -
3.1 code number Error code -
3.2 fieldName string Field with error -
3.3 description string Error description -
3.4 message string Error message -
3.5 errorParams object Parameters with error -
3.5.1 additionalProp1 object Parameter 1 with error -
3.5.2 additionalProp2 object Parameter 2 with error -
3.5.3 additionalProp3 object Parameter 3 with error -
4 warnings list List of warnings (if any) -
4.1 code number Warning code -
4.2 message string Warning message -
4.3 description string Warning description -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.