{"info":{"_postman_id":"22a866e7-7424-4030-aee9-62f578cd0996","name":"Trading Partner Directory MVP API","description":"

The Drug Quality and Security Act (DQSA), was enacted by Congress on November 27, 2013. Title II of DQSA, the Drug Supply Chain Security Act (DSCSA), outlines steps to achieve interoperable, electronic tracing of products at the package level to identify and trace certain prescription drugs as they are distributed in the United States. This will enhance FDA’s ability to help protect consumers from exposure to drugs that may be counterfeit, stolen, contaminated, or otherwise harmful. These requirements will also improve detection and removal of potentially dangerous drugs from the drug supply chain to protect U.S. consumers.

\n

Additionally, the DSCSA directs FDA to establish national licensure standards for wholesale distributors and third-party logistics providers, and requires these entities report licensure and other information to FDA annually.

\n

The following are HTTP / JSON API endpoints provided for the MVP phase of the NABP Trading Partner Directory to support DSCSA operations.

\n

NABP must approve consumers who wish to use these services. A NABP representative will provide additional information regarding access to these services upon approval.

\n

Overview

\n

This API covers the following functionality:

\n\n

*The Product Trace categorization methodolgy is expected to change drastically in the near future.

\n

Endpoints to allow for DSCSA Product Verification request generation and responses are in the planning phase.

\n

Changelog

\n
July 18th, 2023:\n - Status: Trace endpoints updated.\nJuly 17th, 2023:\n - Status: Trace endpoints are OUTDATED. Trace endpoints will be\n up to date by July 18th, 2023.\n - Feature: Added an endpoint for detailed directory searching.\nMarch 25th, 2023:\n - Feature: Added an \"organization\" field to regulator contact\n details in trace request responses.\n - Feature: Added endpoint for obtaining trading partner\n information by searching by Pulse ID. This endpoint works nearly\n identically to the search by GLN endpoint.\nMarch 15th, 2023:\n - Breaking change: Endpoint for Auth0 has been updated to a\n custom domain. Please update your authentication flow accordingly.\n - Feature: Added endpoint for obtaining a list of trading partners\n your current access token has permissions for, and what those\n permissions are.\nMarch 14th, 2023:\n - Breaking change: Endpoints for getting all trace requests\n previously inconsistently returned snake_case for created_at,\n created_by, updated_at, and updated_by. It now returns\n createdAt, createdBy, updatedAt, and updatedBy consistently.\nMarch 13th, 2023:\n - Finished parameter examples for trace request filtering.\n\n

General Feedback

\n

If you are not working directly with a NABP representative and you wish to get in touch, please contact us at feedback@dscsa.dev. We will get back to you as soon as possible.

\n

Default Value References

\n

Some fields such as state, country, licensing agency, and licensing type require providing integer IDs of reference values. Below you will find a series of tables providing all current relevant reference ID values.

\n

States and Countries

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
State IDState NameCountry IDCountry Name
1Alabama230United States
2Alaska230United States
3Arizona230United States
4Arkansas230United States
5California230United States
6Colorado230United States
7Connecticut230United States
8Delaware230United States
9Florida230United States
10Georgia230United States
11Hawaii230United States
12Idaho230United States
13Illinois230United States
14Indiana230United States
15Iowa230United States
16Kansas230United States
17Kentucky230United States
18Louisiana230United States
19Maine230United States
20Maryland230United States
21Massachusetts230United States
22Michigan230United States
23Minnesota230United States
24Mississippi230United States
25Missouri230United States
26Montana230United States
27Nebraska230United States
28Nevada230United States
29New Hampshire230United States
30New Jersey230United States
31New Mexico230United States
32New York230United States
33North Carolina230United States
34North Dakota230United States
35Ohio230United States
36Oklahoma230United States
37Oregon230United States
38Pennsylvania230United States
39Rhode Island230United States
40South Carolina230United States
41South Dakota230United States
42Tennessee230United States
43Texas230United States
44Utah230United States
45Vermont230United States
46Virginia230United States
47Washington230United States
48West Virginia230United States
49Wisconsin230United States
50Wyoming230United States
51American Samoa230United States
52District of Columbia230United States
53Federated States of Micronesia230United States
54Guam230United States
55Marshall Islands230United States
56Northern Mariana Islands230United States
57Palau230United States
58Puerto Rico230United States
59Virgin Islands230United States
60Ontario38Canada
61Quebec38Canada
62Nova Scotia38Canada
63New Brunswick38Canada
64Manitoba38Canada
65British Columbia38Canada
66Prince Edward Island38Canada
67Saskatchewan38Canada
68Alberta38Canada
69Newfoundland and Labrador38Canada
70Northwest Territories38Canada
71Yukon38Canada
72Nunavut38Canada
73Lebanon230United States
74Aakkar126Lebanon
75An Nabatiyah126Lebanon
76Baalbek-Hermel126Lebanon
77Beirut126Lebanon
78Beqaa126Lebanon
79Mount Lebanon126Lebanon
80North Lebanon126Lebanon
81South Lebanon126Lebanon
82Armed Forces Americas230United States
83Armed Forces Europe230United States
84Armed Forces Pacific230United States
85New South Wales13Australia
86Australian Capital Territory13Australia
88Victoria13Australia
89Queensland13Australia
90South Australia13Australia
91Western Australia13Australia
92Tasmania13Australia
94Northern Territory13Australia
95Louisiana-Hurricane Laura230United States
\n

Licensing Agencies

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Agency IDAgency NameAgency Description
1Alabama Board of Home Medical EquipmentAlabama Board of Home Medical Equipment
2Alabama Board of Medical Examiners and Medical Lisensure CommisionAlabama Board of Medical Examiners and Medical Lisensure Commision
3Alabama Board of NursingAlabama Board of Nursing
4Alabama Board of PharmacyAlabama Board of Pharmacy
5Alaska Board of PharmacyAlaska Board of Pharmacy
6Alaska Dept of Commerce, Community and Economic DevelopmentAlaska Dept of Commerce, Community and Economic Development
7Arizona Board of PharmacyArizona Board of Pharmacy
8Arizona Medical BoardArizona Medical Board
9Arizona State Board of NursingArizona State Board of Nursing
10Arizona State Veterinary Medical Examining BoardArizona State Veterinary Medical Examining Board
11Arkansas Medical BoardArkansas Medical Board
12Arkansas State Board of NursingArkansas State Board of Nursing
13Arkansas State Board of PharmacyArkansas State Board of Pharmacy
14Board Of Medical PracticeBoard Of Medical Practice
15Bureau of Narcotic Enforcement - New York State Department of HealthBureau of Narcotic Enforcement - New York State Department of Health
16California Department of Consumer AffairsCalifornia Department of Consumer Affairs
17California Department of Public HealthCalifornia Department of Public Health
18California State Board of PharmacyCalifornia State Board of Pharmacy
19Colorado Department of Regulatory AgenciesColorado Department of Regulatory Agencies
20Colorado State Board of PharmacyColorado State Board of Pharmacy
21Commonwealth of Massachusetts Board of Registration in MedicineCommonwealth of Massachusetts Board of Registration in Medicine
22Connecticut Commission of PharmacyConnecticut Commission of Pharmacy
23Connecticut Department of Consumer ProtectionConnecticut Department of Consumer Protection
24Delaware State Board of PharmacyDelaware State Board of Pharmacy
25District of Columbia Board of PharmacyDistrict of Columbia Board of Pharmacy
26District of Columbia Department of HealthDistrict of Columbia Department of Health
27Drug Enforcement AdministrationDrug Enforcement Administration
28Florida Agency for Health Care AdministrationFlorida Agency for Health Care Administration
29Florida Board of PharmacyFlorida Board of Pharmacy
30Florida Department of Business & Professional RegulationFlorida Department of Business & Professional Regulation
31Florida Department of HealthFlorida Department of Health
32Georgia Composite Medical BoardGeorgia Composite Medical Board
33Georgia Department of Community HealthGeorgia Department of Community Health
34Georgia Professional LicensingGeorgia Professional Licensing
35Georgia State Board of PharmacyGeorgia State Board of Pharmacy
36Government of the U.S. Virgin Islands Department of Licensing and Consumer AffairsGovernment of the U.S. Virgin Islands Department of Licensing and Consumer Affairs
37Guam Board of Examiners for PharmacyGuam Board of Examiners for Pharmacy
38Hawaii Department of Commerce & Consumer AffairsHawaii Department of Commerce & Consumer Affairs
39Hawaii State Board of PharmacyHawaii State Board of Pharmacy
40Idaho Board of Veterinary MedicineIdaho Board of Veterinary Medicine
41Idaho State Board of NursingIdaho State Board of Nursing
42Idaho State Board of PharmacyIdaho State Board of Pharmacy
43Illinois Department of Financial and Professional RegulationIllinois Department of Financial and Professional Regulation
44Illinois Department of Financial and Professional Regulation - State Board of PharmacyIllinois Department of Financial and Professional Regulation - State Board of Pharmacy
45Indiana Board of PharmacyIndiana Board of Pharmacy
46Indiana Professional Licensing AgencyIndiana Professional Licensing Agency
47Iowa Board of MedicineIowa Board of Medicine
48Iowa Board of NursingIowa Board of Nursing
49Iowa Board of PharmacyIowa Board of Pharmacy
50Iowa Department of Public Health Bureau of Professional LicensureIowa Department of Public Health Bureau of Professional Licensure
51Kansas Board of Healing ArtsKansas Board of Healing Arts
52Kansas Board of NursingKansas Board of Nursing
53Kansas Board of PharmacyKansas Board of Pharmacy
54Kansas Department of AgricultureKansas Department of Agriculture
55Kentucky Board of Medical LicensureKentucky Board of Medical Licensure
56Kentucky Board of PharmacyKentucky Board of Pharmacy
57Kentucky Cabinet for Health and Family ServicesKentucky Cabinet for Health and Family Services
58Kentucky Nursing BoardKentucky Nursing Board
59Kentucky Office of Occupations & Professions - Board of Veterinary ExaminersKentucky Office of Occupations & Professions - Board of Veterinary Examiners
60Louisiana Board of Drug and Device DistributorsLouisiana Board of Drug and Device Distributors
61Louisiana Board of PharmacyLouisiana Board of Pharmacy
62Louisiana State Board of Medical ExaminersLouisiana State Board of Medical Examiners
63Louisiana State Board of NursingLouisiana State Board of Nursing
64Maine Board of PharmacyMaine Board of Pharmacy
65Maryland Board of NursingMaryland Board of Nursing
66Maryland Board of PhysiciansMaryland Board of Physicians
67Maryland Department of Health and Mental HygieneMaryland Department of Health and Mental Hygiene
68Maryland.gov Deparment of AgricultureMaryland.gov Deparment of Agriculture
69Massachusetts Board of Registration in PharmacyMassachusetts Board of Pharmacy
70Massachusetts Board of Registration in Veterinary MedicineMassachusetts Board of Registration in Veterinary Medicine
71Massachusetts Office of Health and Human ServicesMassachusetts Office of Health and Human Services
72Michigan Board of PharmacyMichigan Board of Pharmacy
73Michigan Department of Licensing and Regulatory AffairsMichigan Department of Licensing and Regulatory Affairs
74Minnesota Board of Medical PracticeMinnesota Board of Medical Practice
75Minnesota Board of NursingMinnesota Board of Nursing
76Minnesota Board of PharmacyMinnesota Board of Pharmacy
77Mississippi Board of Medical LicensureMississippi Board of Medical Licensure
78Mississippi Board of NursingMississippi Board of Nursing
79Mississippi Board of PharmacyMississippi Board of Pharmacy
80Mississippi Board of Veterinary MedicineMississippi Board of Veterinary Medicine
81Missouri Board of NursingMissouri Board of Nursing
82Missouri Board of PharmacyMissouri Board of Pharmacy
83Missouri Deparment of Health and Senior ServicesMissouri Deparment of Health and Senior Services
84Missouri Division of Professional RegistrationMissouri Division of Professional Registration
85Montana Board of PharmacyMontana Board of Pharmacy
86Montana Department of Labor & IndustryMontana Department of Labor & Industry
87National Healthcareer Association - CPhTNational Healthcareer Association - CPhT
88Nebraska Board of PharmacyNebraska Board of Pharmacy
89Nebraska Department of Health and Human ServicesNebraska Department of Health and Human Services
90Nevada State Board of Osteopathic MedicineNevada State Board of Osteopathic Medicine
92Nevada State Board of Medical ExaminersNevada State Board of Medical Examiners
93Nevada State Board of NursingNevada State Board of Nursing
94Nevada State Board of PharmacyNevada State Board of Pharmacy
95New Hampshire Board of MedicineNew Hampshire Board of Medicine
96New Hampshire Board of NursingNew Hampshire Board of Nursing
97New Hampshire Board of PharmacyNew Hampshire Board of Pharmacy
98New Hampshire Board of Veterinary MedicineNew Hampshire Board of Veterinary Medicine
99New Jersey State Board of PharmacyNew Jersey State Board of Pharmacy
100New Mexico Board of PharmacyNew Mexico Board of Pharmacy
101New Mexico Board of Veterinary MedicineNew Mexico Board of Veterinary Medicine
102New Mexico Regulation & Licensing DepartmentNew Mexico Regulation & Licensing Department
103New York State Board of PharmacyNew York State Board of Pharmacy
104New York State Office of the ProfessionsNew York State Office of the Professions
105North Carolina Board of NursingNorth Carolina Board of Nursing
106North Carolina Board of PharmacyNorth Carolina Board of Pharmacy
107North Carolina Department of Agricultur & Consumer Services - Food & Drug Protection DivisionNorth Carolina Department of Agricultur & Consumer Services - Food & Drug Protection Division
108North Carolina Department of Health and Human ServicesNorth Carolina Department of Health and Human Services
109North Carolina Medical BoardNorth Carolina Medical Board
110North Carolina Veterinary Medical BoardNorth Carolina Veterinary Medical Board
111North Dakota Board of MedicineNorth Dakota Board of Medicine
112North Dakota Board of NursingNorth Dakota Board of Nursing
113North Dakota Board of PharmacyNorth Dakota Board of Pharmacy
114Offices of Inspector General - U.S. Department of Health & Human ServicesOffices of Inspector General - U.S. Department of Health & Human Services
115Ohio Board of NursingOhio Board of Nursing
116Ohio Veterinary Medical Licensing BoardOhio Veterinary Medical Licensing Board
117Oklahoma Board of Medical Licensure and SupervisionOklahoma Board of Medical Licensure and Supervision
118Oklahoma Board of Osteopathic ExaminersOklahoma Board of Osteopathic Examiners
119Oklahoma Board of PharmacyOklahoma Board of Pharmacy
120Oklahoma Board of Veterinary Medical ExaminersOklahoma Board of Veterinary Medical Examiners
121Oklahoma Board or NursingOklahoma Board or Nursing
122Oklahoma Bureau of Narcotics and Dangerous Drugs ControlOklahoma Bureau of Narcotics and Dangerous Drugs Control
123Oregon Board of PharmacyOregon Board of Pharmacy
124Oregon Medical BoardOregon Medical Board
125Oregon State Board of NursingOregon State Board of Nursing
126Oregon Veterinary Medical Examining BoardOregon Veterinary Medical Examining Board
127Pennsylvania Department of Health Drug, Device and Cosmetic ProgramPennsylvania Department of Health Drug, Device and Cosmetic Program
128Pennsylvania Department of StatePennsylvania Department of State
129Pennsylvania State Board of PharmacyPennsylvania State Board of Pharmacy
130Pharmacy Technician Certification BoardPharmacy Technician Certification Board
131Puerto Rico Board of PharmacyPuerto Rico Board of Pharmacy
132Rhode Island Board of PharmacyRhode Island Board of Pharmacy
133SCDHEC Bureau of Drug ControlSCDHEC Bureau of Drug Control
134South Carolina Department of Labor, Licensing and Regulation - Board of PharmacySouth Carolina Department of Labor, Licensing and Regulation - Board of Pharmacy
135South Carolina Department of Labor, Licensing and Regulation - Medical BoardSouth Carolina Department of Labor, Licensing and Regulation - Medical Board
136South Carolina Department of Labor, Licensing and Regulation - Nursing BoardSouth Carolina Department of Labor, Licensing and Regulation - Nursing Board
137South Carolina Department of Labor, Licensing and Regulation - Veterinary BoardSouth Carolina Department of Labor, Licensing and Regulation - Veterinary Board
138South Dakota Board of Medical & Osteopathic ExaminersSouth Dakota Board of Medical & Osteopathic Examiners
139South Dakota Board of NursingSouth Dakota Board of Nursing
140South Dakota Board of Veterinary Medical ExaminersSouth Dakota Board of Veterinary Medical Examiners
141South Dakota Department of HealthSouth Dakota Department of Health
142South Dakota State Board of PharmacySouth Dakota State Board of Pharmacy
143State Medical Board of OhioState Medical Board of Ohio
144State of Alaska Department of Commerce, Community and Economic DevelopmentState of Alaska Department of Commerce, Community and Economic Development
145State of Arkansas Veterinary Medical Examining BoardState of Arkansas Veterinary Medical Examining Board
146State of California Department of Consumer AffairsState of California Department of Consumer Affairs
147State of Delaware - Division of Professional RegulationState of Delaware - Division of Professional Regulation
187College of Pharmacists of British ColumbiaCollege of Pharmacists of British Columbia
148State of Hawaii, Department of Health - Office of Health Care AssuranceState of Hawaii, Department of Health - Office of Health Care Assurance
149State of Idaho Board of MedicineState of Idaho Board of Medicine
150State of Maine Department of Professional and Financial RegulationState of Maine Department of Professional and Financial Regulation
151State of Maryland Board of PharmacyState of Maryland Board of Pharmacy
152State of New Jersey Department of HealthState of New Jersey Department of Health
153State of Ohio Board of PharmacyState of Ohio Board of Pharmacy
154State of Rhode Island Department of HealthState of Rhode Island Department of Health
155State of Vermont Office of Professional RegulationState of Vermont Office of Professional Regulation
156Tennessee Board of PharmacyTennessee Board of Pharmacy
157Tennessee Department of HealthTennessee Department of Health
158Texas Board of NursingTexas Board of Nursing
159Texas Department of State Health ServicesTexas Department of State Health Services
160Texas Medical BoardTexas Medical Board
161Texas Physician Assistant BoardTexas Physician Assistant Board
162Texas State Board of PharmacyTexas State Board of Pharmacy
163Texas Veterinary BoardTexas Veterinary Board
164The State of New Jersey Department of Law & Public Safety - Division of Consumer AffairsThe State of New Jersey Department of Law & Public Safety - Division of Consumer Affairs
165U. S. Food & Drug AdministrationU. S. Food & Drug Administration
166Utah Board of PharmacyUtah Board of Pharmacy
167Utah Division of Occupational and Professional LicensingUtah Division of Occupational and Professional Licensing
168Vermont Board of PharmacyVermont Board of Pharmacy
169Virgin Islands Board of PharmacyVirgin Islands Board of Pharmacy
170Virginia Board of PharmacyVirginia Board of Pharmacy
171Virginia Deparment of Health ProfessionsVirginia Deparment of Health Professions
172Washington State Board of PharmacyWashington State Board of Pharmacy
173Washington State Department of HealthWashington State Department of Health
174West Virginia Board of Examiners for Registered Professional NursesWest Virginia Board of Examiners for Registered Professional Nurses
175West Virginia Board of MedicineWest Virginia Board of Medicine
176West Virginia Board of PharmacyWest Virginia Board of Pharmacy
177Wisconsin Pharmacy Examining BoardWisconsin Pharmacy Examining Board
178Wisonsin Deparment of Safety and Professional ServicesWisonsin Deparment of Safety and Professional Services
179WV Board of Osteopathic MedicineWV Board of Osteopathic Medicine
180Wyoming Board of MedicineWyoming Board of Medicine
181Wyoming State Board of NursingWyoming State Board of Nursing
182Wyoming State Board of PharmacyWyoming State Board of Pharmacy
185State ProgramState Program
186Alberta College of PharmacyAlberta College of Pharmacy
188College of Pharmacists of ManitobaCollege of Pharmacists of Manitoba
189New Brunswick College of PharmacistsNew Brunswick College of Pharmacists
190Newfoundland & Labrador Pharmacy BoardNewfoundland & Labrador Pharmacy Board
191Nova Scotia College of PharmacistsNova Scotia College of Pharmacists
192Government of Northwest TerritoriesGovernment of Northwest Territories
193Department of Health - Government of NunavutDepartment of Health - Government of Nunavut
194Ontario College of PharmacistsOntario College of Pharmacists
195Prince Edward Island College of PharmacistsPrince Edward Island College of Pharmacists
196Saskatchewan College of Pharmacy ProfessionalsSaskatchewan College of Pharmacy Professionals
197Government of YukonGovernment of Yukon
198Quebec Order of PharmacistsQuebec Order of Pharmacists
\n

License Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
License Type IDLicense Type Description
13rd Party Logistics
2Business License
3Controlled Substance - Drug Distributor
4Pharmacist Controlled Substance
5Controlled Substance - Pharmacy
6DEA (Facility)
7Controlled Substance - Manufacturer
8Drug Company
9Durable Medical Equipment (DME)
10Drug Sample Distributor
11FDA
12Controlled Substance - Wholesaler
13Manufacturer
14Mail Order Pharmacy
15Dispensing Controlled Substance
16Over the Counter Drug Permit
17Pharmacy
18Pharmacist
19Drug Other Controlled Substance
20Limited Controlled Substance
21Repackager
22Sterile Compounding
23Miscellaneous Permit (Controlled Substance)
24Veterinary
25OIG (Facility)
26Wholesale Distributor
27Home Medical Equipment (HME)
28Registration
29Pharmacy Technician Certification (PTCB, ICPT/NHA)
30Veterinarian
31Pharmacy Technician License/Registration
32Other Outlet
33Veterinary Drug Outlet
34Pharmacy Intern
35Designated Representative
36Hospital Pharmacy
37Institutional Pharmacy
38Medical Doctor
39Doctor of Osteopathy
40Nurse Practitioner
41Registered Nurse
42Physician Assistant
43DEA (Individual)
44Non-Resident Pharmacy
45Non-Resident Sterile Compounding
46Nuclear Pharmacy
47Outsourcing Facility
48Pain Management Clinic
49Specialized Prescription Drug Outlet
50Drug Distributing Agent
51Limited Chemical Wholesale Pharmacy
52Manufacturer/Wholesale/Distributor
53Medical Gas Distributor
54Medical Gas Supplier
55Precursor Chemical Suppliers
56Prescription Drug Distributor
57Reverse Distributor
58Wholesaler/Manufacturer
59Designated Representative - 3PL
60Doctor of Osteopathy Controlled Substance
61Medical Doctor Controlled Substance
62Nurse Practitioner Controlled Substance
63OIG (Individual)
64Pharmacist Extern Registration
65Pharmacy Assistant
66Physician Assistant Controlled Substance
67Vet Drug Technician Registration
68Veterinarian Controlled Substance
69Consultant Pharmacist
70Nuclear Pharmacist
71Pharmacist in Charge (PIC)
72Certified Pharmacy Technician License/Registration
73Pharmacy Technician Trainee
74Medical Gas
75Complimentary Drug Distributor
76Controlled Substance - Outsourcing Facility
77Non-Dispensing Drug Outlet/Pharmacy
78Non-Resident Pharmacist
79Pharmacist Clinician
80Injectables Authorization
81Telepharmacist
82Advanced Practice Pharmacist
83Practitioner Controlled Substance
84Automated Pharmacy Dispensing Unit
85Remote Dispensing Pharmacy
86Pharmacy Immunization Approval
87Compounder
88Distributor
89Dentist Controlled Substance
90Business Controlled Substance
91Practitioner Dispensing Registration
92Nonresident Outsourcing Facility
93Special Work Permit
94Administration of Drugs and Vaccines
95Pharmacy Automated Dispensing Unit
96DELETED Practitioner Controlled Substance
97Podiatrist Controlled Substance
98Advanced Practice RN Controlled Substance
99Certified Compounded Sterile Preparation Technician (PTCB)
100Nonresident Drug Outlet
101Non-Prescription Drug Distributor
102Home Health/Hospice Pharmacy
103Non-Resident Pharmacist in Charge (PIC)
107COVID19-Pharmacy Passport
108COVID19-Wholesaler Passport
109COVID19-Other Business Passport
111Temporary/Provisional Pharmacist
112Temporary/Provisional Pharmacy Technician
113Controlled Substance - 3PL
114Advanced Certified Pharmacy Technician
115Pharmaceutical Warehouse
116Emergency Medication Kit Permit
117Pharmacy Benefit Manager
118Virtual Manufacturer
119NABP Verify Pharmacist Credential
120NABP Verify Technician Credential
121NABP Verify Intern Credential
122Technician Dispensing Registration
123Military Spouse Pharmacist
124Clinic
125Opioid Manufacturer
\n

Trading Partner Status Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Type IDType Description
1Verified
2Not Verified
\n

Trading Partner Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Type IDType Description
1Dispenser
2Distributor
33PL
4Manufacturer
5Repackager
6Regulator
\n

Trading Partner Attribute Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Attribute IDAttribute Description
1STORE #
2GS1 GLN #
3NCPDP #
4FEIN
5NPI #
6DEA #
7GLEIF #
8HIN #
9DUNS #
10eProfile ID
11FDA #
\n

Phone Number Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Phone Number Type IDPhone Number Type Description
1Mobile
2Landline
3Fax
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Changelog","slug":"changelog"},{"content":"General Feedback","slug":"general-feedback"},{"content":"Default Value References","slug":"default-value-references"}],"owner":"25477588","collectionId":"22a866e7-7424-4030-aee9-62f578cd0996","publishedId":"2s8ZDbVLTZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"d32f2f"},"publishDate":"2023-01-24T01:11:29.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get Access Token","id":"1b0f8881-7b97-4d61-bf61-f44a8b1889a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","description":"

Sets the OAuth2 Grant Type to Password.

\n","type":"text"},{"key":"audience","value":"tpd-dev","description":"

Sets the OAuth2 Audience to tpd-dev for access to the MVP environment.

\n","type":"text"},{"key":"scope","value":"openid","description":"

Requests the standard set of openid OAuth2 scopes.

\n","type":"text"},{"key":"client_id","value":"Z4xk9PAgarI1W4Mt3AY6OfDs2BnX6pvv","description":"

Sets the OAuth2 Client ID to the ID of the MVP application.

\n","type":"text"},{"key":"username","value":"example@dscsa.dev","description":"

Username of your account in the MVP application.

\n","type":"text"},{"key":"password","value":"example_password","description":"

Password of your account in the MVP application.

\n","type":"text"}]},"url":"https://devauth.dscsa.dev/oauth/token","urlObject":{"protocol":"https","path":["oauth","token"],"host":["devauth","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"c1a08df9-1792-4d2b-bd83-7b6c9a580932","name":"Get Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","description":"Sets the OAuth2 Grant Type to Password.","type":"text"},{"key":"audience","value":"tpd-dev","description":"Sets the OAuth2 Audience to tpd-dev for access to the MVP environment.","type":"text"},{"key":"scope","value":"openid","description":"Requests the standard set of openid OAuth2 scopes.","type":"text"},{"key":"client_id","value":"Z4xk9PAgarI1W4Mt3AY6OfDs2BnX6pvv","description":"Sets the OAuth2 Client ID to the ID of the MVP application.","type":"text"},{"key":"username","value":"example@dscsa.dev","description":"Username of your account in the MVP application.","type":"text"},{"key":"password","value":"example_password","description":"Password of your account in the MVP application.","type":"text"}]},"url":"https://dev-j2orxzsecb82lgm4.us.auth0.com/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"example_access_token\",\n \"id_token\": \"example_id_token\",\n \"scope\": \"openid profile email address phone\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"1b0f8881-7b97-4d61-bf61-f44a8b1889a0"}],"id":"da9da9ca-c4fe-49ed-a4e1-0c4992e93758","description":"

To obtain an access token, utilize the following Auth0 OAuth 2 API to exchange your NABP Trading Partner Directory username and password for an access token in the form of a JWT.

\n","_postman_id":"da9da9ca-c4fe-49ed-a4e1-0c4992e93758"},{"name":"License Information","item":[{"name":"Find License Information by License Number","id":"aa5ee0eb-6764-4be4-a2a0-a7cdb0a9e1c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"example_license\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info","urlObject":{"protocol":"https","path":["directory","license","info"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"a8fad769-bc0f-466d-aba4-ad7e487b379c","name":"OK with Valid License Syntax Because of Licensing Agency Provided","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgencyId\": 18\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Valid\",\n \"reason\": \"License number for given licensingAgencyId validated against license type 17\"\n }\n}"},{"id":"d009fa85-6d8e-4c01-845a-ddcbdbb571fa","name":"OK with Valid License Syntax Because of Licensing Agency and License Type Provided","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Valid\",\n \"reason\": \"License number for given licensingAgencyId and licenseTypeId validated.\"\n }\n}"},{"id":"d76333ae-0bf7-4684-9bd4-34824cdfead9","name":"OK with Unknown License Syntax Because of No Licensing Agency or License Type Provided","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 12345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No licensingAgencyId or licenseTypeId provided.\"\n }\n}"},{"id":"631744fe-21ea-4e3a-b2dd-4c34a3606745","name":"OK with Unknown License Syntax Because of No Validation Rules Found for Licensing Agency","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgencyId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No license number validation rules found for given licensingAgencyId.\"\n }\n}"},{"id":"bb275682-9b15-4780-a643-fdf01ac74a5d","name":"OK with Unknown License Syntax Because of No Validation Rules Found for Licensing Agency and License Type","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 16\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No license number validation rules found for given licenseTypeId for given licensingAgencyId.\"\n }\n}"},{"id":"83b8bafa-eed9-4aa7-bc6a-a9c0fbbb29dd","name":"OK with Invalid License Syntax","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"0001-863906\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licenseNumber\": \"0001-863906\",\n \"licensingAgency\": \"New York State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"DEF Pharmacy Co.\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2023-12-31T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\",\n \"licenseSyntax\": {\n \"status\": \"Invalid\",\n \"reason\": \"License number must start with PHY or PHE and be followed by 4 or 5 digits.\"\n }\n}"},{"id":"b0816010-f971-43e7-9350-a9eb505622a2","name":"Error with Valid License Syntax Because of Licensing Agency Provided","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 0000\",\n \"licensingAgencyId\": 18\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Valid\",\n \"reason\": \"License number for given licensingAgencyId validated against license type 17\"\n }\n}"},{"id":"b4e3fba0-b27a-4a18-8d2a-8425b54cf7ba","name":"Error with Valid License Syntax Because of Licensing Agency and License Type Provided","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 0000\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Valid\",\n \"reason\": \"License number for given licensingAgencyId and licenseTypeId validated.\"\n }\n}"},{"id":"22481cdb-19af-4ab5-8ca9-0675389d6191","name":"Error with Unknown License Syntax Because of No Licensing Agency or License Type Provided","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 0000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No licensingAgencyId or licenseTypeId provided.\"\n }\n}"},{"id":"c2f8d349-3e74-4471-bd12-be70f2868af6","name":"Error with Unknown License Syntax Because of No Validation Rules Found for Licensing Agency","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 0000\",\n \"licensingAgencyId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No license number validation rules found for given licensingAgencyId.\"\n }\n}"},{"id":"a6b8b189-bcd6-42bd-b077-3c04f802f4b1","name":"Error with Unknown License Syntax Because of No Validation Rules Found for Licensing Agency and License Type","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHY 0000\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 16\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Unknown\",\n \"reason\": \"No license number validation rules found for given licenseTypeId for given licensingAgencyId.\"\n }\n}"},{"id":"1657617e-e996-4c8c-8cf0-12de8f21265d","name":"Error with Invalid License Syntax","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseNumber\": \"PHX 000000\",\n \"licensingAgencyId\": 18,\n \"licenseTypeId\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/license/info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided license number could not be found in our records.\",\n \"licenseSyntax\": {\n \"status\": \"Invalid\",\n \"reason\": \"License number must start with PHY or PHE and be followed by 4 or 5 digits.\"\n }\n}"}],"_postman_id":"aa5ee0eb-6764-4be4-a2a0-a7cdb0a9e1c0"}],"id":"f4adf1a8-299b-4935-936c-22c5e52483b0","description":"

To obtain the information (including status) of a known license number, utilize the following API endpoint. The NABP Trading Partner Directory will match the license number to our records and return concise relevant information about that license.

\n","_postman_id":"f4adf1a8-299b-4935-936c-22c5e52483b0"},{"name":"Trading Partner Information","item":[{"name":"Get Trading Partner Information by GS1 GLN","id":"5ecf3b42-67a3-4b6b-a43a-a69a1e191c57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dscsa.dev/directory/partner/gln/example_gln/info","urlObject":{"protocol":"https","path":["directory","partner","gln","example_gln","info"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"8c6020d4-2338-49a0-8ece-1b8bd8a41329","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/directory/partner/gln/example_gln/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"dbaName\": \"Twin Pines Inc\",\n \"legalName\": \"Twin Pines\",\n \"isAuthorized\": true,\n \"isIdentityVerified\": true,\n \"status\": \"Verified\",\n \"type\": \"Dispenser\",\n \"addresses\": [\n {\n \"addressLine1\": \"1640 Riverside Drive\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Hill Valley\",\n \"country\": \"US\",\n \"zip\": \"91001\",\n \"state\": \"CA\",\n \"type\": \"Primary\"\n }\n ],\n \"licenses\": [\n {\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\"\n }\n ],\n \"contacts\": [\n {\n \"email\": \"twinpines@dscsa.dev\",\n \"phoneNumber\": {\n \"internationalCallingCode\": \"1\",\n \"number\": \"222-538-8873\",\n \"type\": \"Mobile\"\n },\n \"isPrimary\": false,\n \"legalName\": \"Martin McFly\",\n \"eprofileId\": \"Unknown\",\n \"type\": \"DSCSA Contact\",\n \"address\": {\n \"addressLine1\": \"1640 Riverside Drive\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Hill Valley\",\n \"country\": \"US\",\n \"zip\": \"91002\",\n \"state\": \"CA\"\n }\n }\n ],\n \"gln\": \"867653454060\"\n}"},{"id":"b5577795-9bc8-4f11-befb-9da040d29996","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/directory/partner/gln/example_gln/info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided GLN number could not be found in our records.\"\n}"}],"_postman_id":"5ecf3b42-67a3-4b6b-a43a-a69a1e191c57"},{"name":"Get Trading Partner Information by Pulse ID","id":"91629cbf-e8ee-4af5-8424-e5c38e4b767f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dscsa.dev/directory/partner/pulse/example_id/info","urlObject":{"protocol":"https","path":["directory","partner","pulse","example_id","info"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"0e38f15c-3bff-4908-a895-a2d423e2b8f2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/directory/partner/pulse/example_id/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"dbaName\": \"Twin Pines Inc\",\n \"legalName\": \"Twin Pines\",\n \"isAuthorized\": true,\n \"isIdentityVerified\": true,\n \"status\": \"Verified\",\n \"type\": \"Dispenser\",\n \"addresses\": [\n {\n \"addressLine1\": \"1640 Riverside Drive\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Hill Valley\",\n \"country\": \"US\",\n \"zip\": \"91001\",\n \"state\": \"CA\",\n \"type\": \"Primary\"\n }\n ],\n \"licenses\": [\n {\n \"licenseNumber\": \"PHY 12345\",\n \"licensingAgency\": \"California State Board of Pharmacy\",\n \"licenseType\": \"Pharmacy\",\n \"legalNameOnLicense\": \"Twin Pines Inc\",\n \"issuedOn\": \"2023-01-01T00:00:00+00:00\",\n \"expiresOn\": \"2024-01-01T00:00:00+00:00\",\n \"isValid\": true,\n \"isVerified\": true,\n \"licenseStatus\": \"Active/Good Standing\"\n }\n ],\n \"contacts\": [\n {\n \"email\": \"twinpines@dscsa.dev\",\n \"phoneNumber\": {\n \"internationalCallingCode\": \"1\",\n \"number\": \"222-538-8873\",\n \"type\": \"Mobile\"\n },\n \"isPrimary\": false,\n \"legalName\": \"Martin McFly\",\n \"eprofileId\": \"Unknown\",\n \"type\": \"DSCSA Contact\",\n \"address\": {\n \"addressLine1\": \"1640 Riverside Drive\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Hill Valley\",\n \"country\": \"US\",\n \"zip\": \"91002\",\n \"state\": \"CA\"\n }\n }\n ],\n \"gln\": \"867653454060\"\n}"},{"id":"64e34aae-aa63-49e3-a6d2-6a9f4aac7141","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/directory/partner/pulse/example_id/info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Provided ID number could not be found in our records.\"\n}"}],"_postman_id":"91629cbf-e8ee-4af5-8424-e5c38e4b767f"},{"name":"Find Trading Partner Information by Multiple Predicates","id":"5d326f17-cf9b-486d-af16-70c9250b63f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"legalName\": \"Example Corp\",\n \"dbaName\": \"Example Corp DBA\",\n \"isAuthorized\": true,\n \"isIdentityVerified\": false,\n \"isClaimed\": true,\n \"tradingPartnerStatusTypeId\": 1,\n \"tradingPartnerTypeId\": 1,\n \"addressLine1\": \"1234 Main St\",\n \"addressLine2\": \"Apt 567\",\n \"addressCity\": \"Anytown\",\n \"addressStateId\": 32,\n \"addressPostalCode\": \"12345\",\n \"attributes\": [\n {\n \"attributeId\": 1,\n \"attributeValue\": \"123\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/pulse/info","urlObject":{"protocol":"https","path":["directory","partner","pulse","info"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"7902d02d-897d-468c-98f8-f810a476ee6c","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": \"Walgreens\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/pulse/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Successfully retrieved trading partners\",\n \"data\": [\n {\n \"id\": 9,\n \"legalName\": \"Walgreens Co.\",\n \"address\": \"Not Provided\"\n },\n {\n \"id\": 56,\n \"legalName\": \"Walgreens #4695\",\n \"address\": \"2045 Fieldstone Parkway, Franklin, TN, 37069, US\"\n }\n ]\n}"}],"_postman_id":"5d326f17-cf9b-486d-af16-70c9250b63f8"},{"name":"Edit DSCSA Contact","id":"bcb74e2d-e73b-4376-ae94-aecd0c903949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"address\": {\n \"addressLine1\": \"Placeholder\",\n \"addressLine2\": \"Placeholder\",\n \"addressLine3\": \"Placeholder\",\n \"city\": \"Placeholder\",\n \"countryId\": 230,\n \"stateId\": 1,\n \"zip\": \"Placeholder\"\n },\n \"email\": \"example@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa","description":"

Use the following endpoint to update the legal name, eProfile ID, address, email, or phone number of the primary DSCSA contact for a given trading partner.

\n","urlObject":{"protocol":"https","path":["directory","partner","example_id","contact","dscsa"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"3da13d0e-c8bc-4e89-9762-6448f41ae7aa","name":"All Address Fields","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"address\": {\n \"addressLine1\": \"Placeholder\",\n \"addressLine2\": \"Placeholder\",\n \"addressLine3\": \"Placeholder\",\n \"city\": \"Placeholder\",\n \"countryId\": 230,\n \"stateId\": 1,\n \"zip\": \"Placeholder\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Contact updated\"\n}"},{"id":"05c544fe-4bf9-4398-9815-03b1579d1f55","name":"All Email Fields","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"email\": \"example@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Contact updated\"\n}"},{"id":"15312c78-b1e9-4623-84b2-9e18c583d6ce","name":"All Phone Number Fields","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"phoneNumber\": {\n \"countryId\": 230,\n \"phoneNumber\": \"5555555555\",\n \"phoneNumberTypeId\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Contact updated\"\n}"},{"id":"477e0726-d06c-4b00-805e-cf8e2d2cd93a","name":"Legal Name","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"legalName\": \"Placeholder\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Contact updated\"\n}"},{"id":"503ef411-9cf7-430e-8dde-8dc9b065ef0a","name":"eProfile ID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"eprofileId\": \"Placeholder\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/directory/partner/example_id/contact/dscsa"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Contact updated\"\n}"}],"_postman_id":"bcb74e2d-e73b-4376-ae94-aecd0c903949"},{"name":"Get Trading Partners You Have Permissions For","id":"630eb1e9-f2c8-4edd-9844-f1209919d0ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dscsa.dev/directory/partner/mine","urlObject":{"protocol":"https","path":["directory","partner","mine"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"d67d8c16-c68e-45f7-9374-2549f4919018","name":"Get Trading Partners You Have Permissions For","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/directory/partner/mine"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trading partners retrieved\",\n \"tradingPartners\": [\n {\n \"tradingPartnerId\": 3,\n \"userRole\": \"Administrator\",\n \"userRoleId\": 1\n }\n ]\n}"}],"_postman_id":"630eb1e9-f2c8-4edd-9844-f1209919d0ca"}],"id":"cccab3d9-b677-4044-8593-32bac979be05","description":"

To obtain the information (including status) of a Trading Partner, utilize the following API endpoints.

\n","_postman_id":"cccab3d9-b677-4044-8593-32bac979be05"},{"name":"Product Tracing","item":[{"name":"Generate New Mock Request","id":"f1ae169a-31ec-49ea-832c-cdffc9f50b44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tradingPartnerId\": example_id\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/new","description":"

Begin by generating a mock Product Trace request to the trading partner of your choice.

\n

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","new"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"8ee56029-3804-4eb2-88af-92280a551c8a","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tradingPartnerId\": example_id\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/new"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace request created\",\n \"id\": 6\n}"}],"_postman_id":"f1ae169a-31ec-49ea-832c-cdffc9f50b44"},{"name":"Get All Trace Requests","id":"e69f1af8-530e-4b43-a210-6a68b556c457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dscsa.dev/trace/requests/all","description":"

Next, get all of the trace requests your user has rights to view.

\n

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","all"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"408f702b-4749-4c92-90b6-6a4ee71c5d02","name":"OK with Existing Product Trace Requests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"}],"url":"https://api.dscsa.dev/trace/requests/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace requests retrieved\",\n \"traceRequests\": [\n {\n \"tradingPartnerId\": 3,\n \"traceRequests\": [\n {\n \"id\": 21,\n \"traceResponses\": [],\n \"read\": true,\n \"archived\": true,\n \"productGtin\": \"00360505257898\",\n \"productNdcNumber\": \"60505-2578-9\",\n \"productLotNumber\": \"TF1438\",\n \"productSerialNumber\": \"16891328\",\n \"productExpirationDate\": \"2023-07-01T00:00:00+00:00\",\n \"traceRequestType\": \"Trace Request\",\n \"traceRequestReasonType\": \"Suspect Product\",\n \"traceRequestReasonDescription\": \"Ut enim ad minim veniam\",\n \"traceRequestStatusType\": \"Closed\",\n \"traceResponseRequestedType\": \"Transaction Information\",\n \"fullTraceRequested\": false,\n \"doFollowUp\": false,\n \"attestationAccepted\": true,\n \"createdAt\": \"2023-03-26T22:55:07.461079+00:00\",\n \"createdBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"updatedAt\": \"2023-03-26T22:55:07.461079+00:00\",\n \"updatedBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"regulatorContact\": {\n \"legalName\": \"Joe Foster\",\n \"organization\": \"New York State Board of Pharmacy\",\n \"address\": {\n \"addressLine1\": \"405 E 42nd St\",\n \"addressLine2\": null,\n \"addressLine3\": null,\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10017\"\n },\n \"email\": \"requestor@dscsa.dev\",\n \"phoneNumber\": {\n \"phoneNumber\": \"422-667-8257\",\n \"phoneNumberType\": \"Mobile\",\n \"country\": \"1\"\n }\n }\n },\n {\n \"id\": 56,\n \"traceResponses\": [\n {\n \"id\": 24,\n \"ownerFromName\": \"Sanofi\",\n \"ownerFromAddress\": \"Something USA\",\n \"createdAt\": \"2023-05-05T22:30:00.797637+00:00\",\n \"createdBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"productContainerQuantity\": \"1\",\n \"productContainerSize\": \"1\",\n \"productDescription\": \"LANTUS 1KIU/10ML INJ VL1 M36 US\",\n \"productDosageForm\": \"LIQUID\",\n \"productGtin\": \"300882220337\",\n \"productExpirationDate\": \"2023-01-31\",\n \"productLotNumber\": \"SA8171\",\n \"productNdcNumber\": \"0088-2220-33\",\n \"productSerialNumber\": \"21371W5HEHGT04\",\n \"productStrength\": \"1000IU/10ML\",\n \"comments\": \"None\",\n \"ownerToName\": \"AmerisourceBergen\",\n \"ownerToAddress\": \"Something USA\",\n \"traceRequestId\": 56,\n \"transactionDate\": \"2020-07-03T00:00:00+00:00\",\n \"transactionId\": \"PO-8238\",\n \"updatedAt\": \"2023-05-05T22:30:00.797637+00:00\",\n \"updatedBy\": \"auth0|6398eee39c43cd6f74e7a963\"\n },\n {\n \"id\": 25,\n \"ownerFromName\": \"AmerisourceBergen\",\n \"ownerFromAddress\": \"Something USA\",\n \"createdAt\": \"2023-05-05T22:30:00.809+00:00\",\n \"createdBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"productContainerQuantity\": \"1\",\n \"productContainerSize\": \"1\",\n \"productDescription\": \"LANTUS 1KIU/10ML INJ VL1 M36 US\",\n \"productDosageForm\": \"LIQUID\",\n \"productGtin\": \"300882220337\",\n \"productExpirationDate\": \"2023-01-31\",\n \"productLotNumber\": \"SA8171\",\n \"productNdcNumber\": \"0088-2220-33\",\n \"productSerialNumber\": \"21371W5HEHGT04\",\n \"productStrength\": \"1000IU/10ML\",\n \"comments\": \"None\",\n \"ownerToName\": \"Walgreens Co.\",\n \"ownerToAddress\": \"Something USA\",\n \"traceRequestId\": 56,\n \"transactionDate\": \"2020-07-10T00:00:00+00:00\",\n \"transactionId\": \"PO-3690\",\n \"updatedAt\": \"2023-05-05T22:30:00.809+00:00\",\n \"updatedBy\": \"auth0|6398eee39c43cd6f74e7a963\"\n }\n ],\n \"read\": true,\n \"archived\": true,\n \"productGtin\": \"00360505257898\",\n \"productNdcNumber\": \"60505-2578-9\",\n \"productLotNumber\": \"TF1438\",\n \"productSerialNumber\": \"16891328\",\n \"productExpirationDate\": \"2023-07-01T00:00:00+00:00\",\n \"traceRequestType\": \"Trace Request\",\n \"traceRequestReasonType\": \"Suspect Product\",\n \"traceRequestReasonDescription\": \"Sit amet, consectetur adipiscing elit\",\n \"traceRequestStatusType\": \"Closed\",\n \"traceResponseRequestedType\": \"Transaction Information\",\n \"fullTraceRequested\": false,\n \"doFollowUp\": false,\n \"attestationAccepted\": true,\n \"createdAt\": \"2023-05-05T22:00:25.140172+00:00\",\n \"createdBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"updatedAt\": \"2023-05-05T22:00:25.140172+00:00\",\n \"updatedBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"regulatorContact\": {\n \"legalName\": \"Joe Foster\",\n \"organization\": \"New York State Board of Pharmacy\",\n \"address\": {\n \"addressLine1\": \"405 E 42nd St\",\n \"addressLine2\": null,\n \"addressLine3\": null,\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10017\"\n },\n \"email\": \"requestor@dscsa.dev\",\n \"phoneNumber\": {\n \"phoneNumber\": \"422-667-8257\",\n \"phoneNumberType\": \"Mobile\",\n \"country\": \"1\"\n }\n }\n },\n {\n \"id\": 77,\n \"traceResponses\": [\n {\n \"id\": 45,\n \"ownerFromName\": \"GHI Distribution, Inc.\",\n \"ownerFromAddress\": \"987 Any Place, Somewhere, NY 10001\",\n \"createdAt\": \"2023-05-11T16:32:58.256282+00:00\",\n \"createdBy\": \"auth0|645a5ae31a82c05eefdf887c\",\n \"productContainerQuantity\": \"1\",\n \"productContainerSize\": \"1\",\n \"productDescription\": \"MOCK CAPSULES\",\n \"productDosageForm\": \"CAPSULES\",\n \"productGtin\": \"00300882220337\",\n \"productExpirationDate\": \"2023-07-01\",\n \"productLotNumber\": \"TF1438\",\n \"productNdcNumber\": \"60505-2578-9\",\n \"productSerialNumber\": \"168913000\",\n \"productStrength\": \"10 MG\",\n \"comments\": \"For this transaction GHI Distribution is in compliance with section 581(27)(A)-(G) of the Federal FDC&A\",\n \"ownerToName\": \"DEF Pharmacy Co.\",\n \"ownerToAddress\": \"456 Another Street, Elsewhere, NY 10001\",\n \"traceRequestId\": 77,\n \"transactionDate\": \"2020-02-03T00:00:00+00:00\",\n \"transactionId\": \"654654662-1\",\n \"updatedAt\": \"2023-05-11T16:32:58.256282+00:00\",\n \"updatedBy\": \"auth0|645a5ae31a82c05eefdf887c\"\n }\n ],\n \"read\": true,\n \"archived\": false,\n \"productGtin\": \"00300882220337\",\n \"productNdcNumber\": \"60505-2578-9\",\n \"productLotNumber\": \"TF1438\",\n \"productSerialNumber\": \"168913000\",\n \"productExpirationDate\": \"2023-07-01T00:00:00+00:00\",\n \"traceRequestType\": \"Trace Request\",\n \"traceRequestReasonType\": \"Suspect Product\",\n \"traceRequestReasonDescription\": \"Diverted product. \",\n \"traceRequestStatusType\": \"Closed\",\n \"traceResponseRequestedType\": \"Transaction Information\",\n \"fullTraceRequested\": false,\n \"doFollowUp\": false,\n \"attestationAccepted\": true,\n \"createdAt\": \"2023-05-11T16:26:33.115438+00:00\",\n \"createdBy\": \"auth0|644a990d5ef9b25191585b82\",\n \"updatedAt\": \"2023-05-11T16:26:33.115438+00:00\",\n \"updatedBy\": \"auth0|644a990d5ef9b25191585b82\",\n \"regulatorContact\": {\n \"legalName\": \"Joe Foster\",\n \"organization\": \"New York State Board of Pharmacy\",\n \"address\": {\n \"addressLine1\": \"405 E 42nd St\",\n \"addressLine2\": null,\n \"addressLine3\": null,\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10017\"\n },\n \"email\": \"requestor@dscsa.dev\",\n \"phoneNumber\": {\n \"phoneNumber\": \"422-667-8257\",\n \"phoneNumberType\": \"Mobile\",\n \"country\": \"1\"\n }\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"e69f1af8-530e-4b43-a210-6a68b556c457"},{"name":"Get All Trace Requests Filterable","id":"65d15ead-04d0-40f4-9c47-b54d82e034bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tradingPartnerIds\": [3],\n \"fromDate\": \"2023-07-01\",\n \"toDate\": \"2023-07-29\",\n \"excludeRead\": false,\n \"excludeArchived\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/all","description":"

Optionally you may POST to the same endpoint with the following filters to return a specific set of Product Trace requests and responses.

\n\n

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","all"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"8590594c-dcc6-42f0-ade3-1aeedded6bde","name":"OK with Existing Product Trace Requests","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tradingPartnerIds\": [3],\n \"fromDate\": \"2023-07-01\",\n \"toDate\": \"2023-07-29\",\n \"excludeRead\": false,\n \"excludeArchived\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace requests retrieved\",\n \"traceRequests\": [\n {\n \"tradingPartnerId\": 3,\n \"traceRequests\": [\n {\n \"id\": 277,\n \"traceResponses\": [],\n \"read\": false,\n \"archived\": false,\n \"productGtin\": \"00360505257898\",\n \"productNdcNumber\": \"60505-2578-9\",\n \"productLotNumber\": \"TF1438\",\n \"productSerialNumber\": \"16891329\",\n \"productExpirationDate\": \"2023-07-01T00:00:00+00:00\",\n \"traceRequestType\": \"Trace Request\",\n \"traceRequestReasonType\": \"Suspect Product\",\n \"traceRequestReasonDescription\": \"Quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat\",\n \"traceRequestStatusType\": \"Pending\",\n \"traceResponseRequestedType\": \"Transaction Information\",\n \"fullTraceRequested\": false,\n \"doFollowUp\": false,\n \"attestationAccepted\": true,\n \"createdAt\": \"2023-07-18T23:10:36.144727+00:00\",\n \"createdBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"updatedAt\": \"2023-07-18T23:10:36.144727+00:00\",\n \"updatedBy\": \"auth0|6398eee39c43cd6f74e7a963\",\n \"regulatorContact\": {\n \"legalName\": \"Joe Foster\",\n \"organization\": \"New York State Board of Pharmacy\",\n \"address\": {\n \"addressLine1\": \"405 E 42nd St\",\n \"addressLine2\": null,\n \"addressLine3\": null,\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10017\"\n },\n \"email\": \"requestor@dscsa.dev\",\n \"phoneNumber\": {\n \"phoneNumber\": \"422-667-8257\",\n \"phoneNumberType\": \"Mobile\",\n \"country\": \"1\"\n }\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"65d15ead-04d0-40f4-9c47-b54d82e034bb"},{"name":"Respond to a Trace Request","id":"d59aeea7-6abb-4582-b94a-8fd0380bfde2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 4,\n \"transactions\": [\n {\n \"comments\": \"None\",\n \"productDescription\": \"Aspirin 80mg\",\n \"productStrength\": \"80mg\",\n \"productDosageForm\": \"Tablet\",\n \"productNdcNumber\": \"012345-6789-12\",\n \"productSerialNumber\": \"001122AA345\",\n \"productLotNumber\": \"XXYZ789\",\n \"productExpirationDate\": \"2023-09-30\",\n \"productGtin\": \"01234567890128\",\n \"productContainerSize\": \"50 count\",\n \"productContainerQuantity\": 1,\n \"transactionId\": \"TR-001\",\n \"transactionDate\": \"2023-06-01\",\n \"ownerFromName\": \"Acme Pharmaceuticals\",\n \"ownerFromAddress\": \"1234 Main St, Anytown, USA\",\n \"ownerToName\": \"Baxter Healthcare\",\n \"ownerToAddress\": \"999 First Ave, Othertown, USA\"\n },\n {\n \"comments\": \"None\",\n \"productDescription\": \"Aspirin 80mg\",\n \"productStrength\": \"80mg\",\n \"productDosageForm\": \"Tablet\",\n \"productNdcNumber\": \"012345-6789-12\",\n \"productSerialNumber\": \"001122AA345\",\n \"productLotNumber\": \"XXYZ789\",\n \"productExpirationDate\": \"2023-09-30\",\n \"productGtin\": \"01234567890128\",\n \"productContainerSize\": \"50 count\",\n \"productContainerQuantity\": 1,\n \"transactionId\": \"TR-001\",\n \"transactionDate\": \"2023-06-01\",\n \"ownerFromName\": \"Acme Pharmaceuticals\",\n \"ownerFromAddress\": \"1234 Main St, Anytown, USA\",\n \"ownerToName\": \"Baxter Healthcare\",\n \"ownerToAddress\": \"999 First Ave, Othertown, USA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/responses/new","description":"

Finally, reply to the mock trace request.

\n

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","responses","new"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"4f809140-4bc4-42df-a943-c0ec0a0173ca","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer example_token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 4,\n \"transactions\": [\n {\n \"comments\": \"None\",\n \"productDescription\": \"Aspirin 80mg\",\n \"productStrength\": \"80mg\",\n \"productDosageForm\": \"Tablet\",\n \"productNdcNumber\": \"012345-6789-12\",\n \"productSerialNumber\": \"001122AA345\",\n \"productLotNumber\": \"XXYZ789\",\n \"productExpirationDate\": \"2023-09-30\",\n \"productGtin\": \"01234567890128\",\n \"productContainerSize\": \"50 count\",\n \"productContainerQuantity\": 1,\n \"transactionId\": \"TR-001\",\n \"transactionDate\": \"2023-06-01\",\n \"ownerFromName\": \"Acme Pharmaceuticals\",\n \"ownerFromAddress\": \"1234 Main St, Anytown, USA\",\n \"ownerToName\": \"Baxter Healthcare\",\n \"ownerToAddress\": \"999 First Ave, Othertown, USA\"\n },\n {\n \"comments\": \"None\",\n \"productDescription\": \"Aspirin 80mg\",\n \"productStrength\": \"80mg\",\n \"productDosageForm\": \"Tablet\",\n \"productNdcNumber\": \"012345-6789-12\",\n \"productSerialNumber\": \"001122AA345\",\n \"productLotNumber\": \"XXYZ789\",\n \"productExpirationDate\": \"2023-09-30\",\n \"productGtin\": \"01234567890128\",\n \"productContainerSize\": \"50 count\",\n \"productContainerQuantity\": 1,\n \"transactionId\": \"TR-001\",\n \"transactionDate\": \"2023-06-01\",\n \"ownerFromName\": \"Acme Pharmaceuticals\",\n \"ownerFromAddress\": \"1234 Main St, Anytown, USA\",\n \"ownerToName\": \"Baxter Healthcare\",\n \"ownerToAddress\": \"999 First Ave, Othertown, USA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/responses/new"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace responses created\",\n \"traceResponseIds\": [34567, 34568]\n}"}],"_postman_id":"d59aeea7-6abb-4582-b94a-8fd0380bfde2"},{"name":"Mark a Trace Request as \"read\"","id":"1693fd87-6f68-4169-b64a-a9ddcfb4d9b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/read","description":"

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","read"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"d99fd774-ad7e-4f86-8b7b-421f6731eb5b","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/read"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace request marked as read\"\n}"}],"_postman_id":"1693fd87-6f68-4169-b64a-a9ddcfb4d9b9"},{"name":"\"unread\" a Trace Request","id":"19f278a8-0783-4050-8a13-5a12ea3ce3f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/unread","description":"

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","unread"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"5b68769a-d4f9-4ec2-9909-4459fdcdb4ed","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/unread"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace request marked as unread\"\n}"}],"_postman_id":"19f278a8-0783-4050-8a13-5a12ea3ce3f2"},{"name":"Mark a Trace Request as \"archived\"","id":"18a69979-8c73-4e50-8f14-b31a428df40a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/archive","description":"

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","archive"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"c027fc15-5ef2-424a-a064-bf654ec76011","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/archive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace request archived\"\n}"}],"_postman_id":"18a69979-8c73-4e50-8f14-b31a428df40a"},{"name":"\"unarchive\" a Trace Request","id":"e2d2fd04-77f4-47f5-8158-5e2848986a05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"example_token"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/unarchive","description":"

Note: Error condition documentation coming soon. Any error will return a status code >= 400, a \"status\" of \"error\", and a \"message\" detailing what went wrong.

\n","urlObject":{"protocol":"https","path":["trace","requests","unarchive"],"host":["api","dscsa","dev"],"query":[],"variable":[]}},"response":[{"id":"b37866fe-f0ae-4cb3-94b1-963da24bed5c","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer example_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"traceRequestId\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dscsa.dev/trace/requests/unarchive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Trace request unarchived\"\n}"}],"_postman_id":"e2d2fd04-77f4-47f5-8158-5e2848986a05"}],"id":"1d7f6ee3-037d-46c3-a51b-dc0cefd2ebc7","description":"

In this section we will walk through generating a mock Product Trace request, viewing your Trace Requests, replying to a Trace Request, marking a Trace Request as \"read\", and marking a Trace Request as \"archived.\"

\n

Please note, the endpoints and business definitions of marking a Trace Request as \"read\" or \"archived\" will be changing signficantly in the near future.

\n","_postman_id":"1d7f6ee3-037d-46c3-a51b-dc0cefd2ebc7"}],"event":[{"listen":"prerequest","script":{"id":"f76b3b40-a5f5-4f0c-a35c-60b1bc784461","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cca017c7-b319-44db-80a2-3e7874997e9b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"username","value":"example@dscsa.dev","type":"string"},{"key":"password","value":"example_password","type":"string"},{"key":"license_number","value":"example_license","type":"string"},{"key":"access_token","value":"example_token"},{"key":"gln","value":"example_gln","type":"string"},{"key":"trading_partner_id","value":"example_id","type":"string"},{"key":"licensing_agency_id","value":"18","type":"string"},{"key":"license_type","value":"17","type":"string"}]}