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>",
"userOnboardingStatus": 0,
"userSystemRole": 0,
"dateCreated": "2023-11-07T05:31:56Z",
"dateModified": "2023-11-07T05:31:56Z",
"pharmacyNetworkRole": 0,
"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>",
"cancellationReason": 1,
"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",
"sellerBulkSaleType": 0,
"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,
"drugStorageConditionType": 10,
"updatedAt": "2023-11-07T05:31:56Z",
"requireFullTrackingInfo": true,
"noPartialsAllowed": true,
"requiresCertification": true,
"requireScan": true
},
"requiresBuyersConfirmation": true,
"buyingPharmacyAcceptedPriceDate": "2023-11-07T05:31:56Z",
"status": 0,
"paymentStatus": 0,
"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>"
},
"shipmentConfirmationType": 0,
"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>",
"deliveryStatus": 0,
"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,
"returnStatus": 0,
"activeReturn": {
"returnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 0,
"shippedDate": "2023-11-07T05:31:56Z",
"trackingCode": "<string>",
"shippingCarrier": "<string>"
},
"isSellerLicensedInState": true,
"serializationVerified": true,
"populatedByTwoDScan": 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
/
v1
/
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>",
"userOnboardingStatus": 0,
"userSystemRole": 0,
"dateCreated": "2023-11-07T05:31:56Z",
"dateModified": "2023-11-07T05:31:56Z",
"pharmacyNetworkRole": 0,
"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>",
"cancellationReason": 1,
"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",
"sellerBulkSaleType": 0,
"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,
"drugStorageConditionType": 10,
"updatedAt": "2023-11-07T05:31:56Z",
"requireFullTrackingInfo": true,
"noPartialsAllowed": true,
"requiresCertification": true,
"requireScan": true
},
"requiresBuyersConfirmation": true,
"buyingPharmacyAcceptedPriceDate": "2023-11-07T05:31:56Z",
"status": 0,
"paymentStatus": 0,
"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>"
},
"shipmentConfirmationType": 0,
"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>",
"deliveryStatus": 0,
"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,
"returnStatus": 0,
"activeReturn": {
"returnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 0,
"shippedDate": "2023-11-07T05:31:56Z",
"trackingCode": "<string>",
"shippingCarrier": "<string>"
},
"isSellerLicensedInState": true,
"serializationVerified": true,
"populatedByTwoDScan": true
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Authorizations
Custom API Key authentication. Default header: X-INVIEW-AUTH.
Path Parameters
The email address of the user whose notifications should be retrieved.
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
1, 2, 3, 4, 5, 6 Available options:
0, 1, 2 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
0, 1, 2, 5, 6, 7, 10 Available options:
0, 1, 2, 3, 4, 5, 6, 7 Show child attributes
Show child attributes
Available options:
0, 1, 2, 3, 4 Show child attributes
Show child attributes
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9 Available options:
0, 1, 2, 3, 5, 6, 7 Show child attributes
Show child attributes