PATCH api/PharmacyLocations?id={id}
Patches an existing Pharmacy Location record
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
PharmacyLocation identifier |
integer |
Required |
Body Parameters
The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target rule
JsonPatchDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/json-patch+json
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A patched PharmacyLocation record
PharmacyLocationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TaxRate |
Tax Rate (in percent, 0-100) |
decimal number |
None. |
| TaxExempt |
Tax Exempt |
boolean |
None. |
| PrimaryPharmacyType |
Primary Pharmacy Type |
PharmacyTypeModel |
None. |
| SecondaryPharmacyType |
Secondary Pharmacy Type |
PharmacyTypeModel |
None. |
| TertiaryPharmacyType |
Tertiary Pharmacy Type |
PharmacyTypeModel |
None. |
| Is24HourOperation |
Is this a 24 Hour Operation |
boolean |
None. |
| ProviderHours |
Provider Hours |
string |
None. |
| DispenserClassCode |
Dispenser Class Code |
string |
None. |
| ContactFirstName |
Contact Person's First Name |
string |
None. |
| ContactMiddleName |
Contact Person's Middle Name |
string |
None. |
| ContactLastName |
Contact Person's Last Name |
string |
None. |
| ContactTitle |
Contact Person's Title |
string |
None. |
| ContactEmailAddress |
Contact Person's Email Address |
string |
None. |
| ContactPhone |
Contact Person's Phone |
string |
None. |
| ContactPhoneExt |
Contact Person's Phone Extension |
string |
None. |
| StoreNumber |
Store Number |
string |
None. |
| PrimaryRelationshipCode |
Primary Relationship Chain Code |
string |
None. |
| ChainCode |
Chain Code |
string |
None. |
| FranchiseCode |
Franchise Code |
string |
None. |
| PharmacyHeadquarterNo |
Identifier for the pharmacy headquarter to which this location is tied |
integer |
None. |
| PharmacyHeadquarterUrl |
Url at which the pharmacy headquarter to which this location is tied can be viewed |
string |
None. |
| PharmacyHeadquarterLock |
Lock the HQ |
boolean |
None. |
| OverridePaymentCenters |
Override the payment centers |
boolean |
None. |
| PaymentPayablesCenterNo |
Payment payables center identifier |
integer |
None. |
| PaymentPayablesCenterUrl |
Url for the payment payables center to be viewed/modified |
string |
None. |
| RemitPayablesCenterNo |
Remit payables center identifier |
integer |
None. |
| RemitPayablesCenterUrl |
Url for the remit payables center to be viewed/modified |
string |
None. |
| OpenDate |
Open date |
date |
None. |
| ClosureDate |
Closure Date |
date |
None. |
| ReinstatementDate |
Reinstatement date |
date |
None. |
| PaymentMethod |
Payment Method |
string |
None. |
| FinancialInstitutionID |
Financial institution identifier |
string |
None. |
| FinancialInstitutionAccountNo |
Account number for the location's financial institution |
string |
None. |
| Sync |
Sync this with DataQ |
boolean |
None. |
| LocationName |
Name |
string |
None. |
| LocationPrintName |
Print name |
string |
None. |
| PrimaryAddress |
Primary/Physical Address |
AddressModel |
None. |
| MailingAddress |
Mailing Address |
AddressModel |
None. |
| PrimaryPhone |
Primary Phone |
PhoneModel |
None. |
| DEA |
DEA Number |
string |
None. |
| NCPDP |
NCPDP Number |
string |
None. |
| NPI |
NPI |
string |
None. |
| EmailAddress |
Email address |
string |
None. |
| WebAddress |
Web address |
string |
None. |
| FederalTaxID |
Federal tax id |
string |
None. |
| Comment |
Comment about this location |
string |
None. |
| Active |
Active flag. 0=inactive, 1=active |
integer |
None. |
| TimeZone |
Time Zone |
string |
None. |
| MedicareID |
Medicare ID |
string |
None. |
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
| ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 43",
"id": 44,
"taxRate": 2.0,
"taxExempt": true,
"primaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"secondaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"tertiaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"is24HourOperation": true,
"providerHours": "sample string 5",
"dispenserClassCode": "sample string 6",
"contactFirstName": "sample string 7",
"contactMiddleName": "sample string 8",
"contactLastName": "sample string 9",
"contactTitle": "sample string 10",
"contactEmailAddress": "sample string 11",
"contactPhone": "sample string 12",
"contactPhoneExt": "sample string 13",
"storeNumber": "sample string 14",
"primaryRelationshipCode": "sample string 15",
"chainCode": "sample string 16",
"franchiseCode": "sample string 17",
"pharmacyHeadquarterNo": 19,
"pharmacyHeadquarterUrl": "sample string 20",
"pharmacyHeadquarterLock": true,
"overridePaymentCenters": true,
"paymentPayablesCenterNo": 1,
"paymentPayablesCenterUrl": "sample string 23",
"remitPayablesCenterNo": 1,
"remitPayablesCenterUrl": "sample string 24",
"openDate": "2025-12-09T20:14:31.0194541-06:00",
"closureDate": "2025-12-09T20:14:31.0194541-06:00",
"reinstatementDate": "2025-12-09T20:14:31.0194541-06:00",
"paymentMethod": "sample string 28",
"financialInstitutionID": "sample string 29",
"financialInstitutionAccountNo": "sample string 30",
"sync": true,
"locationName": "sample string 32",
"locationPrintName": "sample string 33",
"primaryAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"mailingAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"primaryPhone": {
"phoneType": 0,
"displaySequence": 1,
"phone1": "sample string 2",
"ext": "sample string 3",
"dialString": "sample string 4"
},
"dea": "sample string 34",
"ncpdp": "sample string 35",
"npi": "sample string 36",
"emailAddress": "sample string 37",
"webAddress": "sample string 38",
"federalTaxID": "sample string 39",
"comment": "sample string 40",
"active": 1,
"timeZone": "sample string 41",
"medicareID": "sample string 42"
}