Search Shipping Package

This REST API is used to search shipping package details in Uniware using either saleOrderCode or shippingPackageCode.

Tip

Flow

Search_Shipping_Package_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Endpoint: /services/rest/v1/oms/shippingPackage/search
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",
   "saleOrderCode": "string",
   "channelCode": "string",
   "statuses": [
      "string"
   ],
   "createTime": {
      "start": "2020-05-11T15:44:11.789Z",
      "end": "2020-05-11T15:44:11.789Z",
      "textRange": "TODAY"
   },
   "dispatchTime": {
      "start": "2020-05-11T15:44:11.789Z",
      "end": "2020-05-11T15:44:11.789Z",
      "textRange": "TODAY"
   },
   "containsCancelledItems": true,
   "onHold": true,
   "shippingProvider": "string",
   "shippingMethod": "string",
   "trackingNumber": "string",
   "invoiceCode": "string",
   "cashOnDelivery": true,
   "searchOptions": {
      "searchKey": "string",
      "displayLength": 0,
      "displayStart": 0,
      "columns": 0,
      "sortingCols": 0,
      "sortColumnIndex": 0,
      "sortDirection": "string",
      "columnNames": "string",
      "getCount": true
   },
   "paymentReconciled": true,
   "itemTypeSkuCode": "string",
   "updatedSinceInMinutes": 0
}

Request Payload Details

NOTE:

To get Shipping Package details it is required to provide either shippingPackageCode or saleOrderCode. The result can be filtered using other non mandatory parameters.

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 shippingPackageCode string Shipping package code Yes -
2 saleOrderCode string Sale order code Yes -
3 channelCode string Channel code No -
4 statuses string - No -
5 createTime string Date range No -
5.1 start date Start date No -
5.2 end date End date No -
5.3 textRange enum Preset Range No Fixed: TODAY
6 dispatchTime string Date-time No -
6.1 start date Start date No -
6.2 end date End date No -
6.3 textRange enum Preset Range No Fixed: TODAY
7 containsCancelledItems boolean true if contains cancelled items No Default: true
8 onHold boolean true if onHold No Default: true
9 shippingProvider string Shipping provider No -
10 shippingMethod string Shipping method No -
11 trackingNumber string Tracking number No -
12 invoiceCode string Invoice code No -
13 cashOnDelivery boolean true if COD No Default: true
14 searchOptions list Search options list No -
14.1 searchKey string Search keywords No -
14.2 displayLength integer Length to be displayed No Default: 0
14.3 displayStart integer Starting string No -
14.4 columns integer Columns No Default: 0
14.5 sortingCols integer Sorting columns No Default: 0
14.6 sortColumnIndex integer Sort column index No Default: 0
14.7 sortDirection string Sort direction No -
14.8 columnNames string Column names No -
14.9 getCount boolean Get count No Default: true
15 paymentReconciled boolean Payment reconciled No Default: true
16 itemTypeSkuCode string Item type SKU code No -
17 updatedSinceInMinutes integer Minutes since last update No Default: 0

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"
      }
   ],
   "totalRecords": 0,
   "elements": [
      {
         "code": "string",
         "saleOrderCode": "string",
         "channel": "string",
         "status": "string",
         "shippingPackageType": "string",
         "shippingProvider": "string",
         "shippingMethod": "string",
         "trackingNumber": "string",
         "trackingStatus": "string",
         "courierStatus": "string",
         "estimatedWeight": 0,
         "actualWeight": 0,
         "customer": "string",
         "created": "2020-05-18T10:25:46.654Z",
         "updated": "2020-05-18T10:25:46.654Z",
         "dispatched": "2020-05-18T10:25:46.654Z",
         "delivered": "2020-05-18T10:25:46.654Z",
         "invoice": 0,
         "invoiceCode": "string",
         "invoiceDisplayCode": "string",
         "returnInvoiceCode": "string",
         "returnInvoiceDisplayCode": "string",
         "noOfItems": 0,
         "city": "string",
         "collectableAmount": 0,
         "collectedAmount": 0,
         "paymentReconciled": true,
         "podCode": "string",
         "shippingManifestCode": "string",
         "items": {
            "additionalProp1": {
               "itemSku": "string",
               "itemName": "string",
               "itemTypeImageUrl": "string",
               "itemTypePageUrl": "string",
               "quantity": 0
            },
            "additionalProp2": {
               "itemSku": "string",
               "itemName": "string",
               "itemTypeImageUrl": "string",
               "itemTypePageUrl": "string",
               "quantity": 0
            },
            "additionalProp3": {
               "itemSku": "string",
               "itemName": "string",
               "itemTypeImageUrl": "string",
               "itemTypePageUrl": "string",
               "quantity": 0
            }
         },
         "customFieldValues": [
            {
               "fieldName": "string",
               "fieldValue": {},
               "valueType": "string",
               "displayName": "string",
               "required": true,
               "possibleValues": [
                  "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 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 totalRecords integer Total no. of records found Default: 0
6 elements list - -
6.1 code string - -
6.2 saleOrderCode string Sale order code -
6.3 channel string - -
6.4 status string - -
6.5 shippingPackageType string Shipping package type -
6.6 shippingProvider string Shipping provider -
6.7 shippingMethod string Shipping method -
6.8 trackingNumber string Tracking number -
6.9 trackingStatus string Tracking status -
6.10 courierStatus string Courier status -
6.11 estimatedWeight number Shipment estimated weight (in gm) -
6.12 actualWeight integer Shipment actual weight Default: 0
6.13 customer string - -
6.14 created date order creation date -
6.15 updated date - -
6.16 dispatched date Dispatch date -
6.17 delivered date Delivery date -
6.18 invoice number - Default: 0
6.19 invoiceCode string Invoice code -
6.20 invoiceDisplayCode string Invoice display code -
6.21 returnInvoiceCode string Return invoice code -
6.22 returnInvoiceDisplayCode string Return invoice display code -
6.23 noOfItems integer No. of items in a shipment Default: 0
6.24 city string City name Eg: Surat
6.25 collectableAmount number Amount to be collected Default: 0
6.26 collectedAmount number Prepaid amount Default: 0
6.27 paymentReconciled boolean - Default: true
6.28 podCode string - -
6.29 shippingManifestCode string Shipping manifest code -
6.30 items list - -
6.30.1 additionalProp1 object Parameter 1 with error -
6.30.1.1 itemSku string Item SKU -
6.30.1.2 itemName string Item name -
6.30.1.3 itemTypeImageUrl string Item type image link -
6.30.1.4 itemTypePageUrl string Item type page link -
6.30.1.5 quantity integer Qty of the item Default: 0
6.30.2 additionalProp2 object Parameter 2 with error -
6.30.2.1 itemSku string Item SKU -
6.30.2.2 itemName string Item name -
6.30.2.3 itemTypeImageUrl string Item type image link -
6.30.2.4 itemTypePageUrl string Item type page link -
6.30.2.5 quantity integer Qty of the item Default: 0
6.30.3 additionalProp3 object Parameter 3 with error -
6.30.3.1 itemSku string Item SKU -
6.30.3.2 itemName string Item name -
6.30.3.3 itemTypeImageUrl string Item type image link -
6.30.3.4 itemTypePageUrl string Item type page link -
6.30.3.5 quantity integer Qty of the item Default: 0
6.31 customFieldValues list List of custom fields -
6.31.1 fieldName string Custom field name -
6.31.2 fieldValue list Custom field value -
6.31.3 valueType string Value type -
6.31.4 displayName string Name to be displayed -
6.31.5 required boolean true if required Default: true
6.31.6 possibleValues list Allowable values -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.