Split Shipping Package

This REST API is used to split the shipping package into multiple shipping packages as per the bussiness need in Uniware, such as packet count,SKU and qty or saleorderitem wise etc.

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

{
  "shippingPackageCode": "VARA00017",
  "splitPackages": [
    {
      "packetNumber": 1,
      "items": [
        {
          "skuCode": "test",
          "quantity": 2,
          "saleOrderItemCodes": [
            "SO08233-0",
            "SO08233-1"
          ]
        }
      ]
    },
    {
      "packetNumber": 2,
      "items": [
        {
          "skuCode": "test",
          "quantity": 2,
          "saleOrderItemCodes": [
            "SO08233-2",
            "SO08233-3"
          ]
        }
      ]
    }
  ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	shippingPackageCode	string	Shipping package code	Yes	-
2	splitPackages	object	Details of split items	Yes	-
3	packetNumber	integer	Numbers of packets to be created as per logic	No	-
4	items	object	Item details	No	-
5	skuCode	integer	Sku code to be used in new package	No	-
6	quantity	object	Quantity of Item sku to be used in new package	No	-
6.1	saleOrderItemCodes	list	Use specifically in case of split package with SOIs	No	If SKU and qty are used then pass this list values, blank as []

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"
      }
   ],
    "splitNumberToShippingPackageCode": {
        "1": "VARA00018",
        "2": "VARA00019"
    }
}
}

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	shippingPackageFullDTO	object	Shipping package details	-

Error Codes

Refer Response Codes section to know about specific errors codes.