SetOrderPackaging

post https://eu-ext.linnworks.net/api/Orders/SetOrderPackaging

Designed to save order packaging when it has already been calculated but not saved or is a manual edit.
Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode
Rate limit: 150 / minute

Response

Response body

object

pkOrderID

uuid

Order id

nOrderId

int32

Numeric order id

fkPostalServiceId

uuid

Shipping service id

fkCountryId

uuid

Country Id

cCountry

string

Country Name

ItemWeight

double

Total Item weight in the order

fkPackagingGroupId

uuid

Packaging Group Id

fkPackagingTypeId

uuid

Calculated packaging type for the order

IsSplitPackaging

boolean

Is the packaging split?

PackagingWeight

double

Packaging weight

TotalWeight

double

Total weight, items + packaging weight

TotalWidth

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.

TotalHeight

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.

TotalDepth

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.

ManualAdjust

boolean

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

CanAutoSplit

boolean

IsAutoSplit

boolean

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

SplitPackageCount

int32

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

LabelPrinted

boolean

Is Label Printed

CalculationHints

array of strings

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

CalculationHints

Items

array of objects

List of order items (excluding composite parents)

Items

object

fkStockItemId

uuid

Unique stock item identifier

fkOrderItemId

uuid

Unique row identifier of the order item

StockItemIntId

int32

SKU

string

SKU

nQty

int32

Quantity of items

ItemWeight

double

Item weight

DimHeight

double

Item height

DimWidth

double

Item width

DimDepth

double

item depth

PackageGroup

uuid

Prefered Packaging group

fkCompositeParentRowId

uuid

Indicates whether the item is a child of a composite, if EmptyGuid or Null not a child

IsCompositeChild

boolean

Boxes

array of objects

Boxes

object

BoxId

int32

Unique box id.

StockItemIntId

int32

BoxName

string

Box name max 16 characters

Width

double

Width of the box

Height

double

Height of the box

Length

double

Depth of the box

Weight

double

Total weight of the box.

ValuePercentage

double

Value break down percentage

Barcode

string

Box barcode, max 64 characters.

PackagingTypeId

uuid

Packaging type id

LogicalDelete

boolean

IsDeleted flag.

Bins

array of objects

List of bins (split packaging)

Bins

object

pkBinId

uuid

Bin Id

TrackingNumber

string

Bin Tracking number

LabelId

string

Bin Label Id

Weight

double

Bin total weight. If null, recalculation was not performed

PrintDate

date-time

Label Print date

Cost

double

Label cost if available

fkPackagingTypeId

uuid

Bin allocated packaging type

Width

double

Bin width. If null, recalculation was not performed

Height

double

Bin height. If null, recalculation was not performed

Depth

double

Bin depth. If null, recalculation was not performed

PackagingWeight

double

Bin packaging weight. If null, recalculation was not performed

ItemWeight

double

Bin ItemWeight. If null, recalculation was not performed

ManualAdjust

boolean

Indicates that the bin weights and dimensions have been manually adjusted by the user

Items

array of objects

List of order item ids in the bin and their quantities

Items

object

ShippingOrderItemId

int32

Bin Item Id

BinId

uuid

Package Id

fkOrderItemId

uuid

Order Item Id

BoxId

int32

Item Part Id

Quantity

int32

ThreeDimPackaging

object

TotalPackages

int32

Packages

array of objects

Packages

object

PackagingId

uuid

Width

double

Height

double

Depth

double

ItemWeight

double

PackagingWeight

double

Faces

array of objects

Faces

object

TopLeft

object

BottomLeft

object

TopRight

object

BottomRight

object

Items

array of objects

Items

object

uuid

PkStockItemId

uuid

SKU

string

Width

double

Height

double

Depth

double

Weight

double

Layer

int32

Faces

array of objects

Faces

object

TopLeft

object

BottomLeft

object

TopRight

object

BottomRight

object

LayerCount

int32

LayerFace

object

IsManualPackage

boolean

UnpackedItems

object

Has additional fields

DimMethod

string

Dimension Calculation method

LEGACY MAX STACKED WEIGHTFIT THREEDIM_ALL THREEDIM_ITEMS

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://eu-ext.linnworks.net/api/Orders/SetOrderPackaging \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK