GetOrder
This is the most basic of the various GetOrder-functions. It allows you to retrieve an order if you know the internal Ongoing WMS id of the order (the OrderId). Otherwise use GetOrderByOrderNumber or GetOrdersByQuery.
Tags: GetOrder, GetOrderResponse, Order, Consignee, Consignor, GoodsOwnerInfo, TransportPayer, Financial, GoodsInfo, OrderInfoType, GoodsItem, PickedOrderLine, PickedArticleItem, TransporterClass, OrderPalletItemInfo, OrderShipmentInfo, ReturnTransporterInfo, OrderWarehouseInfo, OrderCurrentShipmentInfo, OrderTrackingInfo, ConsigneeInvoiceAddress, NotifyClass, ExchangeOrderInfo, OrderCustomsInfo, TermsOfDeliveryTypeInfo, OrderClassInfo, ArticleClass, PickedOrderLinePickOrderInfo, OrderLineTypeInfo, PickedArticleItemPalletItemInfo, PickedArticleItemInOrderInfo, ArticleItemCategory_PickedArticleItem, PalletItemTrackingInfo, OrderShipmentPalletItemInfo, DangerousGoods, TaricNumbersInfo, GoodsCategoryInfo, PickedOrderLinePickOrderTypeInfo, ProperShippingName, TaricNumberInfoClass
Request XML
POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetOrder"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetOrder xmlns="http://ongoingsystems.se/WSI">
<UserName>string</UserName>
<Password>string</Password>
<OrderId>int</OrderId>
</GetOrder>
</soap:Body>
</soap:Envelope>
Request specification
| GetOrder |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| OrderId |
int |
Req. |
Ongoing WMS internal id of the order |
Response XML
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetOrderResponse xmlns="http://ongoingsystems.se/WSI">
<GetOrderResult>
<MessageId>string</MessageId>
<Consignee>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<CountryStateCode>string</CountryStateCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<CustomerNumber>string</CustomerNumber>
<CustomerGroupCode>string</CustomerGroupCode>
<CustomerGroupName>string</CustomerGroupName>
<CustomerGroupComment>string</CustomerGroupComment>
<CustomerNumberPallets>string</CustomerNumberPallets>
<TermsOfPaymentTypeName>string</TermsOfPaymentTypeName>
<TermsOfPaymentTypeCode>string</TermsOfPaymentTypeCode>
<InvoiceAddress>
<AddressId>int</AddressId>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<CountryName>string</CountryName>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Email>string</Email>
<CountryStateCode>string</CountryStateCode>
</InvoiceAddress>
<AddressId>int</AddressId>
<DoorCode>string</DoorCode>
<CustomerVATNumber>string</CustomerVATNumber>
<OrganisationNumber>string</OrganisationNumber>
</Consignee>
<Consignor>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
</Consignor>
<GoodsOwnerInfo>
<Id>int</Id>
<GoodsOwnerReference>string</GoodsOwnerReference>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryId>int</CountryId>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Email>string</Email>
<GoodsLocationCode>string</GoodsLocationCode>
<OrganizationNumber>string</OrganizationNumber>
<OrganizationVATNumber>string</OrganizationVATNumber>
<GoodsOwnerAddressName>string</GoodsOwnerAddressName>
<IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
<FinancialCode>string</FinancialCode>
<GoodsOwnerContactReference>string</GoodsOwnerContactReference>
</GoodsOwnerInfo>
<TransportPayer>
<CustomerCode>string</CustomerCode>
<Name>string</Name>
<Address>string</Address>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
</TransportPayer>
<Financial>
<TransportPaymentType>Collect or Prepaid or ThirdParty or UnKnown</TransportPaymentType>
<ArticleCode>string</ArticleCode>
<PriceListCode>string</PriceListCode>
<TransporterAgreementId>int</TransporterAgreementId>
<WaybillTemplate>string</WaybillTemplate>
</Financial>
<GoodsInfo>
<NumberOfGoodsItems>int</NumberOfGoodsItems>
<NumberOfPackages>int</NumberOfPackages>
<SummedGoodsItemParcels>int</SummedGoodsItemParcels>
<SummedGoodsItemWeight>decimal</SummedGoodsItemWeight>
<SummedGoodsItemVolume>decimal</SummedGoodsItemVolume>
<SummedGoodsItemLoadMeters>decimal</SummedGoodsItemLoadMeters>
<SummedGoodsItemArea>decimal</SummedGoodsItemArea>
<SummedArticleItemWeight>decimal</SummedArticleItemWeight>
<SummedArticleItemVolume>decimal</SummedArticleItemVolume>
</GoodsInfo>
<OrderInfo>
<OrderId>int</OrderId>
<ReferenceNumber>string</ReferenceNumber>
<ProfitCenter>string</ProfitCenter>
<GoodsOwnerName>string</GoodsOwnerName>
<Communication>string</Communication>
<GoodsOwnerEdiCode>string</GoodsOwnerEdiCode>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<GoodsOwnerOrderId>string</GoodsOwnerOrderId>
<TransporterOrderNumber>string</TransporterOrderNumber>
<ConsigneeOrderNumber>string</ConsigneeOrderNumber>
<ExternalOrderCode>string</ExternalOrderCode>
<SalesCode>string</SalesCode>
<OrderRemark>string</OrderRemark>
<DeliveryInstruction>string</DeliveryInstruction>
<WayOfDelivery>string</WayOfDelivery>
<WayOfDeliveryTypeCode>string</WayOfDeliveryTypeCode>
<WayOfDeliveryTypeName>string</WayOfDeliveryTypeName>
<TermsOfDelivery>string</TermsOfDelivery>
<TermsOfPayment>string</TermsOfPayment>
<OrderTypeCode>string</OrderTypeCode>
<OrderTypeName>string</OrderTypeName>
<Language>string</Language>
<InvoiceNumber>string</InvoiceNumber>
<InvoiceTypeCode>string</InvoiceTypeCode>
<InvoiceUrl>string</InvoiceUrl>
<ProductionCode>string</ProductionCode>
<PickUpDate>dateTime</PickUpDate>
<DeliveryDate>dateTime</DeliveryDate>
<CreatedDate>dateTime</CreatedDate>
<ShippedTime>dateTime</ShippedTime>
<ArrivalDate>dateTime</ArrivalDate>
<ArrivalDateFrom>dateTime</ArrivalDateFrom>
<PrintedTime>dateTime</PrintedTime>
<WayBill>string</WayBill>
<CustomerPrice>decimal</CustomerPrice>
<FreightPrice>decimal</FreightPrice>
<OrderStatusNumber>int</OrderStatusNumber>
<OrderStatusText>string</OrderStatusText>
<TransporterServicePointId>int</TransporterServicePointId>
<TransporterServicePointCode>string</TransporterServicePointCode>
<OrderServicePointCode>string</OrderServicePointCode>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<EmailNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</EmailNotification>
<TelephoneNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</TelephoneNotification>
<SMSNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</SMSNotification>
<PickingPriority>int</PickingPriority>
<BackOrderForOrderId>int</BackOrderForOrderId>
<FinancialArticleCode>string</FinancialArticleCode>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
<CurrentShipmentId>int</CurrentShipmentId>
<MarketPlace>string</MarketPlace>
<MarketPlaceOrderNumber>string</MarketPlaceOrderNumber>
<ReturnWaybill>string</ReturnWaybill>
<ExchangeInfo>
<ForOrderId>int</ForOrderId>
<ForOrderNumber>string</ForOrderNumber>
</ExchangeInfo>
<OrderCustomsInfo>
<CustomsValueCurrencyCode>string</CustomsValueCurrencyCode>
</OrderCustomsInfo>
<PreparedTransportDocumentId>string</PreparedTransportDocumentId>
<WarehouseInstruction>string</WarehouseInstruction>
<TermsOfDeliveryType>
<Code>string</Code>
<Name>string</Name>
</TermsOfDeliveryType>
<OrderClasses>
<OrderClassInfo>
<Code>string</Code>
<Name>string</Name>
</OrderClassInfo>
<OrderClassInfo>
<Code>string</Code>
<Name>string</Name>
</OrderClassInfo>
</OrderClasses>
<OrderSortLocation>string</OrderSortLocation>
</OrderInfo>
<CommunicationInfo>
<FromSystemName>string</FromSystemName>
<ToSystemName>string</ToSystemName>
<MessageId>string</MessageId>
</CommunicationInfo>
<Success>boolean</Success>
<GoodsItems>
<GoodsItem>
<Id>int</Id>
<GoodsItemLabelId>string</GoodsItemLabelId>
<PackageTypeName>string</PackageTypeName>
<PackageTypeCode>string</PackageTypeCode>
<Area>decimal</Area>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Height>decimal</Height>
<Length>decimal</Length>
<Width>decimal</Width>
<LoadMeters>decimal</LoadMeters>
<NumberOfItems>int</NumberOfItems>
<NumberOfPackages>int</NumberOfPackages>
<ApprovedNumberOfPackages>int</ApprovedNumberOfPackages>
<GoodsComment>string</GoodsComment>
<GoodsCategory>string</GoodsCategory>
</GoodsItem>
<GoodsItem>
<Id>int</Id>
<GoodsItemLabelId>string</GoodsItemLabelId>
<PackageTypeName>string</PackageTypeName>
<PackageTypeCode>string</PackageTypeCode>
<Area>decimal</Area>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Height>decimal</Height>
<Length>decimal</Length>
<Width>decimal</Width>
<LoadMeters>decimal</LoadMeters>
<NumberOfItems>int</NumberOfItems>
<NumberOfPackages>int</NumberOfPackages>
<ApprovedNumberOfPackages>int</ApprovedNumberOfPackages>
<GoodsComment>string</GoodsComment>
<GoodsCategory>string</GoodsCategory>
</GoodsItem>
</GoodsItems>
<PickedOrderLines>
<PickedOrderLine>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<Description>string</Description>
<SupplierArticleNumber>string</SupplierArticleNumber>
<StatisticsNumber>string</StatisticsNumber>
<ArticleGroupName>string</ArticleGroupName>
<ArticleGroupCode>string</ArticleGroupCode>
<MainSupplierName>string</MainSupplierName>
<MainSupplierNumber>string</MainSupplierNumber>
<ArticleCategoryName>string</ArticleCategoryName>
<ArticleCategoryCode>string</ArticleCategoryCode>
<CountryOfOriginCode>string</CountryOfOriginCode>
<IsStockArticle>boolean</IsStockArticle>
<ArticleUnitCode>string</ArticleUnitCode>
<VatCode>string</VatCode>
<VatPercent>decimal</VatPercent>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<Price>decimal</Price>
<CustomerPrice>decimal</CustomerPrice>
<PurchasePrice>decimal</PurchasePrice>
<Weight>decimal</Weight>
<NetWeight>decimal</NetWeight>
<Volume>decimal</Volume>
<QuantityPerPallet>int</QuantityPerPallet>
<QuantityPerPackage>int</QuantityPerPackage>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
</DangerousGoods>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
</DangerousGoods>
<PurchaseCurrencyCode>string</PurchaseCurrencyCode>
<PurchaseCurrencyName>string</PurchaseCurrencyName>
<TaricNumbers>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
</TaricNumbers>
<BarCodePackage>string</BarCodePackage>
<BarCodePallet>string</BarCodePallet>
<SizeCode>string</SizeCode>
<SizeName>string</SizeName>
<ProcessArticleTime>dateTime</ProcessArticleTime>
<FreeDecimal1>decimal</FreeDecimal1>
<FreeDecimal2>decimal</FreeDecimal2>
<DefaultPickingLocation>string</DefaultPickingLocation>
<CustomsExportConditions>string</CustomsExportConditions>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
<StockLimit>int</StockLimit>
<ColorCode>string</ColorCode>
<ColorName>string</ColorName>
<DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
<ArticleZoneName>string</ArticleZoneName>
<GoodsCategory>
<Name>string</Name>
<Code>string</Code>
</GoodsCategory>
<LinkToPicture>string</LinkToPicture>
<ArticleCustomsDescription>string</ArticleCustomsDescription>
<FreeDecimal3>decimal</FreeDecimal3>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
</Article>
<OrderLineSystemId>int</OrderLineSystemId>
<DeliveryDate>dateTime</DeliveryDate>
<LastPickingTime>dateTime</LastPickingTime>
<StartPickingTime>dateTime</StartPickingTime>
<OrderLineComment>string</OrderLineComment>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<ParentExternalOrderLineCode>string</ParentExternalOrderLineCode>
<ParentOrderLineId>int</ParentOrderLineId>
<IsParentLine>boolean</IsParentLine>
<DoPick>boolean</DoPick>
<RowPrice>decimal</RowPrice>
<LinePrice>decimal</LinePrice>
<Discount>decimal</Discount>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<CurrencyCode>string</CurrencyCode>
<CurrencyName>string</CurrencyName>
<ReportedNumberOfItems>decimal</ReportedNumberOfItems>
<Batch>string</Batch>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<AcknowledgedNumberOfItems>decimal</AcknowledgedNumberOfItems>
<OrderLineCaseNo>string</OrderLineCaseNo>
<CustomerArticleNumber>string</CustomerArticleNumber>
<PickOrderInfo>
<PickOrderId>int</PickOrderId>
<BinIndex>int</BinIndex>
<PickOrderType>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</PickOrderType>
</PickOrderInfo>
<OrderLineTotalCustomsValue>decimal</OrderLineTotalCustomsValue>
<ReportedReturnedNumberOfItems>decimal</ReportedReturnedNumberOfItems>
<IsPickedWithErrors>boolean</IsPickedWithErrors>
<ReturnedNumberOfItems>decimal</ReturnedNumberOfItems>
<OrderLineType>
<Name>string</Name>
<Code>string</Code>
</OrderLineType>
<OrderLineWarehouseInstruction>string</OrderLineWarehouseInstruction>
</PickedOrderLine>
<PickedOrderLine>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<Description>string</Description>
<SupplierArticleNumber>string</SupplierArticleNumber>
<StatisticsNumber>string</StatisticsNumber>
<ArticleGroupName>string</ArticleGroupName>
<ArticleGroupCode>string</ArticleGroupCode>
<MainSupplierName>string</MainSupplierName>
<MainSupplierNumber>string</MainSupplierNumber>
<ArticleCategoryName>string</ArticleCategoryName>
<ArticleCategoryCode>string</ArticleCategoryCode>
<CountryOfOriginCode>string</CountryOfOriginCode>
<IsStockArticle>boolean</IsStockArticle>
<ArticleUnitCode>string</ArticleUnitCode>
<VatCode>string</VatCode>
<VatPercent>decimal</VatPercent>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<Price>decimal</Price>
<CustomerPrice>decimal</CustomerPrice>
<PurchasePrice>decimal</PurchasePrice>
<Weight>decimal</Weight>
<NetWeight>decimal</NetWeight>
<Volume>decimal</Volume>
<QuantityPerPallet>int</QuantityPerPallet>
<QuantityPerPackage>int</QuantityPerPackage>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
</DangerousGoods>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
</DangerousGoods>
<PurchaseCurrencyCode>string</PurchaseCurrencyCode>
<PurchaseCurrencyName>string</PurchaseCurrencyName>
<TaricNumbers>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
</TaricNumbers>
<BarCodePackage>string</BarCodePackage>
<BarCodePallet>string</BarCodePallet>
<SizeCode>string</SizeCode>
<SizeName>string</SizeName>
<ProcessArticleTime>dateTime</ProcessArticleTime>
<FreeDecimal1>decimal</FreeDecimal1>
<FreeDecimal2>decimal</FreeDecimal2>
<DefaultPickingLocation>string</DefaultPickingLocation>
<CustomsExportConditions>string</CustomsExportConditions>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
<StockLimit>int</StockLimit>
<ColorCode>string</ColorCode>
<ColorName>string</ColorName>
<DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
<ArticleZoneName>string</ArticleZoneName>
<GoodsCategory>
<Name>string</Name>
<Code>string</Code>
</GoodsCategory>
<LinkToPicture>string</LinkToPicture>
<ArticleCustomsDescription>string</ArticleCustomsDescription>
<FreeDecimal3>decimal</FreeDecimal3>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
</Article>
<OrderLineSystemId>int</OrderLineSystemId>
<DeliveryDate>dateTime</DeliveryDate>
<LastPickingTime>dateTime</LastPickingTime>
<StartPickingTime>dateTime</StartPickingTime>
<OrderLineComment>string</OrderLineComment>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<ParentExternalOrderLineCode>string</ParentExternalOrderLineCode>
<ParentOrderLineId>int</ParentOrderLineId>
<IsParentLine>boolean</IsParentLine>
<DoPick>boolean</DoPick>
<RowPrice>decimal</RowPrice>
<LinePrice>decimal</LinePrice>
<Discount>decimal</Discount>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<CurrencyCode>string</CurrencyCode>
<CurrencyName>string</CurrencyName>
<ReportedNumberOfItems>decimal</ReportedNumberOfItems>
<Batch>string</Batch>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<AcknowledgedNumberOfItems>decimal</AcknowledgedNumberOfItems>
<OrderLineCaseNo>string</OrderLineCaseNo>
<CustomerArticleNumber>string</CustomerArticleNumber>
<PickOrderInfo>
<PickOrderId>int</PickOrderId>
<BinIndex>int</BinIndex>
<PickOrderType>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</PickOrderType>
</PickOrderInfo>
<OrderLineTotalCustomsValue>decimal</OrderLineTotalCustomsValue>
<ReportedReturnedNumberOfItems>decimal</ReportedReturnedNumberOfItems>
<IsPickedWithErrors>boolean</IsPickedWithErrors>
<ReturnedNumberOfItems>decimal</ReturnedNumberOfItems>
<OrderLineType>
<Name>string</Name>
<Code>string</Code>
</OrderLineType>
<OrderLineWarehouseInstruction>string</OrderLineWarehouseInstruction>
</PickedOrderLine>
</PickedOrderLines>
<PickedArticleItems>
<PickedArticleItem>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
</Article>
<ArticleItemId>int</ArticleItemId>
<InDate>dateTime</InDate>
<Serial>string</Serial>
<CaseNo>string</CaseNo>
<BatchNo>string</BatchNo>
<Container>string</Container>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<LabelId>string</LabelId>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
<GoodsItemId>int</GoodsItemId>
<IsPicked>boolean</IsPicked>
<Returned>boolean</Returned>
<ShipmentId>int</ShipmentId>
<ExpiryDate>dateTime</ExpiryDate>
<ReturnDate>dateTime</ReturnDate>
<PickedTime>dateTime</PickedTime>
<OrderLineSystemId>int</OrderLineSystemId>
<Weight>decimal</Weight>
<ArticleItemPalletItemInfo>
<Id>int</Id>
<TypeCode>string</TypeCode>
<LabelId>string</LabelId>
<Parent>
<Id>int</Id>
<TypeCode>string</TypeCode>
<LabelId>string</LabelId>
<Parent>object of type PickedArticleItemPalletItemInfo</Parent>
<Serial>string</Serial>
<TypeLength>decimal</TypeLength>
<TypeWidth>decimal</TypeWidth>
<TypeHeight>decimal</TypeHeight>
<TypeWeight>decimal</TypeWeight>
</Parent>
<Serial>string</Serial>
<TypeLength>decimal</TypeLength>
<TypeWidth>decimal</TypeWidth>
<TypeHeight>decimal</TypeHeight>
<TypeWeight>decimal</TypeWeight>
</ArticleItemPalletItemInfo>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
<Volume>decimal</Volume>
<Location>string</Location>
<ArticleItemStatusCode>string</ArticleItemStatusCode>
<ArticleItemStatusName>string</ArticleItemStatusName>
<LocationTypeCode>string</LocationTypeCode>
<InOrderLineUnitPrice>decimal</InOrderLineUnitPrice>
<InOrderInfo>
<InOrderId>int</InOrderId>
<InOrderLineId>int</InOrderLineId>
</InOrderInfo>
<ArticleItemLength>decimal</ArticleItemLength>
<ArticleItemHeight>decimal</ArticleItemHeight>
<ArticleItemWidth>decimal</ArticleItemWidth>
<PickedArticleItemFreeText1>string</PickedArticleItemFreeText1>
<PickedByUserId>int</PickedByUserId>
<PickedByUserName>string</PickedByUserName>
<WarehouseCode>string</WarehouseCode>
<ArticleItemCategory>
<Code>string</Code>
<Name>string</Name>
<Id>int</Id>
</ArticleItemCategory>
<ReturnComment>string</ReturnComment>
<IsPacked>boolean</IsPacked>
</PickedArticleItem>
<PickedArticleItem>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
</Article>
<ArticleItemId>int</ArticleItemId>
<InDate>dateTime</InDate>
<Serial>string</Serial>
<CaseNo>string</CaseNo>
<BatchNo>string</BatchNo>
<Container>string</Container>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<LabelId>string</LabelId>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
<GoodsItemId>int</GoodsItemId>
<IsPicked>boolean</IsPicked>
<Returned>boolean</Returned>
<ShipmentId>int</ShipmentId>
<ExpiryDate>dateTime</ExpiryDate>
<ReturnDate>dateTime</ReturnDate>
<PickedTime>dateTime</PickedTime>
<OrderLineSystemId>int</OrderLineSystemId>
<Weight>decimal</Weight>
<ArticleItemPalletItemInfo>
<Id>int</Id>
<TypeCode>string</TypeCode>
<LabelId>string</LabelId>
<Parent>
<Id>int</Id>
<TypeCode>string</TypeCode>
<LabelId>string</LabelId>
<Parent>object of type PickedArticleItemPalletItemInfo</Parent>
<Serial>string</Serial>
<TypeLength>decimal</TypeLength>
<TypeWidth>decimal</TypeWidth>
<TypeHeight>decimal</TypeHeight>
<TypeWeight>decimal</TypeWeight>
</Parent>
<Serial>string</Serial>
<TypeLength>decimal</TypeLength>
<TypeWidth>decimal</TypeWidth>
<TypeHeight>decimal</TypeHeight>
<TypeWeight>decimal</TypeWeight>
</ArticleItemPalletItemInfo>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
<Volume>decimal</Volume>
<Location>string</Location>
<ArticleItemStatusCode>string</ArticleItemStatusCode>
<ArticleItemStatusName>string</ArticleItemStatusName>
<LocationTypeCode>string</LocationTypeCode>
<InOrderLineUnitPrice>decimal</InOrderLineUnitPrice>
<InOrderInfo>
<InOrderId>int</InOrderId>
<InOrderLineId>int</InOrderLineId>
</InOrderInfo>
<ArticleItemLength>decimal</ArticleItemLength>
<ArticleItemHeight>decimal</ArticleItemHeight>
<ArticleItemWidth>decimal</ArticleItemWidth>
<PickedArticleItemFreeText1>string</PickedArticleItemFreeText1>
<PickedByUserId>int</PickedByUserId>
<PickedByUserName>string</PickedByUserName>
<WarehouseCode>string</WarehouseCode>
<ArticleItemCategory>
<Code>string</Code>
<Name>string</Name>
<Id>int</Id>
</ArticleItemCategory>
<ReturnComment>string</ReturnComment>
<IsPacked>boolean</IsPacked>
</PickedArticleItem>
</PickedArticleItems>
<Transporter>
<Name>string</Name>
<Code>string</Code>
<ServiceCode>string</ServiceCode>
<Id>int</Id>
<TransporterName>string</TransporterName>
</Transporter>
<WsiSystem>
<UserName>string</UserName>
<PassWord>string</PassWord>
<SystemName>string</SystemName>
<ToSystemName>string</ToSystemName>
<FromSystemName>string</FromSystemName>
<FromWsiPath>string</FromWsiPath>
<ToWSiPath>string</ToWSiPath>
<Setting1>string</Setting1>
<Setting2>string</Setting2>
<Url>string</Url>
<ReportId>int</ReportId>
<ReportName>string</ReportName>
<ReportExportFormat>string</ReportExportFormat>
<OnErrorEmail>string</OnErrorEmail>
<Encoding>string</Encoding>
<OrderAdressGroupByCustomer>boolean</OrderAdressGroupByCustomer>
<MaximumOrderStatusForUpdate>int</MaximumOrderStatusForUpdate>
<ErrorOrderStatus>int</ErrorOrderStatus>
<GoodsOwnerId>int</GoodsOwnerId>
</WsiSystem>
<OrderPalletItems>
<OrderPalletItemInfo>
<Id>int</Id>
<TypeId>int</TypeId>
<LabelId>string</LabelId>
<Serial>string</Serial>
<PalletTypeCode>string</PalletTypeCode>
<NumberOfItems>decimal</NumberOfItems>
<GoodsCategoryTypeName>string</GoodsCategoryTypeName>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<PalletTypeName>string</PalletTypeName>
<IsReturnType>boolean</IsReturnType>
<IsTaPalletItem>boolean</IsTaPalletItem>
<Width>decimal</Width>
<Height>decimal</Height>
<Length>decimal</Length>
<LoadMeters>decimal</LoadMeters>
<Comment>string</Comment>
<ParentPalletItemId>int</ParentPalletItemId>
<Tracking>
<TrackingUrl>string</TrackingUrl>
</Tracking>
</OrderPalletItemInfo>
<OrderPalletItemInfo>
<Id>int</Id>
<TypeId>int</TypeId>
<LabelId>string</LabelId>
<Serial>string</Serial>
<PalletTypeCode>string</PalletTypeCode>
<NumberOfItems>decimal</NumberOfItems>
<GoodsCategoryTypeName>string</GoodsCategoryTypeName>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<PalletTypeName>string</PalletTypeName>
<IsReturnType>boolean</IsReturnType>
<IsTaPalletItem>boolean</IsTaPalletItem>
<Width>decimal</Width>
<Height>decimal</Height>
<Length>decimal</Length>
<LoadMeters>decimal</LoadMeters>
<Comment>string</Comment>
<ParentPalletItemId>int</ParentPalletItemId>
<Tracking>
<TrackingUrl>string</TrackingUrl>
</Tracking>
</OrderPalletItemInfo>
</OrderPalletItems>
<ExternalSystemId>int</ExternalSystemId>
<OrderShipments>
<OrderShipmentInfo>
<ShipmentId>int</ShipmentId>
<WayBill>string</WayBill>
<StatusId>int</StatusId>
</OrderShipmentInfo>
<OrderShipmentInfo>
<ShipmentId>int</ShipmentId>
<WayBill>string</WayBill>
<StatusId>int</StatusId>
</OrderShipmentInfo>
</OrderShipments>
<ReturnTransporter>
<TransporterContractId>int</TransporterContractId>
<TransporterCustomerNumber>string</TransporterCustomerNumber>
<TransporterName>string</TransporterName>
<ServiceName>string</ServiceName>
<ServiceCode>string</ServiceCode>
<ServiceId>int</ServiceId>
<TransporterContractEdiCode>string</TransporterContractEdiCode>
<WaybillTemplate>string</WaybillTemplate>
<TransporterCode>string</TransporterCode>
</ReturnTransporter>
<Warehouse>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</Warehouse>
<Shipment>
<ShipmentId>int</ShipmentId>
<Waybill>string</Waybill>
<StatusId>int</StatusId>
<ShipmentPalletItems>
<OrderShipmentPalletItemInfo>
<Id>int</Id>
<LabelId>string</LabelId>
<IsTaPalletItem>boolean</IsTaPalletItem>
<IsReturnTaPalletItem>boolean</IsReturnTaPalletItem>
<Comment>string</Comment>
<ParentPalletItemId>int</ParentPalletItemId>
<PalletTypeCode>string</PalletTypeCode>
</OrderShipmentPalletItemInfo>
<OrderShipmentPalletItemInfo>
<Id>int</Id>
<LabelId>string</LabelId>
<IsTaPalletItem>boolean</IsTaPalletItem>
<IsReturnTaPalletItem>boolean</IsReturnTaPalletItem>
<Comment>string</Comment>
<ParentPalletItemId>int</ParentPalletItemId>
<PalletTypeCode>string</PalletTypeCode>
</OrderShipmentPalletItemInfo>
</ShipmentPalletItems>
</Shipment>
<Tracking>
<OrderTrackingInfo>
<TrackingUrl>string</TrackingUrl>
<Waybill>string</Waybill>
<Created>dateTime</Created>
</OrderTrackingInfo>
<OrderTrackingInfo>
<TrackingUrl>string</TrackingUrl>
<Waybill>string</Waybill>
<Created>dateTime</Created>
</OrderTrackingInfo>
</Tracking>
</GetOrderResult>
</GetOrderResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetOrderResponse |
| GetOrderResult |
Order |
|
| Order |
| MessageId |
string |
Deprecated, don't use |
| Consignee |
Consignee |
Information about the customer/consignee |
| Consignor |
Consignor |
Information about the consignor |
| GoodsOwnerInfo |
GoodsOwnerInfo |
Information about the client |
| TransportPayer |
TransportPayer |
Information about the transport payer |
| Financial |
Financial |
Financial information about the transport |
| GoodsInfo |
GoodsInfo |
Summary of goods info |
| OrderInfo |
OrderInfoType |
Order head information |
| CommunicationInfo |
CommunicationInfo |
Deprecated, don't use |
| Success |
boolean |
Deprecated, don't use |
| GoodsItems |
GoodsItem[] |
Containing elements of GoodsItem, i.e waybill lines |
| PickedOrderLines |
PickedOrderLine[] |
Containing elements of PickedOrderLine. Order lines with picking info |
| PickedArticleItems |
PickedArticleItem[] |
Containing elements of PickedArticleItem, i.e. which article items were picked. You will only receive this information if it has been activated by Ongoing WMS. |
| Transporter |
TransporterClass |
Contains information about which transporter and transporter service is used for this order |
| WsiSystem |
WsiSystem |
Only for internal purposes, don't use |
| OrderPalletItems |
OrderPalletItemInfo[] |
Containing elements of OrderPalletItemInfo. Information about pallet items: boxes, pallets etc |
| ExternalSystemId |
int |
Only for internal purposes, don't use |
| OrderShipments |
OrderShipmentInfo[] |
Contains information about the shipments. |
| ReturnTransporter |
ReturnTransporterInfo |
Contains information about which transporter and transporter service is used for the return shipment.
Note that this object is only used when the return transporter service differs from the transporter service used to send goods to the customer. Put another way, this object is only used when the warehouse sends goods to a customer using transporter X, and includes a return label from transporter Y. |
| Warehouse |
OrderWarehouseInfo |
Contains elements of OrderWarehouseInfo. If a specific warehouse has been selected to handle this order, then this object will contain information about the warehouse. Note that there may be orders where no specific warehouse has been chosen. |
| Shipment |
OrderCurrentShipmentInfo |
Contains an element of OrderCurrentShipmentInfo. If the entire order has been placed on a shipment, then this object will contain information about the shipment. |
| Tracking |
OrderTrackingInfo[] |
Contains elements of type OrderTrackingInfo. Each element contains tracking information. Most orders will have at most one element, but it is possible for the warehouse to book several shipments for one order, which will result in several elements. |
| Consignee |
| Id |
int |
System id of the customer |
| Name |
string(200) |
Name |
| Address |
string(200) |
Address line 1 |
| Address2 |
string(200) |
Address line 2 |
| Address3 |
string(200) |
Address line 3 |
| PostCode |
string(50) |
Post code/zip |
| City |
string(200) |
City |
| CountryCode |
string(2) |
The two-letter ISO 3166-1 alpha-2 code of the country. |
| CountryStateCode |
string(50) |
The two-letter ISO 3166-2 abbreviation of the state. Mainly used for United States and Canada. See ISO 3166-2:US for United States and ISO 3166-2:CA for Canada. |
| IsEuCountry |
boolean |
True if country is within EU |
| TelePhone |
string(50) |
Telephone number (non cellular) |
| MobilePhone |
string(50) |
Mobile phone number (cellular) |
| Remark |
string(800) |
Remark/comment |
| Email |
string(300) |
Email address |
| DeliveryInstruction |
string(300) |
Delivery instruction |
| NotifyByEmail |
boolean |
True if the customer should be notified by the transporter through SMS |
| NotifyBySms |
boolean |
True if the customer should be notified by the transporter through e-mail |
| NotifyByTelephone |
boolean |
True if the customer should be notified by the transporter through phone call |
| CustomerNumber |
string(50) |
Customer number |
| CustomerGroupCode |
string(50) |
Customer group code |
| CustomerGroupName |
string(100) |
Customer group name |
| CustomerGroupComment |
string(200) |
Customer group comment |
| CustomerNumberPallets |
string(50) |
Pallet reg number |
| TermsOfPaymentTypeName |
string(100) |
Terms of delivery type name |
| TermsOfPaymentTypeCode |
string(50) |
Terms of delivery type code |
| InvoiceAddress |
ConsigneeInvoiceAddress |
Address object defining invoice address of the customer |
| AddressId |
int |
System id of the invoice address |
| DoorCode |
string(30) |
Code for the door at the delivery address |
| CustomerVATNumber |
string |
VAT number |
| OrganisationNumber |
string |
Organisation number |
| Consignor |
| Id |
int |
Ongoing WMS internal id of consignor (client/goods owner) |
| Name |
string(200) |
Name |
| Address |
string(200) |
Address line 1 |
| Address2 |
string(200) |
Address line 2 |
| Address3 |
string(200) |
Address line 3 |
| PostCode |
string(50) |
Post code/zip |
| City |
string(200) |
City |
| CountryCode |
string(2) |
The two-letter ISO 3166-1 alpha-2 code of the country. |
| TelePhone |
string(50) |
Telephone number (non cellular) |
| MobilePhone |
string(50) |
Mobile phone number (cellular) |
| Remark |
string |
Deprecated, don't use |
| Email |
string(300) |
Email address |
| GoodsOwnerInfo |
| Id |
int |
Ongoing WMS internal id of goods owner |
| GoodsOwnerReference |
string(100) |
Goods owner reference |
| Name |
string(200) |
Name of the goods owner |
| Address |
string(200) |
Address line 1 |
| Address2 |
string(200) |
Address line 2 |
| Address3 |
string(200) |
Address line 3 |
| PostCode |
string(50) |
Post code/zip |
| City |
string(200) |
City |
| CountryId |
int |
Ongoing WMS internal id of the country |
| TelePhone |
string(50) |
Telephone number (non cellular) |
| MobilePhone |
string(50) |
Mobile phone number (cellular) |
| Email |
string(300) |
Email address |
| GoodsLocationCode |
string(50) |
Goods location code |
| OrganizationNumber |
string(20) |
Organization number of goods owner |
| OrganizationVATNumber |
string(50) |
Organization VAT number of goods owner |
| GoodsOwnerAddressName |
string(200) |
Name |
| IsTrainingGoodsOwner |
boolean |
True is the goods owner has been marked as a training goods owner, false otherwise |
| FinancialCode |
string(50) |
The goods owner's financial code |
| GoodsOwnerContactReference |
string(100) |
The goods owner's contact reference |
| TransportPayer |
| CustomerCode |
string(50) |
Customer number at transporter |
| Name |
string(200) |
Name |
| Address |
string(200) |
Address (line 1) |
| PostCode |
string(50) |
Post code/zip |
| City |
string(200) |
City |
| CountryCode |
string(2) |
The two-letter ISO 3166-1 alpha-2 code of the country. |
| Financial |
| TransportPaymentType |
enum |
Defines who is paying for the transport
- Collect
- Prepaid
- ThirdParty
- UnKnown |
| ArticleCode |
string(50) |
Transporter article code |
| PriceListCode |
string(200) |
Transporter price list code. Often the same as the consignor code in the transport administrative system |
| TransporterAgreementId |
int |
Ongoing WMS internal id of the transport agreement |
| WaybillTemplate |
string(100) |
The name of the template (if any) used for this agreement |
| GoodsInfo |
| NumberOfGoodsItems |
int |
Number of goods rows |
| NumberOfPackages |
int |
Number of packages summed over goods rows |
| SummedGoodsItemParcels |
int |
Number of packages summed over goods rows |
| SummedGoodsItemWeight |
decimal |
Summed weight over goods rows, in kg |
| SummedGoodsItemVolume |
decimal |
Summed volume over goos rows, in m3 |
| SummedGoodsItemLoadMeters |
decimal |
Summed load meters over goods rows, in m |
| SummedGoodsItemArea |
decimal |
Summed area over goods rows, in m2 |
| SummedArticleItemWeight |
decimal |
Summed article weight, in kg |
| SummedArticleItemVolume |
decimal |
Summed article volume, in m3 |
| OrderInfoType |
| OrderId |
int |
Ongoing WMS internal id of the order |
| ReferenceNumber |
string(50) |
Reference number |
| ProfitCenter |
string(50) |
Profit center |
| GoodsOwnerName |
string(200) |
Goods owner name |
| Communication |
string(100) |
Communication info |
| GoodsOwnerEdiCode |
string(200) |
Same as PriceListCode from the Financial tag. Often the same as the consignor code in the transport administrative system |
| GoodsOwnerOrderNumber |
string(50) |
Order number |
| GoodsOwnerOrderId |
string(40) |
External order id |
| TransporterOrderNumber |
string(150) |
Transporter order number |
| ConsigneeOrderNumber |
string(150) |
Consignee order number |
| ExternalOrderCode |
string |
Deprecated, don't use |
| SalesCode |
string(500) |
Sales code. Often visible on package label (depending on transporter) |
| OrderRemark |
string(500) |
Remark/comment about the order |
| DeliveryInstruction |
string(300) |
Delivery instruction |
| WayOfDelivery |
string(50) |
Way of delivery |
| WayOfDeliveryTypeCode |
string(50) |
Way of delivery type code |
| WayOfDeliveryTypeName |
string(100) |
Way of delivery type name |
| TermsOfDelivery |
string(50) |
Terms of delivery |
| TermsOfPayment |
string(50) |
Terms of payment |
| OrderTypeCode |
string(50) |
Order type code |
| OrderTypeName |
string(50) |
Order type name |
| Language |
string(20) |
Language of the consignee, in ISO 639-1. E.g. SV, DE or EN. |
| InvoiceNumber |
string(200) |
Invoice number |
| InvoiceTypeCode |
string(50) |
Type code of the invoice |
| InvoiceUrl |
string(200) |
Url (http) to an invoice |
| ProductionCode |
string(30) |
Production code |
| PickUpDate |
dateTime |
Obsolete, do not use. |
| DeliveryDate |
dateTime |
Delivery date |
| CreatedDate |
dateTime |
Datetime of when the order was created |
| ShippedTime |
dateTime |
Datetime of when the order was marked as shipped |
| ArrivalDate |
dateTime |
Arrival date |
| ArrivalDateFrom |
dateTime |
First day of arrival |
| PrintedTime |
dateTime |
Datetime of when the order was printed |
| WayBill |
string(50) |
Waybill |
| CustomerPrice |
decimal |
Full price for order that the customer pays |
| FreightPrice |
decimal |
Price of freight |
| OrderStatusNumber |
int |
Current status number of order |
| OrderStatusText |
string(50) |
Status text of current status number |
| TransporterServicePointId |
int |
The system id of transporter service point |
| TransporterServicePointCode |
string(20) |
Code of transporter service point (not the same as OrderServicePointCode) |
| OrderServicePointCode |
string(50) |
Code of the service point that the customer wishes to pick up the package at |
| PickedNumberOfItems |
decimal |
Total picked number of items |
| OrderedNumberOfItems |
decimal |
Total ordered number of items |
| EmailNotification |
NotifyClass |
Contains information about email notification |
| TelephoneNotification |
NotifyClass |
Contains information about telephone notification |
| SMSNotification |
NotifyClass |
Contains information about sms notification |
| PickingPriority |
int |
Picking priority |
| BackOrderForOrderId |
int |
System id of the order that this order was created as a back order for |
| FinancialArticleCode |
string(50) |
Article code of transport agreement |
| FreeText1 |
string(300) |
Free text 1 |
| FreeText2 |
string(300) |
Free text 2 |
| FreeText3 |
string(300) |
Free text 3 |
| CurrentShipmentId |
int |
The id of the latest shipment for the order. |
| MarketPlace |
string(100) |
The market place where the order originated (e.g. "eBay", "Tradera", "Sello"). |
| MarketPlaceOrderNumber |
string(100) |
The order number at the market place where order originated. |
| ReturnWaybill |
string(50) |
The waybill for the return transport label. Is generally only available in those cases where a deviating return transporter is used (that is, when the order is sent to the customer with transporter X and a return label is printed using transporter Y). |
| ExchangeInfo |
ExchangeOrderInfo |
Contains information if current order is an exchange order |
| OrderCustomsInfo |
OrderCustomsInfo |
Contains customs information for the order |
| PreparedTransportDocumentId |
string(50) |
Reference to a transport document which been prepared in a separate transport administration system. Can be used for e.g nShift Checkout. |
| WarehouseInstruction |
string(500) |
Special instructions for the warehouse workers on how to handle the order. |
| TermsOfDeliveryType |
TermsOfDeliveryTypeInfo |
Contains an object of type TermsOfDeliveryTypeInfo, which has information about the terms of delivery for the order. |
| OrderClasses |
OrderClassInfo[] |
Contains a list of OrderClassInfo objects, each object representing an order class which the order belongs to. |
| OrderSortLocation |
string(100) |
The warehouse location used to sort the order (needs to be an actual location in the system) |
| GoodsItem |
| Id |
int |
System id of the goods item |
| GoodsItemLabelId |
string |
Label of the goods item row |
| PackageTypeName |
string(100) |
Name of the package type |
| PackageTypeCode |
string(50) |
Code of the package type |
| Area |
decimal |
Area of the goods item, in m2 |
| Weight |
decimal |
Weight of the goods item, in kg |
| Volume |
decimal |
Volume of the goods item, in m3 |
| Height |
decimal |
Height of the goods item, in m |
| Length |
decimal |
Length of the goods item, in m |
| Width |
decimal |
Width of the goods item, in m |
| LoadMeters |
decimal |
Load meters of the goods item, in m |
| NumberOfItems |
int |
Number of rows/shipping lines this goods item contains |
| NumberOfPackages |
int |
Number of packages for each row/shipping line |
| ApprovedNumberOfPackages |
int |
Number of approved packages for each row/shipping line |
| GoodsComment |
string(400) |
Comment of the goods item |
| GoodsCategory |
string(100) |
Goods category/description of the goods item |
| PickedOrderLine |
| Article |
ArticleClass |
Article of the order line. |
| OrderLineSystemId |
int |
System id of the order line |
| DeliveryDate |
dateTime |
Delivery date of the order line |
| LastPickingTime |
dateTime |
Latest datetime that the order line was picked |
| StartPickingTime |
dateTime |
First datetime that the order line was picked |
| OrderLineComment |
string(300) |
Order line comment |
| OrderedNumberOfItems |
decimal |
Ordered number of items |
| PickedNumberOfItems |
decimal |
Picked number of items |
| ExternalOrderLineCode |
string(40) |
External order line code |
| ParentExternalOrderLineCode |
string |
External order line code of the paren line (if any) |
| ParentOrderLineId |
int |
If the order line is a sub orderline, then ParentOrderLineIdis the system id of the parent order line |
| IsParentLine |
boolean |
True if this is a parent order line |
| DoPick |
boolean |
False if this orderline should not be picked/shipped. |
| RowPrice |
decimal |
Row price, corresponds to CustomerLinePrice in ProcessOrder |
| LinePrice |
decimal |
Price of the order line |
| Discount |
decimal |
Discount of the order line |
| Length |
decimal |
Length in m |
| Width |
decimal |
Width in m |
| Height |
decimal |
Height in m |
| CurrencyCode |
string(20) |
Currency code of order line, in ISO 4217. E.g. SEK, NOK or EUR |
| CurrencyName |
string(50) |
Currency name of order line |
| ReportedNumberOfItems |
decimal |
Reported number of items |
| Batch |
string(50) |
Ordered batch of this order line |
| AllocatedNumberOfItems |
decimal |
Allocated number of items (not yet picked) |
| AcknowledgedNumberOfItems |
decimal |
Acknowledged number of items |
| OrderLineCaseNo |
string(100) |
Case number of the order line |
| CustomerArticleNumber |
string(100) |
Customer's own article number for the order line |
| PickOrderInfo |
PickedOrderLinePickOrderInfo |
Contains an element of type PickedOrderLinePickOrderInfo.
The warehouse may opt to collect several different orders onto a single, combined picklist which is called a pick order in Ongoing WMS. If they do this, then this object will contain information abouth the pick order.
Note that each order line may be placed on a separate pick order (but this is unusual - generally all order lines from the same order are placed on the same pick order).
Click here for more information about pick orders. |
| OrderLineTotalCustomsValue |
decimal |
Total customs value for this order line. The currency is sent in the field CustomsValueCurrencyCode. |
| ReportedReturnedNumberOfItems |
decimal |
Reported returned number of items. |
| IsPickedWithErrors |
boolean |
Whether or not this line has been marked as having been picked with errors. |
| ReturnedNumberOfItems |
decimal |
Number of items which have been returned. |
| OrderLineType |
OrderLineTypeInfo |
An object of type OrderLineTypeInfo, representing the order line type. |
| OrderLineWarehouseInstruction |
string |
Order line warehouse instruction |
| PickedArticleItem |
| Article |
ArticleClass |
Article of the article item. |
| ArticleItemId |
int |
System id of the article item |
| InDate |
dateTime |
Inbound date |
| Serial |
string(128) |
Serial number |
| CaseNo |
string(100) |
Case number |
| BatchNo |
string(50) |
Batch |
| Container |
string(50) |
Container |
| ExternalOrderLineCode |
string(40) |
External order line code of the order line that this item was picked for |
| LabelId |
string(30) |
Deprecated, don't use |
| Comment |
string(400) |
Comment |
| NumberOfItems |
decimal |
Number of items that this article item represents |
| GoodsItemId |
int |
Goods item system id of the goods item that is associated with the order line this item was picked for |
| IsPicked |
boolean |
True if the item is picked (item is only allocated if false) |
| Returned |
boolean |
True if this item is returned to stock |
| ShipmentId |
int |
System id of the shipment this item is associated with |
| ExpiryDate |
dateTime |
Expiry date |
| ReturnDate |
dateTime |
Datetime of when (if) this article was returned |
| PickedTime |
dateTime |
Datetime of when the article was picked |
| OrderLineSystemId |
int |
System id of the order line that this item was picked for |
| Weight |
decimal |
Weight in kg |
| ArticleItemPalletItemInfo |
PickedArticleItemPalletItemInfo |
Information about the pallet item that (if) this article was packed into a pallet item. Elements of type ArticleItemPalletItemInfo. |
| ReturnCauseCode |
string(100) |
Return casue code, if the item is returned and associated with a return casue |
| ReturnCauseName |
string(200) |
Return casue name, if the item is returned and associated with a return casue |
| Volume |
decimal |
Volume |
| Location |
string(50) |
Name of the location where the goods was picked |
| ArticleItemStatusCode |
string(50) |
Status code for the item, if the item has been given a status |
| ArticleItemStatusName |
string(100) |
Status name for the item, if the item has been given a status |
| LocationTypeCode |
string(50) |
The location type code of the location where the goods was picked |
| InOrderLineUnitPrice |
decimal |
The unit price of the item, taken from the items InOrder (if existing) |
| InOrderInfo |
PickedArticleItemInOrderInfo |
Element of PickedArticleItemInOrderInfo, containing info about which inorder was originally used when the item was received in the warehouse |
| ArticleItemLength |
decimal |
The length of this particular item. Note that this field is generally only used in a minority of cases, where two pieces of the same article/SKU can have _i_differentbackslash_i lengths. |
| ArticleItemHeight |
decimal |
The height of this particular item. Note that this field is generally only used in a minority of cases, where two pieces of the same article/SKU can have _i_differentbackslash_i heights. |
| ArticleItemWidth |
decimal |
The height of this particular item. Note that this field is generally only used in a minority of cases, where two pieces of the same article/SKU can have _i_differentbackslash_i widths. |
| PickedArticleItemFreeText1 |
string(200) |
Free text which was entered on the item during picking |
| PickedByUserId |
int |
Ongoing internal id of the user who picked this item |
| PickedByUserName |
string(50) |
User name of the user who picked this item |
| WarehouseCode |
string(50) |
Code of the warehouse where this item was picked |
| ArticleItemCategory |
ArticleItemCategory_PickedArticleItem |
Object of type ArticleItemCategory_PickedArticleItem which shows which article item category the article item has. |
| ReturnComment |
string |
If the item has been returned, the warehouse may opt to enter a comment which relates to the return. |
| IsPacked |
boolean |
True if this item is packed |
| TransporterClass |
| Name |
string(80) |
Transporter service name |
| Code |
string(50) |
Transporter code |
| ServiceCode |
string(50) |
Transporter service code |
| Id |
int |
System id of the transporter |
| TransporterName |
string(80) |
Transporter name |
| OrderPalletItemInfo |
| Id |
int |
System id of the pallet item |
| TypeId |
int |
System id of the package type |
| LabelId |
string(30) |
Label number |
| Serial |
string(100) |
Serial number |
| PalletTypeCode |
string |
Code of the pallet type |
| NumberOfItems |
decimal |
Number of items specified on this pallet (i.e. not number of packed sub pallet items, this field is manually filled and meaning of this value must therefore be agreed on beforehand with the warehouse) |
| GoodsCategoryTypeName |
string |
Goods category |
| Weight |
decimal |
Weight |
| Volume |
decimal |
Volume |
| PalletTypeName |
string |
Name of the pallet type |
| IsReturnType |
boolean |
Determines if the pallet item was intended for returns to the warehouse |
| IsTaPalletItem |
boolean |
Determines if the pallet it was created automatically by a Transport Administration system such as nShift Delivery |
| Width |
decimal |
Width |
| Height |
decimal |
Height |
| Length |
decimal |
Length |
| LoadMeters |
decimal |
Load meters |
| Comment |
string(300) |
Pallet item comment |
| ParentPalletItemId |
int |
System id of the parent pallet item |
| Tracking |
PalletItemTrackingInfo |
Containg tracking information about the pallet item (like the transporter's tracking number). |
| OrderShipmentInfo |
| ShipmentId |
int |
System id for the shipment |
| WayBill |
string(50) |
Waybill for the shipment |
| StatusId |
int |
System status id for the shipment |
| ReturnTransporterInfo |
| TransporterContractId |
int |
|
| TransporterCustomerNumber |
string |
|
| TransporterName |
string |
|
| ServiceName |
string |
|
| ServiceCode |
string |
|
| ServiceId |
int |
|
| TransporterContractEdiCode |
string |
|
| WaybillTemplate |
string |
|
| TransporterCode |
string |
|
| OrderWarehouseInfo |
| Name |
string(300) |
Name of the warehouse for this particular order |
| Code |
string(50) |
Code of the warehouse for this particular order |
| Id |
int |
Id of the warehouse for this particular order |
| OrderCurrentShipmentInfo |
| ShipmentId |
int |
Ongoing WMS internal id of the shipment |
| Waybill |
string(50) |
The shipment's waybill number |
| StatusId |
int |
The status of the shipment |
| ShipmentPalletItems |
OrderShipmentPalletItemInfo[] |
A list of OrderShipmentPalletItemInfo objects, which show which pallet items are on the shipment |
| OrderTrackingInfo |
| TrackingUrl |
string(300) |
Tracking URL |
| Waybill |
string(50) |
The waybill number for this particular tracking |
| Created |
dateTime |
The time when this tracking information was added to the order |
| ConsigneeInvoiceAddress |
| AddressId |
int |
System id of the invoice address |
| Name |
string |
Name |
| Address |
string |
Address line 1 |
| Address2 |
string |
Address line 2 |
| Address3 |
string |
Address line 3 |
| PostCode |
string |
Post code/zip |
| City |
string |
City |
| CountryCode |
string |
The two-letter ISO 3166-1 alpha-2 code of the country. |
| CountryName |
string |
Name of the country |
| TelePhone |
string |
Telephone number (non cellular) |
| MobilePhone |
string |
Mobile phone number (cellular) |
| Email |
string |
Email address |
| CountryStateCode |
string |
The two-letter ISO 3166-2 abbreviation of the state. Mainly used for United States and Canada. See ISO 3166-2:US for United States and ISO 3166-2:CA for Canada. |
| NotifyClass |
| ToBeNotified |
boolean |
Whether or not the consignee should be notified by the transporter when the package is in transit. |
| Value |
string |
Telephone number, mobile number or email, depending on what kind of notification it is. |
| ExchangeOrderInfo |
| ForOrderId |
int |
The order was created as an exchange order for this OrderId. |
| ForOrderNumber |
string |
The order was created as an exchange order for this order number. |
| OrderCustomsInfo |
| CustomsValueCurrencyCode |
string(20) |
The customs currency of the order. Only applicable if each order line also has customs values (see the field OrderLineTotalCustomsValue). |
| TermsOfDeliveryTypeInfo |
| Code |
string(50) |
The code of the terms of delivery |
| Name |
string(100) |
The name of the terms of delivery |
| OrderClassInfo |
| Code |
string(200) |
The code of the order class |
| Name |
string(200) |
The name of the order class |
| ArticleClass |
| SystemId |
int |
System id of the article |
| Name |
string(200) |
Article name |
| ArticleNumber |
string |
Article number |
| ProductCode |
string(200) |
Product code |
| StatisticsNumber |
string |
Statistical number/harmonization code |
| ArticleCategoryName |
string(200) |
Article category name |
| ArticleCategoryCode |
string(50) |
Article category code |
| VatCode |
string(50) |
VAT code |
| VatPercent |
decimal |
VAT percent |
| TaricNumbers |
TaricNumbersInfo |
Taric numbers by country |
| ProcessArticleTime |
dateTime |
The last time ProcessArticle was called for this article. Note that it is possible to have articles which were created by other means than ProcessArticle, e.g. an article may have been created manually in the system. |
| IsSerialNumberArticle |
boolean |
Whether or not the article is a serial number article. |
| PickedOrderLinePickOrderInfo |
| PickOrderId |
int |
System id for the pick order which the order line has been placed on |
| BinIndex |
int |
The bin number in the picking cart which this order line was picked to |
| PickOrderType |
PickedOrderLinePickOrderTypeInfo |
Pick order type object with information about pick order type |
| OrderLineTypeInfo |
| Name |
string(100) |
The name of the order line type. |
| Code |
string(100) |
The code of the order line type. |
| PickedArticleItemPalletItemInfo |
| Id |
int |
System id of the pallet item |
| TypeCode |
string(50) |
Code of the package type |
| LabelId |
string(30) |
Label number |
| Parent |
PickedArticleItemPalletItemInfo |
If this pallet item was packed in another pallet item (box on pallet for instance) this is the PickedArticleItemPalletItemInfo of that pallet item |
| Serial |
string(100) |
Serial no |
| TypeLength |
decimal |
Length of the pallet type, in m |
| TypeWidth |
decimal |
Width of the pallet type, in m |
| TypeHeight |
decimal |
Height of the pallet type, in m |
| TypeWeight |
decimal |
Weight of the pallet type, in kg |
| PickedArticleItemInOrderInfo |
| InOrderId |
int |
System id for the inorder which was used to received the picked item into the warehouse. You can use GetInOrdersByQuery to query the system for more information about this inorder. |
| InOrderLineId |
int |
System id for the inorder line which was used to received the picked item into the warehouse |
| ArticleItemCategory_PickedArticleItem |
| Code |
string(100) |
The article item category code. |
| Name |
string(100) |
The article item category name. |
| Id |
int |
The article item category id. |
| PalletItemTrackingInfo |
| TrackingUrl |
string(300) |
Tracking URL for this pallet item |
| OrderShipmentPalletItemInfo |
| Id |
int |
Ongoing WMS internal id of the pallet item |
| LabelId |
string(30) |
The pallet item's label number |
| IsTaPalletItem |
boolean |
Determines if the pallet it was created automatically by a Transport Administration system such as nShift Delivery |
| IsReturnTaPalletItem |
boolean |
Determines if the pallet item was intended for returns to the warehouse |
| Comment |
string(300) |
Pallet item comment |
| ParentPalletItemId |
int |
If the pallet item has been placed in another pallet item, then this field contains the id of the parent pallet item |
| PalletTypeCode |
string |
Code of the pallet type |
| DangerousGoods |
| UNNumber |
string(10) |
UNNumber of ADR specification |
| UNIsMarineHazard |
boolean |
True if ADR is classed as a marine hazard |
| UNIsDangerousGoods |
boolean |
True if ADR is classed as dangerous goods |
| UNPackageType |
enum |
Package type
- I
- II
- III
- Unknown |
| UNTunnelCodes |
UNTunnelCode[] |
Tunnel codes of ADR |
| UNClassNumber |
string(50) |
Class number of ADR |
| UNProperShippingName |
ProperShippingName |
Elements of UNProperShippingName |
| UNLabelNumbers |
string(50) |
Label numbers of ADR |
| DangerousGoodsCoefficient |
decimal |
ADR Coefficient |
| EmSCode |
string |
EmS |
| TaricNumbersInfo |
| TaricNumber |
TaricNumberInfoClass |
List of TARIC number objects |
| GoodsCategoryInfo |
| Name |
string |
Goods category name |
| Code |
string |
Goods category code |
| PickedOrderLinePickOrderTypeInfo |
| Name |
string(100) |
Name for the pick order type. |
| Code |
string(100) |
Code for the pick order type. |
| Id |
int |
System id for the pick order type. |
| ProperShippingName |
| Name |
string |
Proper shipping name |
| LanguageCode |
string |
Language code |
| TaricNumberInfoClass |
| CountryCode |
string |
Country code |
| TaricNumber |
string |
TARIC number |