Update Shipping Package

This REST API is used to update shipping package details in Uniware, such as box dimensions, weight, shipping provider, tracking no., etc.

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/edit
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",
   "shippingProviderCode": "string",
   "trackingNumber": "string",
   "shippingPackageTypeCode": "string",
   "actualWeight": 0,
   "shippingBox": {
      "length": 0,
      "width": 0,
      "height": 0
   },
   "noOfBoxes": 0,
   "customFieldValues": [
      {
         "name": "string",
         "value": "string"
      }
   ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 shippingPackageCode string Shipping package code Yes -
2 shippingProviderCode string Shipping provider code No -
3 trackingNumber string Tracking no. No -
4 shippingPackageTypeCode string Shipping package type code No -
5 actualWeight integer Shipment actual weight No -
6 shippingBox object Shipping box details No -
6.1 length integer Length of box (in mm) Yes -
6.2 width integer Width of box Yes -
6.3 height integer Height of box Yes -
7 noOfBoxes integer No. of boxes No -
8 customFieldValues list Custom field details No -
8.1 name string Custom field name Yes -
8.2 value string Custom field value No -

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"
      }
   ],
   "shippingPackageFullDTO": {
      "id": 0,
      "code": "string",
      "shippingProviderCode": "string",
      "providerEditable": true,
      "shippingMethodCode": "string",
      "shippingPackageType": "string",
      "shippingAddress": {
         "id": 0,
         "name": "string",
         "addressLine1": "string",
         "addressLine2": "string",
         "city": "string",
         "state": "string",
         "pincode": "string",
         "phone": "string"
      },
      "trackingStatus": "string",
      "courierStatus": "string",
      "zone": "string",
      "estimatedWeight": 0,
      "actualWeight": 0,
      "created": "2020-07-08T06:30:54.906Z",
      "orderNumber": "string",
      "displayOrderNumber": "string",
      "orderStatus": "string",
      "reshipmentCode": "string",
      "parentPackageCode": "string",
      "noOfItems": 0,
      "noOfBoxes": 0,
      "invoiceCode": "string",
      "invoiceDisplayCode": "string",
      "returnInvoiceCode": "string",
      "returnInvoiceDisplayCode": "string",
      "picklistNumber": "string",
      "length": 0,
      "width": 0,
      "height": 0,
      "trackingNumber": "string",
      "shippingLabelLink": "string",
      "statusCode": "string",
      "totalPrice": 0,
      "collectableAmount": 0,
      "dispatchTime": "2020-07-08T06:30:54.906Z",
      "deliveryTime": "2020-07-08T06:30:54.906Z",
      "repackageable": true,
      "requiresCustomization": true,
      "splittable": true,
      "shippingPackageItems": [
         {
            "saleOrderItemId": 0,
            "code": "string",
            "itemSku": "string",
            "itemName": "string",
            "itemTypeImageUrl": "string",
            "itemTypePageUrl": "string",
            "shelfCode": "string",
            "onHold": true,
            "saleOrderItemCode": "string",
            "statusCode": "string",
            "itemCode": "string",
            "requiresCustomization": true,
            "giftWrap": true,
            "giftMessage": "string",
            "customFieldValues": [
               {
                  "fieldName": "string",
                  "fieldValue": {},
                  "valueType": "string",
                  "displayName": "string",
                  "required": true,
                  "possibleValues": [
                     "string"
                  ]
               }
            ]
         }
      ],
      "shippingPackageChildren": [
         null
      ],
      "customFieldValues": [
         {
            "fieldName": "string",
            "fieldValue": {},
            "valueType": "string",
            "displayName": "string",
            "required": true,
            "possibleValues": [
               "string"
            ]
         }
      ],
      "saleOrderCustomFieldValues": [
         {
            "fieldName": "string",
            "fieldValue": {},
            "valueType": "string",
            "displayName": "string",
            "required": true,
            "possibleValues": [
               "string"
            ]
         }
      ],
      "stateRegulatoryForms": [
         {
            "countryCode": "string",
            "state": "string",
            "code": "string",
            "name": "string",
            "goodsMovementType": "string",
            "conditionExpression": {
               "expressionText": "string"
            },
            "enabled": true
         }
      ],
      "reshipmentSaleOrderCode": "string",
      "reshipmentSaleOrderStatus": "string",
      "shippingManifestCode": "string",
      "returnManifestCode": "string",
      "channelName": "string",
      "thirdPartyShipping": true,
      "invoiceDate": "2020-07-08T06:30:54.906Z",
      "invoiceChannelCreated": "2020-07-08T06:30:54.906Z",
      "invoicedByUser": "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 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 shippingPackageFullDTO object Shipping package details -
5.1 id integer Shipping package ID -
5.2 code string Shipping package code -
5.3 shippingProviderCode string Shipping provider code -
5.4 providerEditable boolean true if provider editable -
5.5 shippingMethodCode string The shipping method of the order -
5.6 shippingPackageType string Shipping package type -
5.7 shippingAddress object Shipping address details -
5.7.1 id integer Customer ID -
5.7.2 name string Customer name -
5.7.3 addressLine1 string Precise address -
5.7.4 addressLine2 string Additional address information Max chars: 500
5.7.5 city string City name Eg: Surat, Max. chars: 100
5.7.6 state string State name Eg: Gujrat, Max. chars: 45
5.7.7 pincode string Area pincode (min. 6 digits) Max chars: 45
5.7.8 phone string Contact no. -
5.8 trackingStatus string Tracking status -
5.9 courierStatus string Courier status -
5.10 zone string - -
5.11 estimatedWeight number Shipment estimated weight (in gm) -
5.12 actualWeight integer Shipment actual weight -
5.13 created date Creation Date -
5.14 orderNumber string Order no. -
5.15 displayOrderNumber string Order no. to be displayed -
5.16 orderStatus string Status of the order Allowable: PENDING_VERIFICATION, CREATED, PROCESSING, COMPLETE, CANCELLED
5.17 reshipmentCode string Reshipment code -
5.18 parentPackageCode string Parent package code -
5.19 noOfItems integer No. of boxes -
5.20 noOfBoxes integer No. of boxes -
5.21 invoiceCode string Invoice code -
5.22 invoiceDisplayCode string Invoice display code -
5.23 returnInvoiceCode string Return invoice code -
5.24 returnInvoiceDisplayCode string Return invoice display code -
5.25 picklistNumber string Picklist no. -
5.26 length integer Length of box (in mm) -
5.27 width integer Width in mm -
5.28 height integer Height of box (in mm) -
5.29 trackingNumber string Tracking number -
5.30 shippingLabelLink string Shipping label link -
5.31 statusCode string Status code -
5.32 totalPrice number Total price -
5.33 collectableAmount number Amount to be collected at time of delivery 0.00 for Prepaid mode
5.34 dispatchTime string Date-time -
5.35 deliveryTime string Date-time -
5.36 repackageable boolean true if repackageable -
5.37 requiresCustomization boolean true if customization required -
5.38 splittable boolean true if splittable -
5.39 shippingPackageItems list List of shipping package items -
5.39.1 saleOrderItemId integer Sale order item ID -
5.39.2 code string Shipping package code -
5.39.3 itemSku string Item SKU Eg.: Bharat4
5.39.4 itemName string Item name -
5.39.5 itemTypeImageUrl string Item type image URL -
5.39.6 itemTypePageUrl string Item type page URL -
5.39.7 shelfCode string Shelf code of the item -
5.39.8 onHold boolean true if onHold -
5.39.9 saleOrderItemCode string Sale order item code -
5.39.10 statusCode string Shipping package status code -
5.39.11 itemCode string Item code -
5.39.12 requiresCustomization boolean true if customization required -
5.39.13 giftWrap boolean true for gift wrap -
5.39.14 giftMessage string Message on gift -
5.39.15 customFieldValues list Custom field details -
5.39.15.1 fieldName string Custom field name -
5.39.15.2 fieldValue string Custom field value -
5.39.15.3 valueType string Value type -
5.39.15.4 displayName string Name to be displayed -
5.39.15.5 required boolean true if required -
5.39.15.6 possibleValues list - -
5.40 shippingPackageChildren list Shipping package details -
5.41 customFieldValues list List of custom field values -
5.41.1 fieldName string Custom field name -
5.41.2 fieldValue object Custom field value -
5.41.3 valueType string - -
5.41.4 displayName string Name to be displayed -
5.41.5 required boolean true if required -
5.41.6 possibleValues list - -
5.42 saleOrderCustomFieldValues list Sale order custom field details -
5.42.1 fieldName string Custom field name -
5.42.2 fieldValue object Custom field value -
5.42.3 valueType string - -
5.42.4 displayName string Name to be displayed -
5.42.5 required boolean true if required -
5.42.6 possibleValues list - -
5.43 stateRegulatoryForms list - -
5.43.1 countryCode string Country code not name Country Codes
5.43.2 state string State name Eg: Gujrat, Max. chars: 45
5.43.3 code string - -
5.43.4 name string - -
5.43.5 goodsMovementType string Goods movement type -
5.43.6 conditionExpression object - -
5.43.6.1 expressionText string - -
5.43.7 enabled boolean true if enabled -
5.43 reshipmentSaleOrderCode string Reshipment sale order code -
5.44 reshipmentSaleOrderStatus string Reshipment sale order status -
5.45 shippingManifestCode string Shipping manifest code -
5.46 returnManifestCode string Return manifest code -
5.47 channelName string Channel name -
5.48 thirdPartyShipping boolean true if the shipping to end customer is taken care by the Marketplace. false for self shipping -
5.49 invoiceDate string Date-time -
5.50 invoiceChannelCreated string Date-time -
5.51 invoicedByUser string - -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.