Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Orders /GetOrderPackagingCalculation

Allows 150 calls per minute

Response: List<CalcOrderHeader>



Retrieves order packaging, weight and dimension information with split packaging. The method can perform ad hoc recalculation and saving of any changes.

Parameters

NameTypeDescription
requestGetOrderPackagingCalculationRequestOrders to get packaging calculations for

Permissions

GlobalPermissions.OrderBook.ViewOrderDetailsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Orders/GetOrderPackagingCalculation

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "pkOrderIds": [
    "8b3b0fbe-63b2-4968-8faa-c300e8de1bec"
  ],
  "Recalculate": true,
  "SaveRecalculation": true
}

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "pkOrderID": "3801c28e-9f53-4ba4-9791-50c399c9ad3d",
    "nOrderId": 2,
    "fkPostalServiceId": "ad65a4a6-22a9-47c2-870b-cfb884f3f000",
    "fkCountryId": "0a8db50b-2a52-43c3-8d1e-99a088c8839f",
    "cCountry": "sample string 5",
    "ItemWeight": 6.0,
    "fkPackagingGroupId": "f8ea36eb-ad57-4f57-9ae5-49bacc60a759",
    "fkPackagingTypeId": "9b92c04a-1d3c-45c8-ae9d-9dd66a29ba4a",
    "IsSplitPackaging": false,
    "PackagingWeight": 9.0,
    "TotalWeight": 10.0,
    "TotalWidth": 1.0,
    "TotalHeight": 1.0,
    "TotalDepth": 1.0,
    "ManualAdjust": true,
    "CanAutoSplit": false,
    "IsAutoSplit": false,
    "SplitPackageCount": 13,
    "LabelPrinted": true,
    "CalculationHints": [
      "sample string 1"
    ],
    "Items": [
      {
        "fkStockItemId": "55014802-299e-4896-84ed-4ee6e05d6ab4",
        "fkOrderItemId": "9f2d57cc-88d9-4ef9-ae1b-d0894e8ef639",
        "StockItemIntId": 3,
        "SKU": "sample string 4",
        "nQty": 5,
        "ItemWeight": 6.0,
        "DimHeight": 7.0,
        "DimWidth": 8.0,
        "DimDepth": 9.0,
        "PackageGroup": "4a51a712-b3a4-49f6-88e0-3bf5180bcd55",
        "fkCompositeParentRowId": "edde8c8b-db13-42ef-b44c-892919c1cd1c",
        "IsCompositeChild": true,
        "Boxes": [
          {
            "BoxId": 1,
            "StockItemIntId": 2,
            "BoxName": "sample string 3",
            "Width": 4.0,
            "Height": 5.0,
            "Length": 6.0,
            "Weight": 7.0,
            "ValuePercentage": 8.0,
            "Barcode": "sample string 9",
            "PackagingTypeId": "c46dd666-c12c-4da1-896e-4023df538f5d",
            "LogicalDelete": true
          }
        ]
      }
    ],
    "Bins": [
      {
        "pkBinId": "4e5c97c0-03f5-4bbf-91b6-4d3a8038bc61",
        "TrackingNumber": "sample string 2",
        "LabelId": "sample string 3",
        "Weight": 1.0,
        "PrintDate": "2021-07-29T09:24:51.9354507+01:00",
        "Cost": 1.0,
        "fkPackagingTypeId": "ca93950c-85bf-4c36-9cd9-c413018b0b47",
        "Width": 1.0,
        "Height": 1.0,
        "Depth": 1.0,
        "PackagingWeight": 1.0,
        "ItemWeight": 1.0,
        "ManualAdjust": true,
        "Items": [
          {
            "ShippingOrderItemId": 1,
            "BinId": "6724b8a0-7444-41e3-9f89-b193ade9cc61",
            "fkOrderItemId": "e85f60a6-8360-492b-944d-ff5dc811cb85",
            "BoxId": 1,
            "Quantity": 4
          }
        ]
      }
    ],
    "ThreeDimPackaging": {
      "TotalPackages": 1,
      "Packages": [
        {
          "PackagingId": "3746c816-545c-472b-a874-2d6c937d0398",
          "Width": 2.1,
          "Height": 3.1,
          "Depth": 4.1,
          "ItemWeight": 5.0,
          "PackagingWeight": 6.0,
          "Faces": [
            {
              "TopLeft": {
                "IsEmpty": false,
                "X": 1.1,
                "Y": 2.1
              },
              "BottomLeft": {
                "IsEmpty": false,
                "X": 1.1,
                "Y": 2.1
              },
              "TopRight": {
                "IsEmpty": false,
                "X": 1.1,
                "Y": 2.1
              },
              "BottomRight": {
                "IsEmpty": false,
                "X": 1.1,
                "Y": 2.1
              }
            }
          ],
          "Items": [
            {
              "ID": "b13f95a8-5c46-4cda-98cf-57db2e899a02",
              "PkStockItemId": "f95bb96e-9efb-4895-a701-0be626180385",
              "SKU": "sample string 2",
              "Width": 3.1,
              "Height": 4.1,
              "Depth": 5.1,
              "Weight": 6.0,
              "X": 7.1,
              "Y": 8.1,
              "Z": 9.1,
              "Layer": 10,
              "Faces": [
                {
                }
              ]
            }
          ],
          "LayerCount": 7,
          "LayerFace": {
            "1": {
            }
          },
          "IsManualPackage": true
        }
      ],
      "UnpackedItems": {
        "32064f33-5ddc-42b0-b3e9-276ee2db2e4e": 2
      }
    },
    "DimMethod": 0
  }
]