Create Invoice and Allocate Shipping Provider

This REST API is used to create invoice and allocate shipping provider 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.

Flow

Order_Processing_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Endpoint: /services/rest/v1/oms/shippingPackage/createInvoiceAndAllocateShippingProvider
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",
   "taxInformation": {
      "productTaxes": [
         {
            "channelProductId": "string",
            "additionalInfo": "string",
            "taxPercentage": 0,
            "centralGst": 0,
            "stateGst": 0,
            "unionTerritoryGst": 0,
            "integratedGst": 0,
            "compensationCess": 0,
            "customFieldValues": [
               {
                  "name": "string",
                  "value": "string"
               }
            ]
         }
      ]
   },
   "fetchInvoiceDetail":false
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 shippingPackageCode string Shipping package code Yes -
2 taxInformation object Tax details No -
3 productTaxes list List of product taxes No -
3.1 channelProductId string Channel product ID No -
3.2 additionalInfo string Any additional information No -
3.3 taxPercentage number Tax percentage No Default: 0
3.4 centralGst integer Central GST No Default: 0
3.5 stateGst integer State GST No Default: 0
3.6 unionTerritoryGst integer UT GST No Default: 0
3.7 integratedGst integer Integrated GST No Default: 0
3.8 compensationCess integer Compensation cess No -
3.9 customFieldValues list Custom field details No -
3.9.1 name string Custom field name Yes -
3.9.2 value string Custom field value No -
4 fetchInvoiceDetail boolean To fetch invoice Detail No Default: false

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",
   "invoiceDisplayCode": "string",
   "shippingPackageCode": "string",
   "shippingProviderCode": "string",
   "trackingNumber": "string",
   "shippingLabelLink": "URL",
   "autoPrintEnabled": false,
   "shippingCourier": "TESTHOL",
   "trackingLink": "URL"
}

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 boolean 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 invoiceDisplayCode string Invoice display code -
7 shippingPackageCode string Shipping package code -
8 shippingProviderCode string Shipping provider code -
9 trackingNumber string Tracking number -
10 shippingLabelLink string Shipping label link -
11 autoPrintEnabled boolean Auto Print Enabled Default: false
12 shippingCourier string Shipping courier Name -
13 trackingLink string Tracking link -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.