Ongoing Warehouse logo

Ongoing Warehouse Developer

GetPriceListByQuery

This function allows you to retrieve the price list of a goods owner.

Ongoing 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:

  1. They want to charge $5 for every order that they picked.
  2. 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. The second one is a typical example of a manual invoice article.

Tags: GetPriceListByQuery, Query, GetPriceListByQueryResult, PriceList, InvoiceArticle

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 str(50) Req. Your username
Password str(50) Req. Your password
Query object Req. A Query object
Query
GoodsOwnerId int Req. The id of the goods owner for which you want to get the price list

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>
    <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>dec</UnitPrice>
                <IsFromStatistics>boolean</IsFromStatistics>
                <Statistic>string</Statistic>
              </InvoiceArticle>
              <InvoiceArticle>
                <Title>string</Title>
                <Code>string</Code>
                <UnitPrice>dec</UnitPrice>
                <IsFromStatistics>boolean</IsFromStatistics>
                <Statistic>string</Statistic>
              </InvoiceArticle>
            </InvoiceArticles>
          </PriceList>
          <PriceList>
            <GoodsOwnerId>int</GoodsOwnerId>
            <GoodsOwnerName>string</GoodsOwnerName>
            <InvoiceArticles>
              <InvoiceArticle>
                <Title>string</Title>
                <Code>string</Code>
                <UnitPrice>dec</UnitPrice>
                <IsFromStatistics>boolean</IsFromStatistics>
                <Statistic>string</Statistic>
              </InvoiceArticle>
              <InvoiceArticle>
                <Title>string</Title>
                <Code>string</Code>
                <UnitPrice>dec</UnitPrice>
                <IsFromStatistics>boolean</IsFromStatistics>
                <Statistic>string</Statistic>
              </InvoiceArticle>
            </InvoiceArticles>
          </PriceList>
        </PriceLists>
      </GetPriceListByQueryResult>
    </GetPriceListByQueryResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

GetPriceListByQueryResult
Success bool True if successful, false otherwise
Message str(*) Error message, if the call was unsuccessful
PriceLists object[] Elements of PriceList
PriceList
GoodsOwnerId int The internal system id of the goods owner to which the price list belongs
GoodsOwnerName str(400) The name of the goods owner to which the price list belongs
InvoiceArticles object[] Elements of InvoiceArticle
InvoiceArticle
Title str(400) The name of the invoice article
Code str(100) The code/article number of the invoice article
UnitPrice dec Unit price
IsFromStatistics bool True if this invoice article is computed from statistics, false if it is an article which is debited manually
Statistic str(200) If IsFromStatistics = true, then this is the name of the statistic
InvoiceArticleId int Use InvoiceArticleId to identify the InvoiceArticle when using Charge .