Megaventory API v2017a

<back to all web services

PricingRuleGet

The following routes are available for this service:
GET POST/PricingRule/PricingRuleGetGets information on existing pricing rulesUses your API Key and some Filters in an array format and returns the search results using the given filters. Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a PricingRuleID descending order.

Examples:



A.

Get the first pricing rule with PricingRuleBasePrice equals to DefaultSalesPrice (as mvPricingRule object).

Value: 

{
"Filters": [
      {
         "FieldName": "PricingRuleBasePrice",
         "SearchOperator": "Equals",
         "SearchValue": "DefaultSalesPrice"
      }
   ],
   "ReturnTopNRecords": 1
}


Response: 

{
   "mvPricingRules": [
    {
      "PricingRuleID": 162,
      "PricingRuleName": "Sales Pricing Rule",
      "PricingRuleCurrency": "EUR",
      "PricingRuleBasePrice": "DefaultSalesPrice",
      "PricingRuleSpExchangeRate": 2,
      "PricingRuleAddPercent": 0.2,
      "PricingRuleAddFixedAmount": 0.2,
      "PricingRuleUnitPriceRoundingDigits": 0.2,
      "PricingRuleDefaultDiscountId": 0,
      "PricingRuleDefaultTaxId": 0,
      "PricingRuleSpecificEntities": false,
      "PricingRuleSpecificProducts": false,
      "PricingRuleSpecificProductCategories": false,
      "PricingRuleStartDate": "/Date(1576360800000-0000)/",
      "PricingRuleEndDate": "/Date(1577224800000-0000)/",
      "PricingRuleMinQty": 5,
      "PricingRuleMaxQty": 25,
      "PricingRuleDateModified": "/Date(1576840387477-0000)/",
      "PricingRuleDateCreated": "/Date(1576840387477-0000)/",
      "PricingRuleUsedByModule": 1
    }
  ],
  "ResponseStatus": {
    "ErrorCode": "0"
  }
}


B.

Returns the Pricing Rules whose exchange rate is less than 2 and whose currency is not EUR.
We can add two Filters by using the AndOr operator as shown below:

Value: 

{
   "Filters": [
      {
         "FieldName": "PricingRuleCurrency",
         "SearchOperator": "NotEquals",
         "SearchValue": "EUR"
      },
      {
         "AndOr": "And",
         "FieldName": "PricingRuleSpExchangeRate",
         "SearchOperator": "LessThan",
         "SearchValue": 2
      }
   ]
}


Response: 

{
   "mvPricingRules": [
      {
         "PricingRuleID": 172,
         "PricingRuleName": "AverageCostPrice",
         "PricingRuleCurrency": "USD",
         "PricingRuleBasePrice": "AverageCostPrice",
         "PricingRuleSpExchangeRate": 1.5,
         "PricingRuleAddPercent": 12,
         "PricingRuleAddFixedAmount": 0,
         "PricingRuleUnitPriceRoundingDigits": 0.2,
         "PricingRuleDefaultDiscountId": 0,
         "PricingRuleDefaultTaxId": 0,
         "PricingRuleSpecificEntities": false,
         "PricingRuleSpecificProducts": false,
         "PricingRuleSpecificProductCategories": false,
         "PricingRuleStartDate": "/Date(1578088800000-0000)/",
         "PricingRuleEndDate": "/Date(1578607200000-0000)/",
         "PricingRuleMinQty": 5,
         "PricingRuleMaxQty": 100,
         "PricingRuleDateModified": "/Date(1576841132287-0000)/",
         "PricingRuleDateCreated": "/Date(1576841132287-0000)/",
         "PricingRuleUsedByModule": 1
      },
      {
         "PricingRuleID": 164,
         "PricingRuleName": "SalesPricingRule",
         "PricingRuleCurrency": "USD",
         "PricingRuleBasePrice": "DefaultSalesPrice",
         "PricingRuleSpExchangeRate": 0.5,
         "PricingRuleAddPercent": 0,
         "PricingRuleAddFixedAmount": 0,
         "PricingRuleUnitPriceRoundingDigits": 0.2,
         "PricingRuleDefaultDiscountId": 0,
         "PricingRuleDefaultTaxId": 0,
         "PricingRuleSpecificEntities": false,
         "PricingRuleSpecificProducts": false,
         "PricingRuleSpecificProductCategories": false,
         "PricingRuleStartDate": "/Date(1576360800000-0000)/",
         "PricingRuleEndDate": "/Date(1577224800000-0000)/",
         "PricingRuleMinQty": 5,
         "PricingRuleMaxQty": 25,
         "PricingRuleDateModified": "/Date(1576840935637-0000)/",
         "PricingRuleDateCreated": "/Date(1576840935637-0000)/",
         "PricingRuleUsedByModule": 1
      }
    ],
    "ResponseStatus": {
        "ErrorCode": "0"
    }
}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/PricingRuleGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<PricingRuleGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">
    <Filter>
      <AndOr>And</AndOr>
      <FieldName>String</FieldName>
      <Group>Undefined</Group>
      <SearchOperator>Undefined</SearchOperator>
      <SearchValue>String</SearchValue>
    </Filter>
  </Filters>
  <ReturnTopNRecords xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">0</ReturnTopNRecords>
  <APIKEY>String</APIKEY>
  <showDeleted>showOnlyUndeleted</showDeleted>
</PricingRuleGet>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PricingRuleGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvPricingRules xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvPricingRule>
      <d2p1:PricingRuleID>0</d2p1:PricingRuleID>
      <d2p1:PricingRuleName>String</d2p1:PricingRuleName>
      <d2p1:PricingRuleCurrency>String</d2p1:PricingRuleCurrency>
      <d2p1:PricingRuleBasePrice>DefaultSalesPrice</d2p1:PricingRuleBasePrice>
      <d2p1:PricingRuleSpExchangeRate>0</d2p1:PricingRuleSpExchangeRate>
      <d2p1:PricingRuleAddFixedAmount>0</d2p1:PricingRuleAddFixedAmount>
      <d2p1:PricingRuleAddPercent>0</d2p1:PricingRuleAddPercent>
      <d2p1:PricingRuleUnitPriceRoundingDigits>0</d2p1:PricingRuleUnitPriceRoundingDigits>
      <d2p1:PricingRuleDefaultDiscountId>0</d2p1:PricingRuleDefaultDiscountId>
      <d2p1:PricingRuleDefaultTaxId>0</d2p1:PricingRuleDefaultTaxId>
      <d2p1:PricingRuleSpecificEntities>false</d2p1:PricingRuleSpecificEntities>
      <d2p1:PricingRuleSpecificProducts>false</d2p1:PricingRuleSpecificProducts>
      <d2p1:PricingRuleSpecificProductCategories>false</d2p1:PricingRuleSpecificProductCategories>
      <d2p1:PricingRuleStartDate>0001-01-01T00:00:00</d2p1:PricingRuleStartDate>
      <d2p1:PricingRuleEndDate>0001-01-01T00:00:00</d2p1:PricingRuleEndDate>
      <d2p1:PricingRuleMinQty>0</d2p1:PricingRuleMinQty>
      <d2p1:PricingRuleMaxQty>0</d2p1:PricingRuleMaxQty>
      <d2p1:PricingRuleDateModified>0001-01-01T00:00:00</d2p1:PricingRuleDateModified>
      <d2p1:PricingRuleDateCreated>0001-01-01T00:00:00</d2p1:PricingRuleDateCreated>
      <d2p1:PricingRuleUsedByModule>0</d2p1:PricingRuleUsedByModule>
    </d2p1:mvPricingRule>
  </mvPricingRules>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</PricingRuleGetResponse>