Shipment Create and Mark Dispatched

This REST API is used to create shipping packages in Uniware and mark them dispatched.

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/createAndDispatchBySaleOrderItemCode
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": "", // Mandatory
    "saleOrderItemInfo": {
        "saleOrderItem": [    // Mandatory
            {
                "code": "",
                "customFieldValues": [
                    {
                        "name": "string",
                        "value": "string"
                    },
                    {
                        "name": "string",
                        "value": "string"
                    }
                ]
            },
            {
                "code": "",
                "customFieldValues": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    },
    "shippingPackageInfo": {
        "trackingNumber":"",
        "shippingProviderCode":"",
        "shippingPackageCode":"",
        "markDispatchedOnChannel": false,
        "customFieldValues": [
            {
                "name": "string",
                "value": "string"
            }
        ]

    },
    "invoiceInfo": {
        "invoiceCode":"",
        "taxInformation": {
            "productTaxes":[ // Mandatory
                {
                    "channelProductId":"", // Mandatory
                    "additionalInfo":"",
                    "taxPercentage":0,
                    "centralGst":0,
                    "stateGst":0,
                    "unionTerritoryGst":0,
                    "integratedGst":0,
                    "compensationCess":0,
                    "customFieldValues": [
                        {
                            "name": "string",
                            "value": "string"
                        }
                    ]

                }
            ]
        }
    }
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	Sale order code	Yes	-
2	saleOrderItemInfo	object	Sale order item info	Yes	-
2	saleOrderItemCodes	list	Sale order item codes	Yes	-
3	shippingPackageInfo	object	Shipping package code	No	check payload
4	trackingNumber	string	Tracking no.	No	-
5	shippingProviderCode	string	Shipping provider code	No	-
6	shippingPackageCode	string	Shipping package code	No	-
7	markDispatchedOnChannel	boolean	To mark dispatched on channel	No	if applicable
8	invoiceInfo	object	Shipping package code	-	check payload

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"
      }
   ],
   "shippingPackageCodes": [
      "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	shippingPackageCodes	list	List of shipping package codes	-

Error Codes

Refer Response Codes section to know about specific errors codes.