POST api/ListPackagePrices

Returns all active and historical price records for a package, regardless of price type. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

ListPackagePricesRequest
NameDescriptionTypeAdditional information
PackageId The input parameters for the package identifier PackageIdentifier

Required
MaxResults Limits the number of results returned. A null value means no limit, and everthing will be returned. integer

None.
AccessToken Temporary access token from the GSDD Auth API. Used to validate your license.

Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. 		string

Required

Request Formats

application/json, text/json

Sample: 
{
  "PackageId": {
    "IdType": "NDC11",
    "Id": "12345-6789-01"
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListPackagePricesResponse
NameDescriptionTypeAdditional information
PriceData Returns the pricing data output parameters for the requested package. Collection of PriceData

None.

Response Formats

application/json, text/json

Sample: 
{
  "PriceData": [
    {
      "PriceTypeId": 1,
      "PackagePrice": 1.234,
      "UnitPrice": 1.234,
      "CaseCount": 3,
      "CasePrice": 1.234,
      "BeginDate": "2025-01-17",
      "EndDate": "2025-01-17",
      "PriceChangeReasonId": 2,
      "PackageSize": 1.234,
      "NCPDPBillingUnit": "Sample NCPDPBillingUnit text."
    },
    {
      "PriceTypeId": 3,
      "PackagePrice": 1.234,
      "UnitPrice": 1.234,
      "CaseCount": 3,
      "CasePrice": 1.234,
      "BeginDate": "2025-01-17",
      "EndDate": "2025-01-17",
      "PriceChangeReasonId": 4,
      "PackageSize": 1.234,
      "NCPDPBillingUnit": "Sample NCPDPBillingUnit text."
    }
  ]
}