Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
Orders

SetOrderPackaging

Designed to save order packaging when it has already been calculated but not saved or is a manual edit. <b>Permissions Required: </b> GlobalPermissions.OrderBook.ViewOrderDetailsNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/Orders/SetOrderPackaging

Request body

Example request

{
  "request": {
    "fkPackagingGroupId": "00000000-0000-0000-0000-000000000000",
    "fkPackagingTypeId": "00000000-0000-0000-0000-000000000000",
    "pkOrderId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

pkOrderIDstring uuid

Order id

nOrderIdinteger

Numeric order id

fkPostalServiceIdstring uuid

Shipping service id

fkCountryIdstring uuid

Country Id

cCountrystring

Country Name

ItemWeightnumber double

Total Item weight in the order

fkPackagingGroupIdstring uuid

Packaging Group Id

fkPackagingTypeIdstring uuid

Calculated packaging type for the order

IsSplitPackagingboolean

Is the packaging split?

PackagingWeightnumber double

Packaging weight

TotalWeightnumber double

Total weight, items + packaging weight

TotalWidthnumber double

Total width of the order packaging. If null the recalculation was not performed yet. See documentation about how the dimensions of the order calculated.

TotalHeightnumber double

Total Height of the order packaging. If null the recalculation was not performed yet. See documentation about how the dimensions of the order calculated.

TotalDepthnumber double

Total Depth of the order packaging. If null the recalculation was not performed yet. See documentation about how the dimensions of the order calculated.

ManualAdjustboolean

Inidicates that order weights, packaging dimensions has been manually adjusted by the user and therefore automatic recalculation should not be performed for this order

CanAutoSplitboolean
IsAutoSplitboolean

Was the packaging automatically split? Usually by the 3D Packaging method.

SplitPackageCountinteger

Indicates the number of split packaging bins. If null, or 0 - no split packaging

LabelPrintedboolean

Is Label Printed

CalculationHintsstring[]

Calculation comments. The recalculation routine will output some basic comments about how the calculation was performed in English.

DimMethod'LEGACY' | 'MAX' | 'STACKED' | 'WEIGHTFIT' | 'THREEDIM_ALL' | 'THREEDIM_ITEMS'

Dimension Calculation method

Example response

{
  "pkOrderID": "00000000-0000-0000-0000-000000000000",
  "fkPostalServiceId": "00000000-0000-0000-0000-000000000000",
  "fkCountryId": "00000000-0000-0000-0000-000000000000",
  "fkPackagingGroupId": "00000000-0000-0000-0000-000000000000",
  "fkPackagingTypeId": "00000000-0000-0000-0000-000000000000",
  "Items": [
    {
      "fkStockItemId": "00000000-0000-0000-0000-000000000000",
      "fkOrderItemId": "00000000-0000-0000-0000-000000000000",
      "PackageGroup": "00000000-0000-0000-0000-000000000000",
      "fkCompositeParentRowId": "00000000-0000-0000-0000-000000000000",
      "Boxes": [
        {
          "PackagingTypeId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "Bins": [
    {
      "pkBinId": "00000000-0000-0000-0000-000000000000",
      "fkPackagingTypeId": "00000000-0000-0000-0000-000000000000",
      "Items": [
        {
          "BinId": "00000000-0000-0000-0000-000000000000",
          "fkOrderItemId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "ThreeDimPackaging": {
    "Packages": [
      {
        "PackagingId": "00000000-0000-0000-0000-000000000000",
        "Items": [
          {
            "ID": "00000000-0000-0000-0000-000000000000",
            "PkStockItemId": "00000000-0000-0000-0000-000000000000"
          }
        ]
      }
    ]
  }
}