Create Invoice and Label by Shipping Package Code

This REST API is used to transfer shipment from Created to Ready to Ship state and generate invoice and shipping label. Response will give a data stream of label pdf which can be converted into pdf file.

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/createInvoiceAndGenerateLabel
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)

Pre-requisite

Before using this API, it is required that following item is defined in Uniware:

Required Shipping provider’s AWB generation is set to List/API.

Request Payload

{
   "shippingPackageCode": "string",
   "generateUniwareShippingLabel": true
}

Request Payload Details

PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
shippingPackageCode	string	Shipping package code	Yes	-
generateUniwareShippingLabel	boolean	To generate label with invoice and move shipment to RTS	Yes	-

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",
   "shippingProviderCode": "string",
   "trackingNumber": "string",
   "shippingLabelLink": "URL",
   "label": "string",
   "trackingLink": "URL",
   "invoiceDisplayCode": "INV0053"
}

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	shippingProviderCode	string	Shipping Provider Code	-
8	trackingNumber	string	Tracking Number (AWB)	-
9	shippingLabelLink	string	Shipping label link	-
10	label	string	Base64 encoded string (for pdf - convert base64 to PDF)	-
11	trackingLink	string	Tracking link	-
12	invoiceDisplayCode	string	Invoice Display Code	actual invoice code received from channel

Error Codes

Refer Response Codes section to know about specific errors codes.