GetOrderByOrderNumber
GetOrderByOrderNumber is basically the same function as GetOrder. The difference is that GetOrderByOrderNumber uses the GoodsOwnerOrderNumber to find the order, instead of OrderId.
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/GetOrderByOrderNumber"
<?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>
<GetOrderByOrderNumber xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<OrderNumber>string</OrderNumber>
</GetOrderByOrderNumber>
</soap:Body>
</soap:Envelope>Request specification
| GetOrderByOrderNumber | |||
|---|---|---|---|
| GoodsOwnerCode | str(400) | Req. | The name/code of your client |
| UserName | str(50) | Req. | Your username |
| Password | str(50) | Req. | Your password |
| OrderNumber | str(50) | Req. | Order number (GoodsOwnerOrderNumber in ProcessOrder) |
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>
<GetOrderByOrderNumberResponse xmlns="http://ongoingsystems.se/WSI">
<GetOrderByOrderNumberResult>
<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>
</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>
</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>
</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>
</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>
</GetOrderByOrderNumberResult>
</GetOrderByOrderNumberResponse>
</soap:Body>
</soap:Envelope>Response specification
GetOrderByOrderNumberResult is the same object as GetOrderResult in GetOrder.