Allocate Shipping Provider

This REST API is used to allocate a shipping provider or aggregator to 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/allocateShippingProvider
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",
   "shippingLabelMandatory": "true",
   "shippingProviderCode":"STRING",
   "shippingCourier":"STRING",
   "trackingNumber":"STRING",
   "generateUniwareShippingLabel":"true"
}

Request Payload Details

PARAMETER TYPE DESCRIPTION MANDATORY NOTES
shippingPackageCode string Shipping package code Yes -
shippingLabelMandatory boolean To get shipping label Link Opt true- To get shipping label Link, else false
shippingProviderCode string Shipping Provider Code Opt -
shippingCourier string Shipping Provider Name Opt -
trackingNumber string TrackingNumber Opt -
generateUniwareShippingLabel boolean To get shipping label if the shipping provider has created a shipping label link Opt true- To get SP shipping label Link, else false- for UC label Link

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"
      }
   ],
   "shippingPackageCode": "string",
   "shippingProviderCode": "string",
   "shippingLabelLink": "URL",
   "trackingNumber": "string",
   "shipmentLabelFormat": "string",
   "shippingManagedBy": "string",
   "statusCode": "string",
   "shippingCourier": "string",
   "trackingLink": "URL",
   "autoPrintEnabled": false,
}

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 shippingPackageCode string Shipping package code -
6 shippingProviderCode string Shipping provider code -
7 shippingLabelLink string Shipping label link -
8 trackingNumber string Shipment tracking number -
9 shipmentLabelFormat string Shipping label format -
10 shippingManagedBy string Shipping provider -
11 statusCode string - -
12 shippingCourier string Shipping Provider Name -
13 trackingLink string Tracking link -
14 autoPrintEnabled boolean Auto Print Enabled Default: false

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.