Ongoing Warehouse logo

Ongoing Warehouse Developer

GetOrder

This is the most basic of the various GetOrder-functions. It allows you to retrieve an order if you know the internal Ongoing id of the order (the OrderId). Otherwise use GetOrderByOrderNumber or GetOrdersByQuery.

Tags: GetOrder, GetOrderResult, Consignee, Consignor, GoodsOwnerInfo, TransporterPayer, Financial, GoodsInfo, OrderInfo, GoodsItem, PickedOrderLine, PickedArticleItem, Transporter, OrderPalletItemInfo, OrderShipmentInfo

Request XML

POST /[systemname]/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 str(50) Req. Your username
Password str(50) Req. Your password
OrderId int Req. The system id of the order

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
            </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>
            </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>
            </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 xsi:nil="true" />
                  <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>
               </PickedOrderLine>
               <PickedOrderLine>
                  <Article xsi:nil="true" />
                  <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>
               </PickedOrderLine>
            </PickedOrderLines>
            <PickedArticleItems>
               <PickedArticleItem>
                  <Article xsi:nil="true" />
                  <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 xsi:nil="true" />
                  <ReturnCauseCode>string</ReturnCauseCode>
                  <ReturnCauseName>string</ReturnCauseName>
                  <Volume>decimal</Volume>
                  <Location>string</Location>
                  <ArticleItemStatusCode>string</ArticleItemStatusCode>
                  <ArticleItemStatusName>string</ArticleItemStatusName>
                  <LocationTypeCode>string</LocationTypeCode>
                  <InOrderLineUnitPrice>decimal</InOrderLineUnitPrice>
               </PickedArticleItem>
               <PickedArticleItem>
                  <Article xsi:nil="true" />
                  <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 xsi:nil="true" />
                  <ReturnCauseCode>string</ReturnCauseCode>
                  <ReturnCauseName>string</ReturnCauseName>
                  <Volume>decimal</Volume>
                  <Location>string</Location>
                  <ArticleItemStatusCode>string</ArticleItemStatusCode>
                  <ArticleItemStatusName>string</ArticleItemStatusName>
                  <LocationTypeCode>string</LocationTypeCode>
                  <InOrderLineUnitPrice>decimal</InOrderLineUnitPrice>
               </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>
               <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>
               </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>
               </OrderPalletItemInfo>
            </OrderPalletItems>
            <OrderShipments>
               <OrderShipmentInfo>
                  <ShipmentId>int</ShipmentId>
                  <WayBill>string</WayBill>
                  <StatusId>int</StatusId>
               </OrderShipmentInfo>
               <OrderShipmentInfo>
                  <ShipmentId>int</ShipmentId>
                  <WayBill>string</WayBill>
                  <StatusId>int</StatusId>
               </OrderShipmentInfo>
            </OrderShipments>
            <ExternalSystemId>int</ExternalSystemId>
         </GetOrderResult>
      </GetOrderResponse>
   </soap:Body>
</soap:Envelope>
+

Response specification

GetOrderResult
MessageId int Deprecated, don't use
Consignee object Information about the customer/consignee
Consignor object Information about the consignor
GoodsOwnerInfo object Information about the client
TransportPayer object Information about the transport payer
Financial object Financial information about the transport
GoodsInfo object Summary of goods info
OrderInfo object Order head information
CommunicationInfo object Deprecated, don't use
Success bool Deprecated, don't use
GoodsItems object Containing elements of GoodsItem, i.e waybill lines
PickedOrderLines object Containing elements of PickedOrderLine. Order lines with picking info
PickedArticleItems object Containing elements of PickedArticleItem, i.e. which article items were picked. You will only receive this information if it has been activated by Ongoing.
Transporter object Transporter/service info
WsiSystem object Only for internal purposes, don't use
OrderPalletItems object Containing elements of OrderPalletItemInfo. Information about pallet items: boxes, pallets etc
ExternalSystemId int Only for internal purposes, don't use
OrderShipmentInfo object Contains information about the shipments.
Consignee
Id int System id of the customer
Name str(200) Name
Address str(200) Address line 1
Address2 str(200) Address line 2
Address3 str(200) Address line 3
PostCode str(50) Post code/zip
City str(200) City
CountryCode str(2) The two-letter ISO 3166-1 alpha-2 code of the country.
CountryStateCode str(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 bool True if country is within EU
TelePhone str(50) Telephone number (non cellular)
MobilePhone str(50) Mobile phone number (cellular)
Remark str(800) Remark/comment
Email str(300) Email address
DeliveryInstruction str(300) Delivery instruction
NotifyByEmail bool True if the customer should be notified by the transporter through SMS
NotifyBySms bool True if the customer should be notified by the transporter through e-mail
NotifyByTelephone bool True if the customer should be notified by the transporter through phone call
CustomerNumber str(50) Customer number
CustomerGroupCode str(50) Customer group code
CustomerGroupName str(100) Customer group name
CustomerGroupComment str(200) Customer group comment
CustomerNumberPallets str(50) Pallet reg number
TermsOfPaymentTypeName str(100) Terms of delivery type name
TermsOfPaymentTypeCode str(50) Terms of delivery type code
InvoiceAddress object Address object defining invoice address of the customer
> AddressId int System id of the invoice address
> Name str(200) Name
> Address str(200) Address line 1
> Address2 str(200) Address line 2
> Address3 str(200) Address line 3
> PostCode str(50) Post code/zip
> City str(200) City
> CountryCode str(50) The two-letter ISO 3166-1 alpha-2 code of the country.
> CountryName str(100) Name of the country
> TelePhone str(50) Telephone number (non cellular)
> MobilePhone str(50) Mobile phone number (cellular)
> Email str(300) Email address
> CountryStateCode str(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.
AddressId int System id of the delivery address
DoorCode str(30) Code for the door at the delivery address
Consignor
Id int  Ongoing system id of consignor (client/goods owner)
Name str(200) Name
Address str(200) Address line 1
Address2 str(200) Address line 2
Address3 str(200) Address line 3
PostCode str(50) Post code/zip
City str(200) City
CountryCode str(2) The two-letter ISO 3166-1 alpha-2 code of the country.
TelePhone str(50) Telephone number (non cellular)
MobilePhone str(50) Mobile phone number (cellular)
Remark str(0) Deprecated, don't use
Email str(300) Email address
GoodsOwnerInfo
Id int Ongoing system id of goods owner
GoodsOwnerReference str(100) Goods owner reference
Name str(200) Name of the goods owner
Address str(200) Address line 1
Address2 str(200) Address line 2
Address3 str(200) Address line 3
PostCode str(50) Post code/zip
City str(200) City
CountryId int Ongoing system id of the country
Telephone str(50) Telephone number (non cellular)
MobilePhone str(50) Mobile phone number (cellular)
Email str(300) Email address
GoodsLocationCode str(50) Goods location code
OrganizationNumber str(20) Organization number of goods owner
OrganizationVATNumber str(50) Organization VAT number of goods owner
GoodsOwnerAddressName str(200) Name
TransporterPayer
CustomerCode str(50) Customer number at transporter
Name str(200) Name
Address str(200) Address (line 1)
PostCode str(50) Post code/zip
City str(200) City
CountryCode str(2) The two-letter ISO 3166-1 alpha-2 code of the country.
Financial
TransporterPaymentType enum Defines who is paying for the transport
 - Collect
 - Prepaid
 - ThirdParty
 - UnKnown
ArticleCode str(50) Transporter article code
PriceListCode str(200) Transporter price list code. Often the same as the consignor code in the transport administrative system
TransporterAgreementId int Ongoing system id of the transport agreement
WaybillTemplate str(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 dec Summed weight over goods rows, in kg
SummedGoodsItemVolume dec Summed volume over goos rows, in m3
SummedGoodsItemLoadMeters dec Summed load meters over goods rows, in m
SummedGoodsItemArea dec Summed area over goods rows, in m2
SummedArticleItemWeight dec Summed article weight, in kg
SummedArticleItemVolume dec Summed article volume, in m3
OrderInfo
OrderId int Ongoing system id of the order
ReferenceNumber str(50) Reference number
ProfitCenter str(50) Profit center
GoodsOwnerName str(200) Goods owner name
Communication str(100) Communication info
GoodsOwnerEdiCode str(200) Same as PriceListCode from the Financial tag. Often the same as the consignor code in the transport administrative system
GoodsOwnerOrderNumber str(50) Order number
GoodsOwnerOrderId str(40) External order id
TransporterOrderNumber str(150) Transporter order number
ConsigneeOrderNumber str(150) Consignee order number
ExternalOrderCode str(0) Deprecated, don't use
SalesCode str(500) Sales code. Often visible on package label (depending on transporter)
OrderRemark str(500) Remark/comment about the order
DeliveryInstruction str(300) Delivery instruction
WayOfDelivery str(50) Way of delivery
WayOfDeliveryTypeCode str(50) Way of delivery type code
WayOfDeliveryTypeName str(100) Way of delivery type name
TermsOfDelivery str(50) Terms of delivery
TermsOfPayment str(50) Terms of payment
OrderTypeCode str(50) Order type code
OrderTypeName str(50) Order type name
Language str(20) Language of the consignee, in ISO 639-1. E.g. SV, DE or EN.
InvoiceNumber str(200) Invoice number
InvoiceTypeCode str(50) Type code of the invoice
InvoiceUrl str(200) Url (http) to an invoice
ProductionCode str(30) Production code
PickUpDate datetime Delivery date (currently same value as DeliveryDate)
DeliveryDate datetime Delivery date (currently same value as PickUpDate)
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 str(50) Waybill
CustomerPrice dec Full price for order that the customer pays
FreightPrice dec Price of freight
OrderStatusNumber int Current status number of order
OrderStatusText str(50) Status text of current status number
TransporterServicePointId int The system id of transporter service point
TransporterServicePointCode str(20) Code of transporter service point (not the same as OrderServicePointCode)
OrderServicePointCode str(50) Code of the service point that the customer wishes to pick up the package at
PickedNumberOfItems dec Total picked number of items
OrderedNumberOfItems dec Total ordered number of items
EmailNotification object Contains information about email notification
> ToBeNotified bool True if the customer should be notified by the transporter through e-mail
> Value str(200) Email address to notify
TelephoneNotification object Contains information about telephone notification
> ToBeNotified bool True if the customer should be notified by the transporter through phone call
> Value str(50) Telephone number to notify
SMSNotification object Contains information about sms notification
> ToBeNotified bool True if the customer should be notified by the transporter through SMS
> Value str(50) Mobile phone number to notify
PickingPriority int Picking priority
BackOrderForOrderId int System id of the order that this order was created as a back order for
FinancialArticleCode str(50) Article code of transport agreement
FreeText1 str(300) Free text 1
FreeText2 str(50) Free text 2
FreeText3 str(50) Free text 3
CurrentShipmentId int The id of the latest shipment for the order.
GoodsItem
Id int System id of the goods item
GoodsItemLabelId long Label of the goods item row
PackageTypeName str(100) Name of the package type
PackageTypeCode str(50) Code of the package type
Area dec Area of the goods item, in m2
Weight dec Weight of the goods item, in kg
Volume dec Volume of the goods item, in m3
Height dec Height of the goods item, in m
Length dec Length of the goods item, in m
Width dec Width of the goods item, in m
LoadMeters dec 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 str(400) Comment of the goods item
GoodsCategory str(100) Goods category/description of the goods item
PickedOrderLine
Article object Article of the order line. See GetInventory for specification of the Article object.
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 str(300) Order line comment
OrderedNumberOfItems dec Ordered number of items
PickedNumberOfItems dec Picked number of items
ExternalOrderLineCode str(40) External order line code
ParentOrderLineId int If the order line is a sub orderline, then ParentOrderLineIdis the system id of the parent order line
IsParentLine bool True if this is a parent order line
DoPick bool False if this orderline should not be picked/shipped.
RowPrice dec Row price, corresponds to CustomerLinePrice in ProcessOrder
LinePrice dec Price of the order line
Discount dec Discount of the order line
Length dec Length in m
Width dec Width in m
Height dec Height in m
CurrencyCode str(20) Currency code of order line, in ISO 4217. E.g. SEK, NOK or EUR
CurrencyName str(50) Currency name of order line
ReportedNumberOfItems dec Reported number of items
Batch str(50) Ordered batch of this order line
AllocatedNumberOfItems dec Allocated number of items (not yet picked)
AcknowledgedNumberOfItems dec Acknowledged number of items
OrderLineCaseNo str(100) Case number of the order line
CustomerArticleNo str(100) Customer's own article number for the order line
PickedArticleItem
Article object Article of the article item. See GetInventory for specification of the Article object.
ArticleItemId int System id of the article item
InDate datetime Inbound date
Serial str(128) Serial number
CaseNo str(100) Case number
BatchNo str(50) Batch
Container str(50) Container
ExternalOrderLineCode str(40) External order line code of the order line that this item was picked for
LabelId str(30) Deprecated, don't use
Comment str(400) Comment
NumberOfItems dec 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 bool True if the item is picked (item is only allocated if false)
Returned bool 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 dec Weight in kg
ArticleItemPalletItemInfo object Informat about the pallet item that (if) this article was packed into a pallet item
> Id int System id of the pallet item
> TypeCode str(50) Code of the package type
> LabelId str(30) Label number
> Parent object If this pallet item was packed in another pallet item (box on pallet for instance) this is the ArticleItemPalletItemInfo of that pallet item
> Serial str(100) Serial no
> TypeLength dec Length of the pallet type, in m
> TypeWidth dec Width of the pallet type, in m
> TypeHeight dec Height of the pallet type, in m
> TypeWeight dec Weight of the pallet type, in kg
ReturnCauseCode str(100) Return casue code, if the item is returned and associated with a return casue
ReturnCauseName str(200) Return casue name, if the item is returned and associated with a return casue
Location str(50) Name of the location where the goods was picked
ArticleItemStatusCode str(50) Status code for the item, if the item has been given a status
ArticleItemStatusName str(100) Status name for the item, if the item has been given a status
LocationTypeCode str(50) The location type code of the location where the goods was picked
InOrderLineUnitPrice dec The unit price of the item, taken from the items InOrder (if existing)
Transporter
Name str(80) Transporter service name
Code str(50) Transporter code
ServiceCode str(50) Transporter service code
Id int System id of the transporter
TransporterName str(80) Transporter name
OrderPalletItemInfo
Id int System id of the pallet item
TypeId int System id of the package type
LabelId str(30) Label number
Serial str(100) Serial number
PalletTypeCode str Code of the pallet type
PalletTypeName str Name of the pallet type
NumberOfItems dec Number of items packed on this pallet
GoodsCategoryTypeName str Goods category
Length dec Length
Width dec Width
Height dec Height
Volume dec Volume
Weight dec Weight
IsReturnType bool Determines if the pallet item was intended for returns to the warehouse
IsTaPalletItem bool Determines if the pallet it was created automatically by a Transport Administration system such as Unifaun
LoadMeters dec Load meters
OrderShipmentInfo
ShipmentId int System id for the shipment
WayBill str(50) Waybill for the shipment
StatusId int System status id for the shipment