Get's user notifications

curl --request GET \
  --url https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email} \
  --header 'X-INVIEW-AUTH: <api-key>'

const options = {method: 'GET', headers: {'X-INVIEW-AUTH': '<api-key>'}};

fetch('https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email}"

headers = {"X-INVIEW-AUTH": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "boughtByUser": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "savedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cityAndState": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "storeCount": 123,
    "acceptedTermsAndConditionsDate": "2023-11-07T05:31:56Z",
    "ipAddress": "<string>",
    "userName": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "pharmacyNetworkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "buyerPharmacyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyerPharmacyName": "<string>",
  "buyerPharmacyGln": "<string>",
  "buyerPharmacyNationalProviderIdentifier": 123,
  "buyersMessage": "<string>",
  "buyingPharmacyAddress": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "stateAcronym": "<string>"
  },
  "buyingPharmacyCityState": "<string>",
  "buyingPharmacyName": "<string>",
  "buyingPharmacyDBA": "<string>",
  "buyingPharmacyPhone": 123,
  "buyingPharmacyUser": "<string>",
  "buyingPharmacyIsFavorite": true,
  "cancellationDescription": "<string>",
  "cancelledDate": "2023-11-07T05:31:56Z",
  "drugPackageForm": "<string>",
  "drugPackageStrength": "<string>",
  "expirationDate": "2023-11-07T05:31:56Z",
  "fullPackage": true,
  "originalPackage": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inventoryQuantity": 123,
  "isExpired": true,
  "labelerName": "<string>",
  "listingDate": "2023-11-07T05:31:56Z",
  "lotNumber": "<string>",
  "nationalDrugCode": "<string>",
  "nationalDrugCodeNormalized": "<string>",
  "drugPackageDescription": "<string>",
  "packageDescription": "<string>",
  "packageName": "<string>",
  "paymentConfirmedDate": "2023-11-07T05:31:56Z",
  "pharmacyPaymentAccountPaymentEventAttemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "price": 123,
  "pricePerQuantity": 123,
  "quantity": 123,
  "quantityUnitQualifier": "<string>",
  "saleConfirmedBySellerDate": "2023-11-07T05:31:56Z",
  "sealedPackage": true,
  "sellerPaysShipping": true,
  "sellerPharmacyCityState": "<string>",
  "sellerPharmacyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sellerPharmacySeqId": 123,
  "sellerPharmacyName": "<string>",
  "sellerPharmacyGln": "<string>",
  "sellerPharmacyDBA": "<string>",
  "sellerPharmacyNationalProviderIdentifier": 123,
  "sellerPharmacyPhone": 123,
  "sellerPharmacyIsFavorite": true,
  "sellerPharmacyNetworkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipmentInfo": {
    "dateShippingLabelCreated": "2023-11-07T05:31:56Z",
    "shipmentHasBeenPurchased": true,
    "shippingCarrier": "<string>",
    "trackingCode": "<string>",
    "trackingLink": "<string>",
    "usingUserDefinedShippingInfo": true,
    "deliveryDays": 123,
    "service": "<string>",
    "shipmentPrice": 123,
    "shippingLabelUrl": "<string>"
  },
  "shippingConfirmDate": "2023-11-07T05:31:56Z",
  "shippingReceivedConfirmDate": "2023-11-07T05:31:56Z",
  "soldDate": "2023-11-07T05:31:56Z",
  "tornPackageLabel": true,
  "sellerPharmacyAddress": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "stateAcronym": "<string>"
  },
  "sellerPharmacyStateLicenseFileName": "<string>",
  "drugPackage": {
    "canBeSoldOnTheMarketplace": true,
    "drugBankConceptId": "<string>",
    "drugBankConceptTitle": "<string>",
    "drugNameDesc": "<string>",
    "drugPackageForm": "<string>",
    "drugPackageStrength": "<string>",
    "genericMedID": "<string>",
    "genericMedIDDesc": "<string>",
    "imgUrlLarge": "<string>",
    "imgUrlMedium": "<string>",
    "imgUrlThumb": "<string>",
    "imgUrlTiny": "<string>",
    "labelerName": "<string>",
    "minimumDispenseQuantity": 123,
    "nationalDrugCode": "<string>",
    "nationalDrugCodeNormalized": "<string>",
    "packageDescription": "<string>",
    "packageName": "<string>",
    "packageQuantity": 123,
    "packageSize": 123,
    "packageSizeUnitsCodeDesc": "<string>",
    "quantityUnitQualifier": "<string>",
    "schedule": "<string>",
    "nadacPrice": 123,
    "branded": true,
    "generic": true,
    "isRems": true,
    "prescribableName": "<string>",
    "isPrescription": true,
    "updatedAt": "2023-11-07T05:31:56Z",
    "requireFullTrackingInfo": true,
    "noPartialsAllowed": true,
    "requiresCertification": true,
    "requireScan": true
  },
  "requiresBuyersConfirmation": true,
  "buyingPharmacyAcceptedPriceDate": "2023-11-07T05:31:56Z",
  "isRequestableItem": true,
  "nadacPrice": 123,
  "nadacPercentage": 123,
  "nadacLastUpdated": "2023-11-07T05:31:56Z",
  "savingPrice": 123,
  "calculatedSavings": 123,
  "wholesalePercentage": 123,
  "wholesaleSavingPrice": 123,
  "gtin": "<string>",
  "serialNumber": "<string>",
  "shipmentDetailsFromBuyerMatch": true,
  "shipmentDetailsFromBuyer": {
    "expirationDate": "2023-11-07T05:31:56Z",
    "lotNumber": "<string>",
    "gtin": "<string>",
    "serialNumber": "<string>",
    "nationalDrugCode": "<string>"
  },
  "shipByDate": "2023-11-07T05:31:56Z",
  "branded": true,
  "generic": true,
  "isGreatDeal": true,
  "images": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "savedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    }
  ],
  "bundleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isPrimary": true,
  "shippedPicturePath": "<string>",
  "receivedPicturePath": "<string>",
  "stateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chainExclusiveUntil": "2023-11-07T05:31:56Z",
  "resultingMarketplaceListingRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evergreenCashOfferPreferencesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isSellerPharmacyColdChainCertified": true,
  "listingCode": "<string>",
  "ndcQuantity": 123,
  "shippingType": "<string>",
  "receivedBy": "<string>",
  "pickupPrice": 123,
  "pickupWasPurchased": true,
  "rating": 123,
  "createdByGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isCertified": true,
  "hasCertifiedListings": true,
  "certificationFileName": "<string>",
  "certificationFilePath": "<string>",
  "hasListingFromFavoritePharmacy": true,
  "isColdChain": true,
  "isAssociatedByCurrentAdmin": true,
  "hasPendingCashOffer": true,
  "hasReturn": true,
  "isSellerLicensedInState": true,
  "serializationVerified": true
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

Utility

Get's user notifications

Retrieves all notifications associated with the specified user account. The user must belong to the group identified by the API key.

Validation Rules

Field	Required	Type	Rules
email (route)	Yes	`string`	Must be a valid email of an existing user. User must belong to the group

GET

api

notifications

{email}

Get's user notifications

curl --request GET \
  --url https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email} \
  --header 'X-INVIEW-AUTH: <api-key>'

const options = {method: 'GET', headers: {'X-INVIEW-AUTH': '<api-key>'}};

fetch('https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://test-instockrx-api.azurewebsites.net/api/v1/notifications/{email}"

headers = {"X-INVIEW-AUTH": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "boughtByUser": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "savedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cityAndState": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "storeCount": 123,
    "acceptedTermsAndConditionsDate": "2023-11-07T05:31:56Z",
    "ipAddress": "<string>",
    "userName": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "pharmacyNetworkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "buyerPharmacyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyerPharmacyName": "<string>",
  "buyerPharmacyGln": "<string>",
  "buyerPharmacyNationalProviderIdentifier": 123,
  "buyersMessage": "<string>",
  "buyingPharmacyAddress": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "stateAcronym": "<string>"
  },
  "buyingPharmacyCityState": "<string>",
  "buyingPharmacyName": "<string>",
  "buyingPharmacyDBA": "<string>",
  "buyingPharmacyPhone": 123,
  "buyingPharmacyUser": "<string>",
  "buyingPharmacyIsFavorite": true,
  "cancellationDescription": "<string>",
  "cancelledDate": "2023-11-07T05:31:56Z",
  "drugPackageForm": "<string>",
  "drugPackageStrength": "<string>",
  "expirationDate": "2023-11-07T05:31:56Z",
  "fullPackage": true,
  "originalPackage": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inventoryQuantity": 123,
  "isExpired": true,
  "labelerName": "<string>",
  "listingDate": "2023-11-07T05:31:56Z",
  "lotNumber": "<string>",
  "nationalDrugCode": "<string>",
  "nationalDrugCodeNormalized": "<string>",
  "drugPackageDescription": "<string>",
  "packageDescription": "<string>",
  "packageName": "<string>",
  "paymentConfirmedDate": "2023-11-07T05:31:56Z",
  "pharmacyPaymentAccountPaymentEventAttemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "price": 123,
  "pricePerQuantity": 123,
  "quantity": 123,
  "quantityUnitQualifier": "<string>",
  "saleConfirmedBySellerDate": "2023-11-07T05:31:56Z",
  "sealedPackage": true,
  "sellerPaysShipping": true,
  "sellerPharmacyCityState": "<string>",
  "sellerPharmacyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sellerPharmacySeqId": 123,
  "sellerPharmacyName": "<string>",
  "sellerPharmacyGln": "<string>",
  "sellerPharmacyDBA": "<string>",
  "sellerPharmacyNationalProviderIdentifier": 123,
  "sellerPharmacyPhone": 123,
  "sellerPharmacyIsFavorite": true,
  "sellerPharmacyNetworkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipmentInfo": {
    "dateShippingLabelCreated": "2023-11-07T05:31:56Z",
    "shipmentHasBeenPurchased": true,
    "shippingCarrier": "<string>",
    "trackingCode": "<string>",
    "trackingLink": "<string>",
    "usingUserDefinedShippingInfo": true,
    "deliveryDays": 123,
    "service": "<string>",
    "shipmentPrice": 123,
    "shippingLabelUrl": "<string>"
  },
  "shippingConfirmDate": "2023-11-07T05:31:56Z",
  "shippingReceivedConfirmDate": "2023-11-07T05:31:56Z",
  "soldDate": "2023-11-07T05:31:56Z",
  "tornPackageLabel": true,
  "sellerPharmacyAddress": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "stateAcronym": "<string>"
  },
  "sellerPharmacyStateLicenseFileName": "<string>",
  "drugPackage": {
    "canBeSoldOnTheMarketplace": true,
    "drugBankConceptId": "<string>",
    "drugBankConceptTitle": "<string>",
    "drugNameDesc": "<string>",
    "drugPackageForm": "<string>",
    "drugPackageStrength": "<string>",
    "genericMedID": "<string>",
    "genericMedIDDesc": "<string>",
    "imgUrlLarge": "<string>",
    "imgUrlMedium": "<string>",
    "imgUrlThumb": "<string>",
    "imgUrlTiny": "<string>",
    "labelerName": "<string>",
    "minimumDispenseQuantity": 123,
    "nationalDrugCode": "<string>",
    "nationalDrugCodeNormalized": "<string>",
    "packageDescription": "<string>",
    "packageName": "<string>",
    "packageQuantity": 123,
    "packageSize": 123,
    "packageSizeUnitsCodeDesc": "<string>",
    "quantityUnitQualifier": "<string>",
    "schedule": "<string>",
    "nadacPrice": 123,
    "branded": true,
    "generic": true,
    "isRems": true,
    "prescribableName": "<string>",
    "isPrescription": true,
    "updatedAt": "2023-11-07T05:31:56Z",
    "requireFullTrackingInfo": true,
    "noPartialsAllowed": true,
    "requiresCertification": true,
    "requireScan": true
  },
  "requiresBuyersConfirmation": true,
  "buyingPharmacyAcceptedPriceDate": "2023-11-07T05:31:56Z",
  "isRequestableItem": true,
  "nadacPrice": 123,
  "nadacPercentage": 123,
  "nadacLastUpdated": "2023-11-07T05:31:56Z",
  "savingPrice": 123,
  "calculatedSavings": 123,
  "wholesalePercentage": 123,
  "wholesaleSavingPrice": 123,
  "gtin": "<string>",
  "serialNumber": "<string>",
  "shipmentDetailsFromBuyerMatch": true,
  "shipmentDetailsFromBuyer": {
    "expirationDate": "2023-11-07T05:31:56Z",
    "lotNumber": "<string>",
    "gtin": "<string>",
    "serialNumber": "<string>",
    "nationalDrugCode": "<string>"
  },
  "shipByDate": "2023-11-07T05:31:56Z",
  "branded": true,
  "generic": true,
  "isGreatDeal": true,
  "images": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "savedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    }
  ],
  "bundleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isPrimary": true,
  "shippedPicturePath": "<string>",
  "receivedPicturePath": "<string>",
  "stateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chainExclusiveUntil": "2023-11-07T05:31:56Z",
  "resultingMarketplaceListingRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evergreenCashOfferPreferencesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isSellerPharmacyColdChainCertified": true,
  "listingCode": "<string>",
  "ndcQuantity": 123,
  "shippingType": "<string>",
  "receivedBy": "<string>",
  "pickupPrice": 123,
  "pickupWasPurchased": true,
  "rating": 123,
  "createdByGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isCertified": true,
  "hasCertifiedListings": true,
  "certificationFileName": "<string>",
  "certificationFilePath": "<string>",
  "hasListingFromFavoritePharmacy": true,
  "isColdChain": true,
  "isAssociatedByCurrentAdmin": true,
  "hasPendingCashOffer": true,
  "hasReturn": true,
  "isSellerLicensedInState": true,
  "serializationVerified": true
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

Authorizations

X-INVIEW-AUTH

string

header

required

Custom API Key authentication. Default header: X-INVIEW-AUTH.

Path Parameters

string

required

The email address of the user whose notifications should be retrieved.

Response

Success

boughtByUser

object | null

Show child attributes

buyerPharmacyId

string<uuid> | null

buyerPharmacyName

string | null

buyerPharmacyGln

string | null

buyerPharmacyNationalProviderIdentifier

integer<int64> | null

buyersMessage

string | null

buyingPharmacyAddress

object | null

Show child attributes

buyingPharmacyCityState

string | null

buyingPharmacyName

string | null

buyingPharmacyDBA

string | null

buyingPharmacyPhone

integer<int64> | null

buyingPharmacyUser

string | null

buyingPharmacyIsFavorite

boolean | null

cancellationDescription

string | null

cancellationReason

enum<integer> | null

Available options:

1,

2,

3,

4,

5

cancelledDate

string<date-time> | null

drugPackageForm

string | null

drugPackageStrength

string | null

expirationDate

string<date-time> | null

fullPackage

boolean

originalPackage

boolean

string<uuid> | null

inventoryQuantity

number<double>

isExpired

boolean

labelerName

string | null

listingDate

string<date-time> | null

lotNumber

string | null

nationalDrugCode

string | null

nationalDrugCodeNormalized

string | null

drugPackageDescription

string | null

packageDescription

string | null

packageName

string | null

paymentConfirmedDate

string<date-time> | null

pharmacyPaymentAccountPaymentEventAttemptId

string<uuid> | null

price

number<double> | null

pricePerQuantity

number<double> | null

quantity

number<double>

quantityUnitQualifier

string | null

saleConfirmedBySellerDate

string<date-time> | null

sealedPackage

boolean

sellerPaysShipping

boolean

sellerPharmacyCityState

string | null

sellerPharmacyId

string<uuid> | null

sellerPharmacySeqId

integer<int32> | null

sellerPharmacyName

string | null

sellerPharmacyGln

string | null

sellerPharmacyDBA

string | null

sellerPharmacyNationalProviderIdentifier

integer<int64> | null

sellerPharmacyPhone

integer<int64> | null

sellerPharmacyIsFavorite

boolean | null

sellerPharmacyNetworkId

string<uuid> | null

sellerBulkSaleType

enum<integer> | null

Available options:

0,

1,

2

shipmentInfo

object | null

Show child attributes

shippingConfirmDate

string<date-time> | null

shippingReceivedConfirmDate

string<date-time> | null

soldDate

string<date-time> | null

tornPackageLabel

boolean

sellerPharmacyAddress

object | null

Show child attributes

sellerPharmacyStateLicenseFileName

string | null

drugPackage

object | null

Show child attributes

requiresBuyersConfirmation

boolean

buyingPharmacyAcceptedPriceDate

string<date-time> | null

status

enum<integer> | null

Available options:

0,

1,

2,

5,

6,

7,

10

paymentStatus

enum<integer> | null

Available options:

0,

1,

2,

3,

4,

5,

6,

7

isRequestableItem

boolean

nadacPrice

number<double> | null

nadacPercentage

integer<int32> | null

nadacLastUpdated

string<date-time> | null

savingPrice

number<double> | null

calculatedSavings

number<double> | null

wholesalePercentage

integer<int32> | null

wholesaleSavingPrice

number<double> | null

gtin

string | null

serialNumber

string | null

shipmentDetailsFromBuyerMatch

boolean | null

shipmentDetailsFromBuyer

object | null

Show child attributes

shipmentConfirmationType

enum<integer> | null

Available options:

0,

1,

2,

3,

4

shipByDate

string<date-time> | null

branded

boolean | null

generic

boolean | null

isGreatDeal

boolean | null

images

object[] | null

Show child attributes

bundleId

string<uuid> | null

isPrimary

boolean | null

shippedPicturePath

string | null

receivedPicturePath

string | null

deliveryStatus

enum<integer>

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

stateGroupId

string<uuid> | null

chainExclusiveUntil

string<date-time> | null

resultingMarketplaceListingRequestId

string<uuid> | null

evergreenCashOfferPreferencesId

string<uuid> | null

isSellerPharmacyColdChainCertified

boolean

listingCode

string | null

ndcQuantity

integer<int32>

shippingType

string | null

receivedBy

string | null

pickupPrice

number<double> | null

pickupWasPurchased

boolean

rating

number<double> | null

createdByGroupId

string<uuid> | null

isCertified

boolean

hasCertifiedListings

boolean

certificationFileName

string | null

certificationFilePath

string | null

hasListingFromFavoritePharmacy

boolean

isColdChain

boolean

isAssociatedByCurrentAdmin

boolean | null

hasPendingCashOffer

boolean

hasReturn

boolean

returnStatus

enum<integer> | null

Available options:

0,

1,

2,

3,

5,

6,

7

isSellerLicensedInState

boolean | null

serializationVerified

boolean | null

Overview

Endpoints

Get's user notifications

Validation Rules

Authorizations

Path Parameters

Response