GetPriceListByQuery
This function allows you to retrieve the price list of a goods owner.
Ongoing WMS has an invoicing module which the warehouse can use to create invoices for its customers. Before an invoice can be created, the warehouse must set up a price list for the goods owner. A price list consists of invoice articles which define exactly what is being charged to the customer.
There are two kinds of invoice articles: those which are computed automatically from statistics, and those which aren't. You can use the field IsFromStatistics in the response to tell the difference. As an example, consider a warehouse that wants to bill its 3PL customer in two ways:
- They want to charge $5 for every order that they picked.
- When picking very bulky orders, they need to get a special forklift out, and they want to bill the customer an additional $50 extra for this every time.
The first charge is a typical example of something that would be set up as a
statistics invoice article in Ongoing WMS. The second one is a typical example of a manual invoice article.
Tags: GetPriceListByQuery, GetPriceListQuery, GetPriceListByQueryResponse, GetPriceListResult, PriceList, InvoiceArticle, InvoiceArticlePriceMatrix, InvoiceArticleFilters, InvoiceArticlePriceTier, InvoiceArticleLocationTypesFilter, InvoiceArticleLocationType
Request XML
POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetPriceListByQuery"
<?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>
<GetPriceListByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<GoodsOwnerId>int</GoodsOwnerId>
</Query>
</GetPriceListByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetPriceListByQuery |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetPriceListQuery |
Req. |
The query object |
| GetPriceListQuery |
| GoodsOwnerId |
int |
Req. |
The id of the goods owner for which you want to get the price list |
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>
<GetPriceListByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetPriceListByQueryResult>
<Message>string</Message>
<Success>boolean</Success>
<PriceLists>
<PriceList>
<GoodsOwnerId>int</GoodsOwnerId>
<GoodsOwnerName>string</GoodsOwnerName>
<InvoiceArticles>
<InvoiceArticle>
<Title>string</Title>
<Code>string</Code>
<UnitPrice>decimal</UnitPrice>
<IsFromStatistics>boolean</IsFromStatistics>
<Statistic>string</Statistic>
<InvoiceArticleId>int</InvoiceArticleId>
<PriceMatrix>
<PriceType>TotalPrice or UnitPrice or UnitPricePerInterval</PriceType>
<PriceTiers>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
</PriceTiers>
</PriceMatrix>
<PriceTierHeadId>int</PriceTierHeadId>
<Filters>
<LocationTypesFilter>
<FilterType>string</FilterType>
<LocationTypes>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
</LocationTypes>
</LocationTypesFilter>
</Filters>
</InvoiceArticle>
<InvoiceArticle>
<Title>string</Title>
<Code>string</Code>
<UnitPrice>decimal</UnitPrice>
<IsFromStatistics>boolean</IsFromStatistics>
<Statistic>string</Statistic>
<InvoiceArticleId>int</InvoiceArticleId>
<PriceMatrix>
<PriceType>TotalPrice or UnitPrice or UnitPricePerInterval</PriceType>
<PriceTiers>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
</PriceTiers>
</PriceMatrix>
<PriceTierHeadId>int</PriceTierHeadId>
<Filters>
<LocationTypesFilter>
<FilterType>string</FilterType>
<LocationTypes>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
</LocationTypes>
</LocationTypesFilter>
</Filters>
</InvoiceArticle>
</InvoiceArticles>
</PriceList>
<PriceList>
<GoodsOwnerId>int</GoodsOwnerId>
<GoodsOwnerName>string</GoodsOwnerName>
<InvoiceArticles>
<InvoiceArticle>
<Title>string</Title>
<Code>string</Code>
<UnitPrice>decimal</UnitPrice>
<IsFromStatistics>boolean</IsFromStatistics>
<Statistic>string</Statistic>
<InvoiceArticleId>int</InvoiceArticleId>
<PriceMatrix>
<PriceType>TotalPrice or UnitPrice or UnitPricePerInterval</PriceType>
<PriceTiers>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
</PriceTiers>
</PriceMatrix>
<PriceTierHeadId>int</PriceTierHeadId>
<Filters>
<LocationTypesFilter>
<FilterType>string</FilterType>
<LocationTypes>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
</LocationTypes>
</LocationTypesFilter>
</Filters>
</InvoiceArticle>
<InvoiceArticle>
<Title>string</Title>
<Code>string</Code>
<UnitPrice>decimal</UnitPrice>
<IsFromStatistics>boolean</IsFromStatistics>
<Statistic>string</Statistic>
<InvoiceArticleId>int</InvoiceArticleId>
<PriceMatrix>
<PriceType>TotalPrice or UnitPrice or UnitPricePerInterval</PriceType>
<PriceTiers>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
<InvoiceArticlePriceTier>
<To>decimal</To>
<Price>decimal</Price>
</InvoiceArticlePriceTier>
</PriceTiers>
</PriceMatrix>
<PriceTierHeadId>int</PriceTierHeadId>
<Filters>
<LocationTypesFilter>
<FilterType>string</FilterType>
<LocationTypes>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
<LocationType>
<Id>int</Id>
<LocationTypeCode>string</LocationTypeCode>
<LocationTypeName>string</LocationTypeName>
</LocationType>
</LocationTypes>
</LocationTypesFilter>
</Filters>
</InvoiceArticle>
</InvoiceArticles>
</PriceList>
</PriceLists>
</GetPriceListByQueryResult>
</GetPriceListByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetPriceListByQueryResponse |
| GetPriceListByQueryResult |
GetPriceListResult |
|
| GetPriceListResult |
| Message |
string |
Error message, if the call was unsuccessful |
| Success |
boolean |
True if successful, false otherwise |
| PriceLists |
PriceList[] |
Elements of PriceList |
| PriceList |
| GoodsOwnerId |
int |
The internal system id of the goods owner to which the price list belongs |
| GoodsOwnerName |
string(400) |
The name of the goods owner to which the price list belongs |
| InvoiceArticles |
InvoiceArticle[] |
Elements of InvoiceArticle |
| InvoiceArticle |
| Title |
string(400) |
The name of the invoice article |
| Code |
string(100) |
The code/article number of the invoice article |
| UnitPrice |
decimal |
Unit price |
| IsFromStatistics |
boolean |
True if this invoice article is computed from statistics, false if it is an article which is debited manually |
| Statistic |
string(200) |
If IsFromStatistics = true, then this is the name of the statistic |
| InvoiceArticleId |
int |
Use InvoiceArticleId to identify the InvoiceArticle when using Charge . |
| PriceMatrix |
InvoiceArticlePriceMatrix |
An element of type InvoiceArticlePriceMatrix. |
| PriceTierHeadId |
int |
|
| Filters |
InvoiceArticleFilters |
A selection of filters on this Invoice Article. Currently only supports location type filters |
| InvoiceArticlePriceMatrix |
| PriceType |
enum |
An element of type InvoiceArticlePriceTierPriceType. |
| PriceTiers |
InvoiceArticlePriceTier[] |
|
| InvoiceArticleFilters |
| LocationTypesFilter |
InvoiceArticleLocationTypesFilter |
An element of type InvoiceArticleLocationTypesFilter. |
| InvoiceArticlePriceTier |
| To |
decimal |
|
| Price |
decimal |
|
| InvoiceArticleLocationTypesFilter |
| FilterType |
string |
The type of filter. Possible values: In, NotIn, InOrNull, NotInOrNull |
| LocationTypes |
InvoiceArticleLocationType[] |
|
| InvoiceArticleLocationType |
| Id |
int |
The internal system id of the location type that is filtered for |
| LocationTypeCode |
string |
The code of the location type that is filtered for |
| LocationTypeName |
string |
The name of the location type that is filtered for |