Update Reverse Pick-up

This REST API is used to update any reverse pick-up for a return order item in Uniware with or without shipping provider details.

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/edit
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

{
    "reversePickupCode": "RPC1008867",
    "pickupInstruction": "Test",
    "trackingLink": "Link",
    "shippingCourier": "",
    "shippingProviderCode": "",
    "trackingNumber": "",
    "forcedCancelOnCourier": true,
    "pickUpAddress": {
        "id": "495979",
        "name": "testcustomer",
        "addressLine1": "Test Addres 1",
        "addressLine2": "",
        "city": "Jagadhri1",
        "state": "Haryana",
        "phone": "9999999999",
        "pincode": "135003"
        "country": "INDIA"
        "email": "xyz@gmail.com"
    },
    "dimension": {
        "boxLength": "91",
        "boxWidth": "91",
        "boxHeight": "91",
        "boxWeight": "91"
    },
      "customFields": [
        {
            "name": "DWA",
            "value": "11221"
        }
    ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	reversePickupCode	string	Reverse pickup code	Yes	Eg: RP0022
2	pickupInstruction	string	pickup Instruction message	Opt	-
3	trackingLink	string	trackingLink	Opt	-
4	shippingCourier	string	lastmile shippingCourier	Opt	-
5	shippingProviderCode	string	Shipping provider code	Opt	-
6	trackingNumber	string	Tracking no.	Opt	-
7	forcedCancelOnCourier	boolean	shipment values update RTS	Opt	Eg: true/false
8	pickUpAddress	Object	custmoer pickUp Address	Opt	-
8.1	id	string	ID	Opt	-
8.2	name	string	Customer Name	Opt	-
8.3	addressLine1	string	Precise address	Opt	-
8.4	addressLine2	string	Additional address info	Opt	-
8.5	city	string	City name	Opt	-
8.6	state	string	State name	Opt	-
8.7	phone	string	Contact no.	Opt	-
8.8	pincode	string	Area pincode	Opt	-
8.9	country	string	State name	Opt	-
8.10	email	string	Email address	Opt	-
9	dimension	Object	pickup dimension	Opt	-
9.1	boxLength	integer	Lenght of box	Opt	-
9.2	boxWidth	integer	Width of box	Opt	-
9.3	boxHeight	integer	Height of box	Opt	-
9.4	boxWeight	integer	Weight of box	Opt	-
10	customFields	string	Custom field details	Opt	-
10.1	name	string	Custom field name	Opt	-
10.2	value	string	Custom field value	Opt	-

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.