Create Reverse Pick-up

This REST API is used to create a reverse pick-up 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/create
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

{
   "saleOrderCode": "SO00159",
   "reversePickItems": [
      {
         "saleOrderItemCode": "W-04-0",
         "reason": "Not Good Item",
         "reversePickupAlternate": {
            "itemSku": "W-04",
            "totalPrice": 1050,
            "sellingPrice": 1000,
            "discount": 100,
            "shippingCharges": 50,
            "prepaidAmount": 0
         }
      }
   ],
   "shippingAddress": {
      "id": "NK01",
      "name": "Nishant",
      "addressLine1": "C-3/116",
      "addressLine2": "Sector-11",
      "city": "Delhi",
      "state": "Delhi",
      "country": "India",
      "pincode": "110085",
      "phone": "9999999999",
      "email": "abc123"
   },
   "pickupAddress": {
      "id": "NK01",
      "name": "Nishant",
      "addressLine1": "C-3/116",
      "addressLine2": "Sector-11",
      "city": "Delhi",
      "state": "Delhi",
      "country": "India",
      "pincode": "110085",
      "phone": "9999999999",
      "email": "abc123"
   },
   "actionCode": "WAC",
   "reversePickupCode": "NG009",
   "customFieldValues": [
      {
         "name": "string",
         "value": "string"
      }
   ],
   "pickupInstruction": "string",
   "trackingNumber": "string",
   "shippingProviderCode": "string",
   "dimension": {
      "boxLength": 1,
      "boxWidth": 1,
      "boxHeight": 1,
      "boxWeight": 1
   }
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 saleOrderCode string Sale order code Yes Eg: SO00159
2 reversePickItems list List of reverse pick-up items Yes -
2.1 saleOrderItemCode string Sale order item code Yes Eg: W-04-0
2.2 reason string Reason for return Yes Max chars: 500
2.3 reversePickupAlternate object Details of item to be delivered during reverse pick-up No -
2.3.1 itemSKU string Item SKU code Yes Eg.: Bharat4
2.3.2 totalPrice number Total price (selling price + shipping or any other charges) Yes -
2.3.3 sellingPrice number Selling price Yes -
2.3.4 discount number Discount price No -
2.3.5 shippingCharges number Shipping charges No -
2.3.6 prepaidAmount number Amount paid while ordering No -
3 shippingAddress object Delivery address details No -
3.1 id string Address ID Yes -
3.2 name string Name of receiver Yes Max chars: 100
3.3 addressLine1 string Precise address Yes Max chars: 500
3.4 addressLine2 string Additional address information No Max chars: 500
3.5 city string City name Yes Eg: Surat, Max chars: 100
3.6 state string State name Yes Eg: Gujrat, Max chars: 45
3.7 country string Country name No -
3.8 pincode string Area pincode (min. 6 digits) No Eg: 395006, Max chars: 45
3.9 phone string Contact no. Yes Max chars: 50
3.10 email string Email ID No Case insensitive, Max chars: 100
4 pickupAddress object Pick-up address details No -
4.1 id string Address ID Yes -
4.2 name string Name of customer Yes Max chars: 100
4.3 addressLine1 string Precise address Yes Max chars: 500
4.4 addressLine2 string Additional address information No Max chars: 500
4.5 city string City name Yes Eg: Surat, Max chars: 100
4.6 state string State name Yes Eg: Gujrat, Max chars: 45
4.7 country string Country name No -
4.8 pincode string Area pincode (min. 6 digits) No Eg: 395006, Max chars: 45
4.9 phone string Contact no. Yes Max chars: 50
4.10 email string Email ID No Case insensitive, Max chars: 100
5 actionCode string Action code Yes Fixed: WAC (stands for Wait for return and Cancel)
6 reversePickupCode string Reverse pick-up code No -
7 customFieldValues list Custom field details No -
7.1 name string Custom field name Yes -
7.2 value string Custom field value No -
8 pickupInstruction string Instructions for person coming for pick-up No -
9 trackingNumber string Reverse tracking no. No -
10 shippingProviderCode string Reverse shipping provider code No -
11 dimension object Shipment dimensions No -
11.1 boxLength integer Packing box length (in mm) No -
11.2 boxWidth integer Packing box width (in mm) No -
11.3 boxHeight integer Packing box height (in mm) No -
11.4 boxWeight integer Packing box weight (in kg) No -

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"
      }
   ],
   "reversePickupCode": "string",
   "saleOrderItemCodes": [
      "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 -
5 reversePickupCode string Reverse pick-up code -
6 saleOrderItemCodes string Sale order item code -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.