Create Picklist

This REST API is used to create the picklist 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 DESCRIPTION
Endpoint: /services/rest/v1/oms/picker/picklist/staging/manual/create Endpoint-1 This endpoint is used to create picklist (staging to invoicing destination)
Endpoint: /services/rest/v1/oms/picker/picklist/manual/create Endpoint-2 This endpoint is used to create picklist (direct to invoicing destination or direct to staging destination)
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

  • To create picklist (staging to invoicing destination) use Endpoint-1 with Payload 1 without destination parameter.
  • To create picklist (direct to invoicing destination or direct to staging destination) use Endpoint-2 with Payload 2 with destination parameter.

Payload 1

{

"shippingPackageCodes" : ["SP345400820","SP345400820"]

}

Payload 2

{

"shippingPackageCodes" : ["SP345400820","SP345400820"],
"destination" : "INVOICING"

}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 shippingPackageCodes string Shipping package code Yes -
2 destination string Destination code Yes, with Endpoint-2 only INVOICING or staging , case insensitive

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"
      }
   ],
   "picklist": {
        "id": 0,
        "code": "PK736",
        "username": null,
        "destination": null,
        "created": null,
        "status": null,
        "picklistItems": [],
        "address": null
    }
}

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 picklist object Picklist details -
5.1 id string ID -
5.2 code string Picklist ID -
5.3 username string username null
5.4 destination string destination null
5.5 created date Creation date null
5.6 status string Picklist status null
5.7 picklistItems string picklistItems null
5.8 address string address null

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.