{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","description":"You can connect your application with PriorNotify using our application programming interface (API).\n\nThis document explains how to interact with our API.\n\n## Quick Start\n\nOur API conforms to the design principles of the REST, or representational state transfer (REST), architectural style.\n\nIn order to use our API, you will first need to:\n\n- [Register or login to PriorNotify](https://login.priornotify.com/login)\n    \n- Generate an API Key on the [Account Settings](https://login.priornotify.com/status/me) page in the PriorNotify app\n    \n\n## Requirements\n\nTo interact with our API you must be using:\n\n- A valid and active account. This includes \"Free Trial\" acounts, but not accounts with failed payments or cancelled accounts.\n    \n- You may access our API only over HTTPS.\n    \n\n## Generating API Key\n\nOur API requires you to use an API key.\n\nYou can get your API key by following these steps:\n\n- [Login to PriorNotify](https://login.priornotify.com/login).\n    \n- Navigate to the [Account Settings](https://login.priornotify.com/status/) page and press the **Generate API Key** button.\n    \n- Enter your password as requested in our app, and then press the **Confirm** button.\n    \n\nYour API Key will be displayed only one time. You should store your API Key securely. Please do this now.\n\nWhen you close this API Key window, or move away from the page, your API Key will disappear and you will have to generate a new one.\n\n**PLEASE NOTE: You should generate a new API Key at least every 90 days.**\n\nWhen you generate a new API key, any prior API keys will be deleted, and will no longer be usable.\n\n## Authentication\n\nYour current and active API Key must be used to authenticate with our REST API endpoints.\n\nYou must use it for every request.\n\nAdd **Header Authorization as Key** and your **API Key as value**.\n\n## Multifactor Authentication\n\nThe FDA system requires multifactor authentication. The FDA system emails the security code to the customer's account of record.\n\nIn order to obtain the security code from the FDA system, an order must be submitted. The security code must be obtained from the customer's email, and then entered into a modal in our app.\n\nThis will start an authorized session during which time orders can be submitted.\n\n## Post/Response Formats\n\nYou can post to our API using JSON (JavaScript Object Notation) or CSV (Comma Separated Value) formats.\n\nResponses will be provided in JSON format.\n\nPosts with a message-body use plain JSON to set or update resource attributes.\n\nSuccessful requests will return a `200 OK` HTTP status.\n\nHere is some general information and requirements:\n\n- Dates format: `MM/DD/YYYY`\n    \n- Resource IDs are returned as integers.\n    \n- `Authorization` header is required\n    \n- Character encoding must be only in UTF-8 format\n    \n- Only Roman (English) characters are allowed\n    \n- JSONs must use only standard JSON data types: [https://www.w3schools.com/js/js_json_datatypes.asp](https://www.w3schools.com/js/js_json_datatypes.asp)\n    \n\n## Pagination\n\nRequests that return multiple items will be paginated to 10 items by default.\n\nThe items per page can be specified with the `?perPage` parameter:\n\n`GET /products?perPage=15`\n\nYou can specify further pages with the `?page` parameter:\n\n`GET /products?page=2`\n\nPage number is 1-based and omitting the `?page` parameter will return the first page.\n\nThe total number of resources, total pages, current page and per page value are always included in the HTTP body.\n\n## Field Validation\n\nOur API uses various fields of information that follow the USA FDA's requirements with respect to the values that are allowed in each field:\n\n#### Recipient\n\n| **Attribute** | **Type** | **Description** | **Required** |\n| --- | --- | --- | --- |\n| `firstName` | string | No more than 50 characters | `true` |\n| `lastName` | string | No more than 50 characters | `true` |\n| `email` | string | Valid email addresses only | `true` |\n| `address1` | string | No more than 100 characters | `true` |\n| `phone` | string | At least 7 and no more than 18 numbers, characters that are not numbers will be ignored |  |\n| `city` | string | No more than 100 characters | `true` |\n| `zipCode` | string | Numbers and dashes only, USA format of at least 5 but no more than 10 characters, `XXXXX` or `XXXXX-ZZZZ` | `true` |\n| `state` | string | Letters only, enter the full name of the Recipient's USA state or its 2-letter equivalent | `true` |\n| `address2` | string | No more than 100 characters |  |\n| `company` | string | At least 3 and not more than 100 characters |  |\n\n#### Order\n\n| **Attribute** | **Type** | **Description** | **Required** |\n| --- | --- | --- | --- |\n| `productName` | string | Must match exactly with an existing Product name in our app | `true` |\n| `quantityOrdered` | number | Numbers only, at least 1 but not more than 10 numbers | `true` |\n| `shipDate` | string | Date in format: `MM/DD/YYYY` | `true` |\n| `trackingNumber` | string | Valid tracking numbers only | `true` |\n| `recipient` | object | See Recipient | `true` |\n| `carrier` | object | See Carrier | `true` |\n\n#### **Carrier**\n\n| **Attribute** | **Type** | **Description** | **Required** |\n| --- | --- | --- | --- |\n| `name` | string | Must match exactly with an existing Carrier name in our app, enter \"**Federal Express (FedEx) - Air Transport**\", \"**United Parcel Service (UPS) - Air Transport**\", \"**DHL Express - Air Transport**\", \"**Regular Mail/Postal Service**\", or a different Carrier name that was added using the \"Add a Carrier\" button in our app | `true` |\n\n#### **Product**\n\n| **Attribute** | **Type** | **Description** | **Required** |\n| --- | --- | --- | --- |\n| `name` | string | No more than 100 characters | `true` |\n| `description` | string | Text without restrictions | `true` |\n| `weight` | number | Positive numbers which having precision 3 | `true` |\n| `unitOfWeight` | string | Allowed values - **Grams/Kilograms/Ounces/Pounds/Liters** | `true` |\n| `FDAProductCode` | number | Valid FDA Product Code. [Look Up FDA Product Code](https://www.accessdata.fda.gov/scripts/ora/pcb/index.cfm?action=main.pcb) | `true` |\n| `USACustomsCode` | string | String data type. Valid USA Customs Code in format `XXXX-YY-ZZ` or `XXXX-YY-ZZZZ`. [Look Up USA Customs Code](https://hts.usitc.gov/) |  |\n| `unitPriceInCents` | number | Unit price in **cents** |  |\n\nThe above requirements apply to both JSON and CSV formats.\n\nPosts of CSV files must follow our standard format.\n\nYou can get a sample CSV file in our standard format by pressing the **Upload Recipients** button in the [\"Recipients\" page](https://login.priornotify.com/recipients) in our app.\n\n## Errors\n\n| **Error Code** |  |\n| --- | --- |\n| 400 Bad Request | Invalid request, e.g. using an unsupported HTTP method |\n| 401 Unauthorized | Authentication error, e.g. incorrect API Key or Header |\n| 404 Not Found | Requests to resources that don't exist or are missing |\n| 500 Internal Server Error | Server error |\n\nErrors return both an appropriate HTTP status code and response object which contains `message` what is wrong.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2300461","team":25661,"collectionId":"a4166285-bd00-4d27-8625-5acc0663e2f1","publishedId":"2sA3XMkPwm","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2300461/2sA3XMkPwm","privateUrl":"https://go.postman.co/documentation/2300461-a4166285-bd00-4d27-8625-5acc0663e2f1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-06-12T10:20:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/3eed497f0d2b853a9d1a49933b8666e6c8d8b459bc0d25bad91970e3374bb86d","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3XMkPwm"}