Create Invoice

This REST API is used to create invoice for a shipment 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/shippingPackage/createInvoice
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": "string",
   "commitBlockedInventory": true,
   "channelProductIdToTax": {
      "additionalProp1": {
         "channelProductId": "string",
         "additionalInfo": "string",
         "taxPercentage": 0,
         "centralGst": 0,
         "stateGst": 0,
         "unionTerritoryGst": 0,
         "integratedGst": 0,
         "compensationCess": 0,
         "customFieldValues": [
            {
               "name": "string",
               "value": "string"
            }
         ]
      },
      "additionalProp2": {
         "channelProductId": "string",
         "additionalInfo": "string",
         "taxPercentage": 0,
         "centralGst": 0,
         "stateGst": 0,
         "unionTerritoryGst": 0,
         "integratedGst": 0,
         "compensationCess": 0,
         "customFieldValues": [
            {
               "name": "string",
               "value": "string"
            }
         ]
      },
      "additionalProp3": {
         "channelProductId": "string",
         "additionalInfo": "string",
         "taxPercentage": 0,
         "centralGst": 0,
         "stateGst": 0,
         "unionTerritoryGst": 0,
         "integratedGst": 0,
         "compensationCess": 0,
         "customFieldValues": [
            {
               "name": "string",
               "value": "string"
            }
         ]
      }
   },
   "skipDetailing": true
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	shippingPackageCode	string	Shipping package code	Yes	-
2	commitBlockedInventory	boolean	-	No	Default: true
3	channelProductIdToTax	object	Channel product ID tax details	No	-
3.1	additionalProp1	object	Parameter 1 with error	No	-
3.1.1	channelProductId	string	Channel product ID	Yes	-
3.1.2	additionalInfo	string	Any additional information	No	-
3.1.3	taxPercentage	number	Tax percentage	No	Default: 0
3.1.4	centralGst	number	Central GST	No	Default: 0
3.1.5	stateGst	number	State GST	No	Default: 0
3.1.6	unionTerritoryGst	number	UT GST	No	Default: 0
3.1.7	integratedGst	number	Integrated GST	No	Default: 0
3.1.8	compensationCess	number	Compensation cess	No	-
3.1.9	customFieldValues	list	Custom field details	No	-
3.1.9.1	name	string	Custom field name	Yes	-
3.1.9.2	value	string	Custom field value	No	-
3.2	additionalProp2	object	Parameter 2 with error	No	-
3.2.1	channelProductId	string	Channel product ID	Yes	-
3.2.2	additionalInfo	string	Any additional information	No	-
3.2.3	taxPercentage	number	Tax percentage	No	Default: 0
3.2.4	centralGst	number	Central GST	No	Default: 0
3.2.5	stateGst	number	State GST	No	Default: 0
3.2.6	unionTerritoryGst	number	UT GST	No	Default: 0
3.2.7	integratedGst	number	Integrated GST	No	Default: 0
3.2.8	compensationCess	number	Compensation cess	No	-
3.2.9	customFieldValues	list	Custom field details	No	-
3.2.9.1	name	string	Custom field name	Yes	-
3.2.9.2	value	string	Custom field value	No	-
3.3	additionalProp3	object	Parameter 3 with error	No	-
3.3.1	channelProductId	string	Channel product ID	Yes	-
3.3.2	additionalInfo	string	Any additional information	No	-
3.3.3	taxPercentage	number	Tax percentage	No	Default: 0
3.3.4	centralGst	number	Central GST	No	Default: 0
3.3.5	stateGst	number	State GST	No	Default: 0
3.3.6	unionTerritoryGst	number	UT GST	No	Default: 0
3.3.7	integratedGst	number	Integrated GST	No	Default: 0
3.3.8	compensationCess	number	Compensation cess	No	-
3.3.9	customFieldValues	list	Custom field details	No	-
3.3.9.1	name	string	Custom field name	Yes	-
3.3.9.2	value	string	Custom field value	No	-
4	skipDetailing	boolean	true to skip detailing	No	Default: true

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"
      }
   ],
   "invoiceCode": "string",
   "shippingPackageCode": "string",
   "shippingLabelLink": "string",
   "invoiceDisplayCode":"string",
   "shippingPackageStatusCode": "PACKED",
   "autoPrintEnabled": false,
   "gstNumber": "073456789012345",
   "additionalInfo": "string",
   "putbackItems": 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	invoiceCode	string	Invoice code	-
6	shippingPackageCode	string	Shipping package code	-
7	shippingLabelLink	string	Shipping label link	-
8	invoiceDisplayCode	string	Invoice Display Code	actual invoice code received from channel
9	shippingPackageStatusCode	string	Shipping Package Status Code	-
10	autoPrintEnabled	string	Auto PrintEnabled True/False	-
11	gstNumber	string	Gst Number	-
12	additionalInfo	string	Additional info value reflects in both the cases of success and failure scenario	-
13	putbackItems	string	-	-

Error Codes

Refer Response Codes section to know about specific errors codes.