GET v1/Companies({CompanyId})/ProductPrices?EntityId={EntityId}&CatalogItemId={CatalogItemId}
This call returns Pricing Details for the specified item at the specified Location within the Company.
Information:
This API is intended to confirm or resynchronize an item’s price(s) if there is reason to believe it is inconsistent across systems, not for continuous iterative use.
To ensure consistency as prices change, see Changed Location Prices or Changed Prices
Base URL:
https://api.covasoft.net/pricing
Example of a call would be:
https://api.covasoft.net/pricing/v1/Companies({{CompanyId}})/ProductPrices?$filter=EntityId eq {{LocationId}} and CatalogItemId eq guid'{{CatalogItemId}}'
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
Company Id from your onboarding package |
integer |
Required |
EntityId |
Location Id from the Comapany Tree for the Location you want pricing for items |
integer |
Required |
CatalogItemId |
The CatalogItemId that you want the price for from the Catalog |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns Pricing for the item at the specified Location within the Company
Collection of ProductPricesResourceName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
EntityId |
Identifier within the Company Tree where this price is set |
integer |
None. |
CatalogItemId | string |
None. |
|
PricingTermId |
Obsolete |
Object |
None. |
PricingTierId | integer |
None. |
|
PricingGroupId | integer |
None. |
|
PricingShelfId | integer |
None. |
|
RegularPrice |
Regular price for this item. For tiered prices, calculated as `price entered by retailer / quantityLowerBound`. NOTE: Only use this value if there is no `AtTierPrice` |
decimal number |
None. |
AtTierPrice |
Price of the item at the specified tier. `LineAmount = (tierPrice/lowerBound) * qty` Example: 3 for $10 RegularPrice will be: $10.00/3 = 3.33. Selling price for 3 would then be 9.99 due to rounding, not 10.00 Using `AtTierPrice`: (10.00/3)*3 = $10. |
decimal number |
None. |
IsDiscountable |
obsolete |
boolean |
None. |
FloorPrice |
obsolete |
Object |
None. |
OriginalPrice |
obsolete |
Object |
None. |
PricingTerm |
obsolete |
Object |
None. |
PricingTier | PricingTier |
None. |
|
PricingGroup | PricingGroup |
None. |
|
PricingShelf | PricingShelf |
None. |
|
SalePrices |
Collection of SalePrices. If no start/stop dates are provided, it is the current default valid sale. There can only be one such default sale. Other sales must have start/stop dates and they cannot overlap |
Collection of OnSalePrice |
None. |
Response Formats
application/json, text/json
[ { "Id": 1, "EntityId": 2, "CatalogItemId": "sample string 3", "PricingTermId": {}, "PricingTierId": 1, "PricingGroupId": 1, "PricingShelfId": 1, "RegularPrice": 5.1, "AtTierPrice": 1.1, "IsDiscountable": true, "FloorPrice": {}, "OriginalPrice": {}, "PricingTerm": {}, "PricingTier": { "Id": 1, "CompanyId": 2, "TierName": "sample string 3", "QuantityLowerBound": 4.1 }, "PricingGroup": { "Id": 1, "CompanyId": 2, "GroupName": "sample string 3", "Description": "sample string 4", "IsDeleted": true }, "PricingShelf": { "Id": 1, "CompanyId": 2, "ShelfName": "sample string 3", "Description": "sample string 4" }, "SalePrices": [ { "Id": 1, "StartDateUtc": "2024-11-07T08:44:13.6613361+00:00", "StopDateUtc": "2024-11-07T08:44:13.6613361+00:00", "SalePrice": 2.1, "AtTierSalePrice": 3.1 }, { "Id": 1, "StartDateUtc": "2024-11-07T08:44:13.6613361+00:00", "StopDateUtc": "2024-11-07T08:44:13.6613361+00:00", "SalePrice": 2.1, "AtTierSalePrice": 3.1 } ] }, { "Id": 1, "EntityId": 2, "CatalogItemId": "sample string 3", "PricingTermId": {}, "PricingTierId": 1, "PricingGroupId": 1, "PricingShelfId": 1, "RegularPrice": 5.1, "AtTierPrice": 1.1, "IsDiscountable": true, "FloorPrice": {}, "OriginalPrice": {}, "PricingTerm": {}, "PricingTier": { "Id": 1, "CompanyId": 2, "TierName": "sample string 3", "QuantityLowerBound": 4.1 }, "PricingGroup": { "Id": 1, "CompanyId": 2, "GroupName": "sample string 3", "Description": "sample string 4", "IsDeleted": true }, "PricingShelf": { "Id": 1, "CompanyId": 2, "ShelfName": "sample string 3", "Description": "sample string 4" }, "SalePrices": [ { "Id": 1, "StartDateUtc": "2024-11-07T08:44:13.6613361+00:00", "StopDateUtc": "2024-11-07T08:44:13.6613361+00:00", "SalePrice": 2.1, "AtTierSalePrice": 3.1 }, { "Id": 1, "StartDateUtc": "2024-11-07T08:44:13.6613361+00:00", "StopDateUtc": "2024-11-07T08:44:13.6613361+00:00", "SalePrice": 2.1, "AtTierSalePrice": 3.1 } ] } ]