Object reference tables

Objects

ShipperBase

ServiceBase

ShipmentBase

PackageBase

DangerousItem

PackingSlipLine

ExportDetails

ItemIdentifications

Charge

Address

References

Dimensions

 

ShipperBase

Wms.RemotingObjects.ShippingLayers.Abstract

Field

Type

Description

ColliSpecificationCode

String[]

List of available colli codes of the shipper. These codes can be selected when creating predefined colli types in Boxwise and will be set in the field PackageBase.ColliSpecificationCode.

Description

String

Description of the shipper

DimensionMandatory

Bool

Indicates dimensions are mandatory

InitInfo

ShipperInitInfo

Contains initialization information for the Shipper like a Root folder to use for storing files

Logo48

Bitmap

Logo of the shipper (for mobile client). 48x48 px

Logo64

Bitmap

Logo of the shipper (for touch client). 64x64 px

Name

String

(Friendly) Name of the shipper

SupportsRates

Bool

Indicates the shipper support rates 

UniqueId

String

Id of the shipper (preferably a constant guid)

 

ServiceBase

Wms.RemotingObjects.ShippingLayers.Abstract

Field

Type

Description

Description

String

Description of service

ExtraCharges

Charge[]

Extra charges of service (calculated by shipper)

Id

String

Id of service

Name

String

Name of service

TotalCharge

Charge

Total charges of service (calculated by shipper)

TransportationCharge

Charge

Transportation charges of service (calculated by shipper)

 

ShipmentBase

Wms.RemotingObjects.ShippingLayers.Abstract

Field

Type

Description

 

Address

Shipping address of the shipment

CommunicationArtefacts

String

-

Currency

String

Currency of the shipment value

CustomData

byte[]

A property to store serialized data that you can retrieve in case of a shipment reship (Cancel ➡ Ship again)

CustomReferences

Dictionary<string,string>

Any additional references from boxwise

DbKey

Int

The database key in the boxwise database

DeliveryNotePdf

byte[]

A PDF with the Delivery Note as byte array

Documents

List<Attachment>

Return value: any documents that boxwise needs to print (Customs documents, labels etc.)

HasAttachments

Bool

Readonly

InvoiceAddress

Address

Invoice Address of the shipment

IsCod

Bool

Indicates it’s a cash on delivery shipment 

Notes

String

Shipment notes

OrderReferences

References

References of the orders in the shipment

Packages

Packages

GetTotalWeight():decimal ; Total weight of the shipment

Reference

String

Reference of the shipment

SendAddress

Address

Send Address of the shipment

Service

ServiceBase

Service of the shipment

Shipper

ShipperBase

Shipper of the shipment

TotalCharge

Charge

Total charges of the shipment

Value

Decimal

Shipment value



PackageBase

Wms.RemotingObjects.ShippingLayers.Abstract

Field

Type

Description

BoxGuid

Guid

Guid of the package

BoxId

String

Id of the package

CashAmount

Decimal

 

CashCurrency

String

 

ColliCount

Int

 

ColliNumber

Int

Number of the package

ColliPresetName

String

Name of the preset (predefined packages) which is used to select the package

ColliSpecificationCode

String

Specific shipper code which is linked to the preset which is used to select the package

DangerousItems

DangerousItem[]

List of dangerous items in the package

Date

DateTime

Date and time this package has been created

DbKey

Int

Database key in boxwise database

Dimensions

Dimensions

Dimensions of the package

IsSavedToDb

Bool

Indicates the package is saved in boxwise database

IsSent

Bool

Inidcates the package is sent

ItemCode

String

Itemcode of the item which is linked to the preset which is used to select the package

Label

byte[]

A byte array containing the ZPL of the label for this Package

LabelDuplicate

byte[]

[Optional]

OrderReferences

References

References of the orders in the package

OuterReference

String

SSCC Reference the package (is used for SSCC codes)

PackageType

String

Type of the package (Document, Box or Pallet)

PackingSlipLines

PackingSlipeLine[]

List of packing slip lines in the package

Shipment

ShipmentBase

The shipment to which the package belongs

TrackingUrl

String

Track & Trace url of the shipment to which the package belongs

Weight

Decimal

Weight of the package

YourReference

String

A unique reference for this package from boxwise 

 

DangerousItem

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

AuthorizationCode

String

 

ClassificationCode

String

 

Code

String

 

ControlTemperature

Decimal

 

Description

String

 

EmergencyTemperature

Decimal

 

FlashPoint

Decimal

 

FlashPointDegree

Decimal

 

GrossWeight

Decimal

 

HazardousSubstance

Int

 

Instructions

String

 

LimitedQuantity

String

 

LimitedQuantityPoints

Int

 

LimitedQuantityPointsMultiplier

Int

 

MarkingIdentifier

String

 

Measurements

Dimensions

 

NettExplosiveMass

Decimal

 

NettExplosiveMassUoM

String

 

NetWeight

Decimal

 

OverpackId

String

 

PackingClassification

String

 

PackingGroup

String

 

PackingInstruction

String

 

PackingType

String

 

PrimaryHazardClass

String

 

ProperShippingNameLocal

String

 

Quantity

Decimal

 

RegulationLevel

String

 

RegulationType

String

 

SecondaryHazardClass

String

 

TechnicalNameInternational

String

 

TechnicalNameLocal

String

 

TemperatureUom

String

 

TertiaryHazardClass

String

 

TransportCategory

Int

 

TunnelCode

String

 

UndgCode

String

 

UndgName

String

 

UndgSubCode

String

 

UnitCode

String

 

Volume

Decimal

 

VolumeUom

String

 



PackingSlipLine

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

AssemblyInstructions

String

-

Composition

String

-

Currency

String

Currency on the packing slip line

Description

String

Description on the packing slip line

ExportDetails

ExportDetails

Export details on the packing slip line (CountryOfOrign, HsCode, HsCodeDespription, ReasonOfExport)

GrossPrice

Decimal

Gross price on the packing slip line

GrossWeight

Decimal

Gross weight on the packing slip line

GTINCode

String

GTIN Code on the item on the packing slip line

IsBatchNumberItem

Bool

Indicates the item on the packing slip line is a batch number item

IsSerialNumberItem

Bool

Indicates the item on the packing slip line is a serial number item

ItemCode

String

Item code of the item on the packing slip line 

ItemIdentifications

ItemIdentificationBase[]

Details of the serial or batch number of the item on the packing lip line

NettWeight

Decimal

Nett weight on the packing slip line

Number

String

Number of colli

OrderNumber

String

Ordernumber on the packing slip line

Proforma

Proforma

-

Quality

String

-

Quantity

Decimal

Quantity delivered on the packing slip line

QuantityCubicMeters

Decimal

Quantity in cubic meters on the packing slip line

QuantityInBackOrder

Decimal

Quantity in backorder on the packing slip line

QuantityOrdered

Decimal

Quantity ordered on the packing slip line

SalesPrice

Decimal

Sales price of the item on the packing slip line

SalesPriceWithVat

Decimal

Sales price with VAT of the item on the packing slip line

UnitCode

String

Unit code on the packing slip line

WeightUom

String

Weight in unit of measurement on the packing slip line

 

ExportDetails

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

CountryOfOrigin

String

 

HsCode

String

 

HsCodeDescription

String

 

ReasonOfExport

String

 

 

ItemIdentifications

Wms.RemotingObjects.Inventory

Field

Type

Description

BeginDate

DateTime

Date of registration of the batch or serial number

EndDate

DateTime

Expiry date of the batch or serial number

Number

String

Batch or serial number

Quantity

Decimal

Quantity of the batch or serial number (with serial number always 1)

 

Charge

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

Amount

Decimal

 

CurrencyCode

String

 

Description

String

 

SalesAmount

Decimal

 

 

Address

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

Address1

String

 

Address2

String

 

Address3

String

 

City

String

 

CountryCode

String

 

CountryName

String

 

CustomerVatNumber

String

 

CustomFields

SerializableDictionary<string,object>

 

DeliveryBeginDateTime

DateTime

Date and begin time the shipment have to delivered

DeliveryEndDateTime

DateTime

Date and end time the shipment have to delivered

Email

String

 

EoriNumber

String

 

FullAddress

String

 

Name

String

 

Name2

String

 

PhoneNumber

String

 

PickupEndDateTime

DateTime

Date and end time the shipment have to picked up

PickupStartDateTime

DateTime

Date and start time the shipment have to picked up

StateCode

String

 

ZipCode

String

 

 

References

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

CustomerReferences

List<string>

 

CustomerReferencesAsString

String

 

DebtorNumber

String

 

GroupGuid

Guid

 

LanguageCode

String

 

OrderNumbers

List<string>

 

OrderNumberAsString

String

 

PackageSlipNumbers

List<string>

 

PackageSlipNumbersAsString

String

 

 

Dimensions

Wms.RemotingObjects.ShippingLayers

Field

Type

Description

Height

Decimal

 

Length

Decimal

 

UnitOfMeasurement

String

 

Width

Decimal

 



Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 0 van 0