GET v1/Companies({CompanyId})/ProductPrices?EntityId={EntityId}

Returns Pricing Details for all Products at the specified Location within the Company.

Information:

This API is intended for first-time or occasional synchronization, 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}}&$skip=0&$top=1000
Caution: Failure to provide paging values will result in a default setting of $skip=0 and $top=5000, potentially leading to data inconsistency when exceeding 5000 pricing items.

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

Body Parameters

None.

Response Information

Resource Description

Returns Pricing for all the items in the specified Location within the Company

Collection of ProductPricesResource

Name	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

Sample:

[
  {
    "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-25T03:05:54.385556+00:00",
        "StopDateUtc": "2024-11-25T03:05:54.385556+00:00",
        "SalePrice": 2.1,
        "AtTierSalePrice": 3.1
      },
      {
        "Id": 1,
        "StartDateUtc": "2024-11-25T03:05:54.385556+00:00",
        "StopDateUtc": "2024-11-25T03:05:54.385556+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-25T03:05:54.385556+00:00",
        "StopDateUtc": "2024-11-25T03:05:54.385556+00:00",
        "SalePrice": 2.1,
        "AtTierSalePrice": 3.1
      },
      {
        "Id": 1,
        "StartDateUtc": "2024-11-25T03:05:54.385556+00:00",
        "StopDateUtc": "2024-11-25T03:05:54.385556+00:00",
        "SalePrice": 2.1,
        "AtTierSalePrice": 3.1
      }
    ]
  }
]