Allocate Courier for Reverse Pick-up

This REST API is used to allocate courier for a reverse pick-up (CIR) for a returned order item 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/oms/reversePickup/assignReverseProvider
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

{
    "reversePickupCodes":[
        "RPP1000087","RPP1000101","RPP1000109"
    ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	reversePickupCodes	list	List of reverse pick-up codes	Yes	-

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"
      }
   ],
   "assignedRVP": [],
    "alreadyAssignedRVP": [
        {
            "reversePickupCode": "RPP1000087",
            "shippingProviderCode": "TRACKING1",
            "trackingNumber": "gahdfgjahf"
        },
        {
            "reversePickupCode": "RPP1000101",
            "shippingProviderCode": "TRACKING1",
            "trackingNumber": "akhdkjahdfggh"
        }
    ],
    "manualRVPS": [],
    "errorneousRVP": [
        "RPP1000109"
    ]
}

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	-
5	assignedRVP	list	List of Reverse pick-up codes with assigned tracking Number by API	-
6	alreadyAssignedRVP	list	List of Reverse pick-up codes with already assigned tracking Number	-
6.1	reversePickupCode	string	Reverse pickup code	-
6.2	shippingProviderCode	string	Shipping provider code	-
6.3	trackingNumber	string	Tracking Number	-
7	manualRVPS	list	List of Reverse pick-up codes with Manual tracking Number to be assigned	-
8	errorneousRVP	list	List of Reverse pick-up codes having error in tracking Number assigning	-

Error Codes

Refer Response Codes section to know about specific errors codes.