{"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).

This document explains how to interact with our API.

Quick Start

Our API conforms to the design principles of the REST, or representational state transfer (REST), architectural style.

In order to use our API, you will first need to:

Register or login to PriorNotify
\n
Generate an API Key on the Account Settings page in the PriorNotify app
\n

Requirements

To interact with our API you must be using:

A valid and active account. This includes \"Free Trial\" acounts, but not accounts with failed payments or cancelled accounts.
\n
You may access our API only over HTTPS.
\n

Generating API Key

Our API requires you to use an API key.

You can get your API key by following these steps:

Login to PriorNotify.
\n
Navigate to the Account Settings page and press the Generate API Key button.
\n
Enter your password as requested in our app, and then press the Confirm button.
\n

Your API Key will be displayed only one time. You should store your API Key securely. Please do this now.

When 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.

PLEASE NOTE: You should generate a new API Key at least every 90 days.

When you generate a new API key, any prior API keys will be deleted, and will no longer be usable.

Authentication

Your current and active API Key must be used to authenticate with our REST API endpoints.

You must use it for every request.

Add Header Authorization as Key and your API Key as value.

Multifactor Authentication

The FDA system requires multifactor authentication. The FDA system emails the security code to the customer's account of record.

In 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.

This will start an authorized session during which time orders can be submitted.

Post/Response Formats

You can post to our API using JSON (JavaScript Object Notation) or CSV (Comma Separated Value) formats.

Responses will be provided in JSON format.

Posts with a message-body use plain JSON to set or update resource attributes.

Successful requests will return a 200 OK HTTP status.

Here is some general information and requirements:

Dates format: MM/DD/YYYY
\n
Resource IDs are returned as integers.
\n
Authorization header is required
\n
Character encoding must be only in UTF-8 format
\n
Only Roman (English) characters are allowed
\n
JSONs must use only standard JSON data types: https://www.w3schools.com/js/js_json_datatypes.asp
\n

Pagination

Requests that return multiple items will be paginated to 10 items by default.

The items per page can be specified with the ?perPage parameter:

GET /products?perPage=15

You can specify further pages with the ?page parameter:

GET /products?page=2

Page number is 1-based and omitting the ?page parameter will return the first page.

The total number of resources, total pages, current page and per page value are always included in the HTTP body.

Field Validation

Our API uses various fields of information that follow the USA FDA's requirements with respect to the values that are allowed in each field:

Recipient

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Type	Description	Required
`firstName`	string	No more than 50 characters	`true`
`lastName`	string	No more than 50 characters	`true`
`email`	string	Valid email addresses only	`true`
`address1`	string	No more than 100 characters	`true`
`phone`	string	At least 7 and no more than 18 numbers, characters that are not numbers will be ignored
`city`	string	No more than 100 characters	`true`
`zipCode`	string	Numbers and dashes only, USA format of at least 5 but no more than 10 characters, `XXXXX` or `XXXXX-ZZZZ`	`true`
`state`	string	Letters only, enter the full name of the Recipient's USA state or its 2-letter equivalent	`true`
`address2`	string	No more than 100 characters
`company`	string	At least 3 and not more than 100 characters

Order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Type	Description	Required
`productName`	string	Must match exactly with an existing Product name in our app	`true`
`quantityOrdered`	number	Numbers only, at least 1 but not more than 10 numbers	`true`
`shipDate`	string	Date in format: `MM/DD/YYYY`	`true`
`trackingNumber`	string	Valid tracking numbers only	`true`
`recipient`	object	See Recipient	`true`
`carrier`	object	See Carrier	`true`

Carrier

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description	Required
`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`

Product

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Type	Description	Required
`name`	string	No more than 100 characters	`true`
`description`	string	Text without restrictions	`true`
`weight`	number	Positive numbers which having precision 3	`true`
`unitOfWeight`	string	Allowed values - Grams/Kilograms/Ounces/Pounds/Liters	`true`
`FDAProductCode`	number	Valid FDA Product Code. Look Up FDA Product Code	`true`
`USACustomsCode`	string	String data type. Valid USA Customs Code in format `XXXX-YY-ZZ` or `XXXX-YY-ZZZZ`. Look Up USA Customs Code
`unitPriceInCents`	number	Unit price in cents

The above requirements apply to both JSON and CSV formats.

Posts of CSV files must follow our standard format.

You can get a sample CSV file in our standard format by pressing the Upload Recipients button in the \"Recipients\" page in our app.

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code
400 Bad Request	Invalid request, e.g. using an unsupported HTTP method
401 Unauthorized	Authentication error, e.g. incorrect API Key or Header
404 Not Found	Requests to resources that don't exist or are missing
500 Internal Server Error	Server error

Errors return both an appropriate HTTP status code and response object which contains message what is wrong.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2300461","collectionId":"a4166285-bd00-4d27-8625-5acc0663e2f1","publishedId":"2sA3XMkPwm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-12T10:20:10.000Z"},"item":[{"name":"Create Orders (CSV)","id":"979195ae-409d-4551-bc3f-db22654af92b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://portal.priornotify.com/notices/import-csv","description":"

This endpoint requires CSV files in a specific format with UTF-8 encoding, with Roman (English) characters only. The specific format for the CSV file is available for download inside our app, by pressing the \"Upload Orders\" button in this page: https://login.priornotify.com/prior-notices

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]},"isInherited":true,"source":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["notices","import-csv"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"6299558e-0d38-4d4d-affe-310103fe1c1b","name":"Import orders(CSV)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://portal.priornotify.com/notices/import-csv"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userId\": 1,\n \"recipient\": {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"12345678901\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\",\n \"userId\": 1\n },\n \"order\": {\n \"productName\": \"Milk\",\n \"quantityOrdered\": \"1\",\n \"shipDate\": \"3/22/2022\",\n \"trackingNumber\": \"33333\"\n },\n \"carrier\": {\n \"name\": \"Regular Mail/Postal Service\"\n }\n }\n ]\n}"}],"_postman_id":"979195ae-409d-4551-bc3f-db22654af92b"},{"name":"Create Orders (JSON)","id":"7fb527a2-b4be-4b75-b24c-c3b2394b1766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"recipient\": {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"phone\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n },\n \"order\": {\n \"productName\": \"productName\",\n \"quantityOrdered\": 1,\n \"shipDate\": \"MM/DD/YYYY\",\n \"trackingNumber\": \"trackingNumber\"\n },\n \"carrier\": {\n \"name\": \"Must Match Exactly\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/notices/import-json","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]},"isInherited":true,"source":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["notices","import-json"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"d4d9d938-eda2-47f5-9ada-a807ee152db9","name":"Import orders(JSON)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"recipient\": {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"phone\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n },\n \"order\": {\n \"productName\": \"productName\",\n \"quantityOrdered\": 1,\n \"shipDate\": \"MM/DD/YYYY\",\n \"trackingNumber\": \"trackingNumber\"\n },\n \"carrier\": {\n \"name\": \"Must Match Exactly\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/notices/import-json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userId\": 1,\n \"recipient\": {\n \"userId\": 1,\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"12345678901\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n },\n \"order\": {\n \"productName\": \"productName\",\n \"quantityOrdered\": \"1\",\n \"shipDate\": \"3/22/2022\",\n \"trackingNumber\": \"trackingNumber\"\n },\n \"carrier\": {\n \"name\": \"Must Match Exactly\"\n }\n }\n ]\n}"}],"_postman_id":"7fb527a2-b4be-4b75-b24c-c3b2394b1766"},{"name":"Bulk Submit Orders","id":"f2da79e4-4981-477a-a2fd-80dcb4db8e1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"recipient\": {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"phone\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n },\n \"order\": {\n \"productName\": \"productName\",\n \"quantityOrdered\": \"1\",\n \"shipDate\": \"MM/DD/YYYY\",\n \"trackingNumber\": \"trackingNumber\"\n },\n \"carrier\": {\n \"name\": \"Must Match Exactly\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/notices/bulk-submit","description":"

This route allows to bulk submit orders.

This endpoint requires CSV files in a specific format with UTF-8 encoding, and Roman (English) characters only. The specific format for the CSV file is available for download inside our app, by pressing the \"Upload Recipients\" button in
this page: https://login.priornotify.com/recipients

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]},"isInherited":true,"source":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["recipients","import-csv"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"9a152cf6-70c6-4b08-993e-4f3f685229ea","name":"Import recipients(CSV)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://portal.priornotify.com/recipients/import-csv"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userId\": 1,\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"12345678901\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\",\n \"id\": \"78b05c0a-2b52-40e1-ad79-4dd92b824e59\",\n \"createdAt\": \"2022-06-23T12:30:59.761Z\",\n \"updatedAt\": \"2022-06-23T12:30:59.761Z\"\n }\n ]\n}"},{"id":"7f5a0e8a-1934-42e7-8044-47ee70c1fefb","name":"Import recipients(CSV)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://portal.priornotify.com/recipients/import-csv"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"Api key is invalid"}],"_postman_id":"d7ed2297-36cc-4250-bfb2-4d1ac9e64632"},{"name":"Create Recipients (JSON)","id":"41f39701-2628-41b5-af72-addd48eba968","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"phone\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/recipients/import-json","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]},"isInherited":true,"source":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["recipients","import-json"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"5037d5d8-2717-49eb-a8cb-91db84b4bbcd","name":"Import recipients(JSON)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"phone\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/recipients/import-json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userId\": 1,\n \"firstName\": \"firstName\",\n \"email\": \"email\",\n \"lastName\": \"lastName\",\n \"address1\": \"address1\",\n \"phone\": \"12345678901\",\n \"city\": \"city\",\n \"zipCode\": \"zipCode\",\n \"state\": \"state\",\n \"address2\": \"address2\",\n \"company\": \"company\",\n \"id\": \"78b05c0a-2b52-40e1-ad79-4dd92b824e59\",\n \"createdAt\": \"2022-06-23T12:30:59.761Z\",\n \"updatedAt\": \"2022-06-23T12:30:59.761Z\"\n }\n ]\n}"}],"_postman_id":"41f39701-2628-41b5-af72-addd48eba968"},{"name":"Create Products (CSV)","id":"af2a79af-6edf-4c71-abd0-809f284ca3c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://portal.priornotify.com/products/import.csv","description":"

This endpoint requires CSV files in a specific format with UTF-8 encoding, and Roman (English) characters only. The specific format for the CSV file is available for download inside our app, by pressing the \"Upload Products\" button in this page: https://login.priornotify.com/products

This route allows to get all products from Account.

This route allows to get product by Identifier. Just input product Identifier to URL.
Identifier is Product Name or Product ID

\n","urlObject":{"protocol":"https","path":["products","productNameOrID"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"147b87eb-8867-49d1-8479-cb4cc0e2e9d5","name":"Get Product by Identifier","originalRequest":{"method":"GET","header":[],"url":"https://portal.priornotify.com/products/ProductNameOrID"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"name\": \"name1\",\n \"description\": \"description1\",\n \"weight\": 1.1,\n \"unitOfWeight\": \"unitOfWeight\",\n \"FDAProductCode\": \"FDAProductCode\",\n \"USACustomsCode\": \"USACustomsCode\",\n \"unitPriceInCents\": 100,\n \"defaultPackaging\": [\n {\n \"id\": 1,\n \"productId\": \"productId\",\n \"name\": \"default_packages\",\n \"value\": {\n \"quantity\":\"quantity\",\n \"packages\": [{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"}]\n }\n }\n ]\n }\n}"}],"_postman_id":"852aa122-e362-4410-a161-4781840ff6b0"},{"name":"Update Product by Identifier","id":"b3a20d96-8b1c-466e-86a5-fa8718e1ecea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product1\",\n \"description\": \"Description1\",\n \"weight\": 1.1,\n \"unitOfWeight\": \"Kilograms\",\n \"FDAProductCode\": \"32BDP01\",\n \"USACustomsCode\": \"2222.32.8822\",\n \"unitPriceInCents\": 999,\n \"packaging\": {\n \"name\": \"default_packages\",\n \"value\": {\n \"quantity\": 5,\n \"packages\": [\n {\n \"type\": \"Box\",\n \"number\": 5\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/products/productNameOrID","description":"

This route allows to update product by Identifier. Just input product Identifier to URL.
Identifier is Product Name or Product ID

The default Packaging is set by Quantity, because a different Quantity may require different Packaging. Therefore, in order to update the default packaging, you must pass the Quantity.

\n","urlObject":{"protocol":"https","path":["products","productNameOrID"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"d6a2287b-b6dd-4f02-b78c-3f3569df0c0b","name":"Update Product by Identifier","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"name1\",\n \"description\": \"description1\",\n \"weight\": 1.1,\n \"unitOfWeight\": \"unitOfWeight\",\n \"FDAProductCode\": \"FDAProductCode\",\n \"USACustomsCode\": \"USACustomsCode\",\n \"unitPriceInCents\": 100,\n \"packaging\": {\n \"name\": \"default_packages\",\n \"value\": {\n \"quantity\": \"quantity\",\n \"packages\": [\n {\n \"type\": \"packaging type\",\n \"number\": \"packaging number\"\n },\n {\n \"type\": \"packaging type\",\n \"number\": \"packaging number\"\n },\n {\n \"type\": \"packaging type\",\n \"number\": \"packaging number\"\n },\n {\n \"type\": \"packaging type\",\n \"number\": \"packaging number\"\n },\n {\n \"type\": \"packaging type\",\n \"number\": \"packaging number\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/products/productNameOrID"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"name\": \"name1\",\n \"description\": \"description1\",\n \"weight\": 1.1,\n \"unitOfWeight\": \"unitOfWeight\",\n \"FDAProductCode\": \"FDAProductCode\",\n \"USACustomsCode\": \"USACustomsCode\",\n \"unitPriceInCents\": 100,\n \"defaultPackaging\": [\n {\n \"id\": 1,\n \"productId\": \"productId\",\n \"name\": \"default_packages\",\n \"value\": {\n \"quantity\":\"quantity\",\n \"packages\": [{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"},{\"type\":\"packaging type\",\"number\":\"packaging number\"}]\n }\n }\n ]\n }\n}"}],"_postman_id":"b3a20d96-8b1c-466e-86a5-fa8718e1ecea"},{"name":"Bulk Update Products by Identifier","id":"e6b14c0c-520a-4aa4-9557-9252d01f288d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\n {\n \"identifier\": 1,\n \"name\": \"Product1\",\n \"description\": \"Description1\",\n \"weight\": 1.1,\n \"unitOfWeight\": \"Kilograms\",\n \"FDAProductCode\": \"32YDY99\",\n \"USACustomsCode\": \"1234.56.7890\",\n \"unitPriceInCents\": 999\n },\n {\n \"identifier\": \"Product2\",\n \"name\": \"Product2\",\n \"description\": \"Description2\",\n \"weight\": 1.999,\n \"unitOfWeight\": \"Grams\",\n \"FDAProductCode\": \"32YDY99\",\n \"USACustomsCode\": \"1023.45.67\",\n \"unitPriceInCents\": 1000\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://portal.priornotify.com/products/bulk-update","description":"

This route allows to bulk update products by Identifier. Just input product Identifier for each product.
Identifier is Product Name or Product ID

Filtering

Requests that return multiple items can be filtered by fields.
Notices that want to return can be specified with the parameter

Example:
https://portal.priornotify.com/notices/export-json?confirmationNumber=000000000000

Notice

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
start	`2023-01-01 00:00:00`
end	`2023-01-01 23:59:59`
product	`Apple`
recipient	`FirstName LastName`
confirmationNumber	`000000000000`
status	`received` `accepted` `ready_to_submit` `waiting_for_shipper` `completed` `cancelled`

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]},"isInherited":true,"source":{"_postman_id":"a4166285-bd00-4d27-8625-5acc0663e2f1","id":"a4166285-bd00-4d27-8625-5acc0663e2f1","name":"PriorNotify API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["notices","export-json"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"254ae783-7ba0-4602-b377-92e8830b6d2b","name":"Get All Notices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://portal.priornotify.com/notices/export-json?page=1&perPage=2","protocol":"https","host":["portal","priornotify","com"],"path":["notices","export-json"],"query":[{"key":"page","value":"1"},{"key":"perPage","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"notices\": [\n {\n \"id\": 1,\n \"name\": null,\n \"description\": null,\n \"status\": 1,\n \"webEntry\": null,\n \"userId\": 1,\n \"producer\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"noPackage\": null,\n \"unitsNumber\": null,\n \"entryType\": null,\n \"shipDate\": \"01/01/2023\",\n \"trackingNumber\": null,\n \"baseUnit\": null,\n \"packageTypes\": null,\n \"packageItems\": null,\n \"shipper\": null,\n \"freeze\": null,\n \"notified\": true,\n \"shipmentDateAddedAt\": null,\n \"activatedAt\": null,\n \"methodOfTransport\": \"methodOfTransport\",\n \"quantity\": 1,\n \"measure\": null,\n \"packages\": null,\n \"sources\": null,\n \"assortmentId\": null,\n \"submitterId\": null,\n \"isLocked\": false,\n \"pnDocumentPath\": null,\n \"paidAt\": null,\n \"facilitySetAt\": null,\n \"pnConfirmationNumber\": null,\n \"submittedAt\": null,\n \"airwayBill\": null,\n \"containerNumber\": null,\n \"billOfLading\": null,\n \"shippingSpeed\": null,\n \"webEntryDocumentPath\": \"webEntryDocumentPath\",\n \"productName\": \"productName\",\n \"recipientName\": \"recipientName\",\n \"deletable\": true,\n \"statusType\": \"received\",\n \"relatedCarrier\": null,\n \"relatedRecipient\": {\n \"id\": \"1\",\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"123456788901\",\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zipCode\": \"zipCode\",\n \"company\": \"company\",\n \"userId\": 1,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\"\n },\n \"relatedProduct\": {\n \"id\": 1,\n \"name\": \"nameOfProduct\",\n \"description\": \"description\",\n \"fdaProductCode\": \"fdaProductCode\",\n \"optionalProductId\": null,\n \"width\": null,\n \"height\": null,\n \"depth\": null,\n \"totalWeight\": 1,\n \"productWeight\": null,\n \"unitOfWeight\": \"unitOfWeight\",\n \"countryOfOrigin\": \"countryOfOrigin\",\n \"price\": \"0\",\n \"needPn\": true,\n \"unitOfMeasure\": null,\n \"producer\": 1,\n \"userId\": 1,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"merchant\": 1,\n \"shipper\": null,\n \"packAndShip\": 2,\n \"isBulkSold\": false,\n \"sources\": null,\n \"deletedAt\": null,\n \"wholesalePrice\": null,\n \"usaCustomsCode\": null,\n \"unitValue\": 0,\n \"shippingCost\": [],\n \"relatedProducer\": {\n \"id\": 1,\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"12345678909\",\n \"role\": 10,\n \"type\": 2,\n \"useAuthy\": 0,\n \"authyCode\": null,\n \"hash\": \"hash\",\n \"salt\": \"salt\",\n \"tempHash\": \"tempHash\",\n \"stripeCustomerId\": \"stripeCustomerId\",\n \"activated\": \"2023-01-01T00:00:00\",\n \"parent\": 1,\n \"country\": \"country\",\n \"company\": \"company\",\n \"companyType\": null,\n \"registrationNumber\": null,\n \"state\": \"state\",\n \"city\": \"city\",\n \"postalCode\": \"11111\",\n \"address\": \"11111\",\n \"pnsiUsername\": \"fdaUsername\",\n \"pnsiPassword\": \"fdaPassword\",\n \"stripeSubscriptionId\": null,\n \"stripeCardLast\": \"4242\",\n \"shopifyId\": null,\n \"mmUserId\": null,\n \"mmTeamId\": null,\n \"mmPersonalToken\": null,\n \"exemption\": \"2\",\n \"asAdmin\": null,\n \"pnCount\": 0,\n \"trialEnd\": null,\n \"cancelling\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"shopifyApiKey\": null,\n \"shopifyShopOrderHook\": null,\n \"stripeCard\": \"stripeCard\",\n \"address2\": \"address2\",\n \"shopifySecret\": null,\n \"shopifyName\": null,\n \"emailsNotice\": [],\n \"fdaPhoneNumber\": \"12345678901\",\n \"paymentFailedAt\": null,\n \"woocommerceConnection\": null,\n \"magentoConnection\": null,\n \"modalsStatuses\": {\n \"appPlusDetailsModal\": false\n },\n \"prestashopConnection\": null,\n \"secondPnsiUsername\": \"secondFdaUsername\",\n \"secondPnsiPassword\": \"secondFdaPassword\"\n },\n \"relatedMerchant\": {\n \"id\": 1,\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"12345678909\",\n \"role\": 10,\n \"type\": 1,\n \"useAuthy\": 0,\n \"authyCode\": null,\n \"hash\": \"hash\",\n \"salt\": \"salt\",\n \"tempHash\": \"tempHash\",\n \"stripeCustomerId\": \"stripeCustomerId\",\n \"activated\": \"2023-01-01T00:00:00\",\n \"parent\": 0,\n \"country\": \"country\",\n \"company\": \"company\",\n \"companyType\": null,\n \"registrationNumber\": null,\n \"state\": \"state\",\n \"city\": \"city\",\n \"postalCode\": \"11111\",\n \"address\": \"11111\",\n \"pnsiUsername\": \"fdaUsername\",\n \"pnsiPassword\": \"fdaPassword\",\n \"stripeSubscriptionId\": null,\n \"stripeCardLast\": \"1\",\n \"shopifyId\": null,\n \"mmUserId\": null,\n \"mmTeamId\": null,\n \"mmPersonalToken\": null,\n \"exemption\": \"1\",\n \"asAdmin\": null,\n \"pnCount\": 0,\n \"trialEnd\": \"2023-01-01T00:00:00\",\n \"cancelling\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"shopifyApiKey\": null,\n \"shopifyShopOrderHook\": null,\n \"stripeCard\": \"stripeCard\",\n \"address2\": null,\n \"shopifySecret\": null,\n \"shopifyName\": \"shopifyName\",\n \"emailsNotice\": [],\n \"fdaPhoneNumber\": \"123456789090\",\n \"paymentFailedAt\": null,\n \"woocommerceConnection\": null,\n \"magentoConnection\": null,\n \"modalsStatuses\": {\n \"appPlusDetailsModal\": false\n },\n \"prestashopConnection\": {\n \"host\": \"host\"\n },\n \"secondPnsiUsername\": \"secondFdaUsername\",\n \"secondPnsiPassword\": \"secondFdaPassword\"\n },\n \"relatedShipper\": null,\n \"isAssociatedWithPnPlus\": true\n },\n \"userToPay\": {\n \"id\": 8753,\n \"paymentFailedAt\": null,\n \"role\": 10,\n \"type\": 1\n },\n \"isValid\": {\n \"recipient\": true,\n \"product\": true\n }\n },\n {\n \"id\": 2,\n \"name\": null,\n \"description\": null,\n \"status\": 3,\n \"webEntry\": null,\n \"userId\": 2,\n \"producer\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"noPackage\": null,\n \"unitsNumber\": 1,\n \"entryType\": null,\n \"shipDate\": \"01/01/2023\",\n \"trackingNumber\": null,\n \"baseUnit\": null,\n \"packageTypes\": null,\n \"packageItems\": null,\n \"shipper\": null,\n \"freeze\": false,\n \"notified\": true,\n \"shipmentDateAddedAt\": \"2023-01-01T00:00:00\",\n \"activatedAt\": \"2023-01-01T00:00:00\",\n \"methodOfTransport\": \"methodOfTransport\",\n \"quantity\": 1,\n \"measure\": null,\n \"packages\": [\n {\n \"type\": \"Bag\",\n \"number\": 1\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n },\n {\n \"type\": \"\",\n \"number\": 0\n }\n ],\n \"sources\": null,\n \"assortmentId\": null,\n \"submitterId\": null,\n \"isLocked\": false,\n \"pnDocumentPath\": null,\n \"paidAt\": null,\n \"facilitySetAt\": null,\n \"pnConfirmationNumber\": null,\n \"submittedAt\": null,\n \"airwayBill\": null,\n \"containerNumber\": null,\n \"billOfLading\": null,\n \"shippingSpeed\": null,\n \"webEntryDocumentPath\": null,\n \"productName\": \"productName\",\n \"recipientName\": \"recipientName\",\n \"deletable\": true,\n \"statusType\": \"statusType\",\n \"relatedCarrier\": null,\n \"relatedRecipient\": {\n \"id\": \"2\",\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"1234567890\",\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zipCode\": \"zipCode\",\n \"company\": \"company\",\n \"userId\": 2,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\"\n },\n \"relatedProduct\": {\n \"id\": 2,\n \"name\": \"name\",\n \"description\": \"description\",\n \"fdaProductCode\": \"fdaProductCode\",\n \"optionalProductId\": \"optionalProductId\",\n \"width\": null,\n \"height\": null,\n \"depth\": null,\n \"totalWeight\": 1,\n \"productWeight\": null,\n \"unitOfWeight\": \"unitOfWeight\",\n \"countryOfOrigin\": \"countryOfOrigin\",\n \"price\": \"0\",\n \"needPn\": true,\n \"unitOfMeasure\": null,\n \"producer\": 2,\n \"userId\": 2,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"merchant\": 2,\n \"shipper\": 2,\n \"packAndShip\": 3,\n \"isBulkSold\": false,\n \"sources\": {\n \"woocommerce\": {\n \"id\": 2,\n \"host\": \"host\",\n \"consumerKey\": \"consumerKey\",\n \"consumerSecret\": \"consumerSecret\"\n }\n },\n \"deletedAt\": null,\n \"wholesalePrice\": null,\n \"usaCustomsCode\": null,\n \"unitValue\": 0,\n \"shippingCost\": [],\n \"relatedProducer\": {\n \"id\": 2,\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"12345678909\",\n \"role\": 10,\n \"type\": 2,\n \"useAuthy\": 0,\n \"authyCode\": null,\n \"hash\": \"hash\",\n \"salt\": \"salt\",\n \"tempHash\": \"tempHash\",\n \"stripeCustomerId\": \"stripeCustomerId\",\n \"activated\": \"2023-01-01T00:00:00\",\n \"parent\": 2,\n \"country\": \"country\",\n \"company\": \"company\",\n \"companyType\": null,\n \"registrationNumber\": null,\n \"state\": \"state\",\n \"city\": \"city\",\n \"postalCode\": \"11111\",\n \"address\": \"11111\",\n \"pnsiUsername\": \"fdaUsername\",\n \"pnsiPassword\": \"fdaPassword\",\n \"stripeSubscriptionId\": null,\n \"stripeCardLast\": \"stripeCardLast\",\n \"shopifyId\": null,\n \"mmUserId\": null,\n \"mmTeamId\": null,\n \"mmPersonalToken\": null,\n \"exemption\": \"2\",\n \"asAdmin\": null,\n \"pnCount\": 0,\n \"trialEnd\": null,\n \"cancelling\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"shopifyApiKey\": null,\n \"shopifyShopOrderHook\": null,\n \"stripeCard\": \"stripeCard\",\n \"address2\": \"11111\",\n \"shopifySecret\": null,\n \"shopifyName\": null,\n \"emailsNotice\": [],\n \"fdaPhoneNumber\": \"12345678909\",\n \"paymentFailedAt\": null,\n \"woocommerceConnection\": null,\n \"magentoConnection\": null,\n \"modalsStatuses\": {\n \"appPlusDetailsModal\": false\n },\n \"prestashopConnection\": null,\n \"secondPnsiUsername\": \"secondFdaUsername\",\n \"secondPnsiPassword\": \"secondFdaPassword\"\n },\n \"relatedMerchant\": {\n \"id\": 2,\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"12345678909\",\n \"role\": 10,\n \"type\": 1,\n \"useAuthy\": 0,\n \"authyCode\": null,\n \"hash\": \"hash\",\n \"salt\": \"salt\",\n \"tempHash\": \"tempHash\",\n \"stripeCustomerId\": \"stripeCustomerId\",\n \"activated\": \"2023-01-01T00:00:00\",\n \"parent\": 0,\n \"country\": \"country\",\n \"company\": \"company\",\n \"companyType\": null,\n \"registrationNumber\": null,\n \"state\": \"state\",\n \"city\": \"city\",\n \"postalCode\": \"11111\",\n \"address\": \"11111\",\n \"pnsiUsername\": \"fdaUsername\",\n \"pnsiPassword\": \"fdaPassword\",\n \"stripeSubscriptionId\": null,\n \"stripeCardLast\": \"4242\",\n \"shopifyId\": null,\n \"mmUserId\": null,\n \"mmTeamId\": null,\n \"mmPersonalToken\": null,\n \"exemption\": \"1\",\n \"asAdmin\": null,\n \"pnCount\": 0,\n \"trialEnd\": \"2023-01-01T00:00:00\",\n \"cancelling\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"shopifyApiKey\": null,\n \"shopifyShopOrderHook\": null,\n \"stripeCard\": \"stripeCard\",\n \"address2\": null,\n \"shopifySecret\": null,\n \"shopifyName\": \"shopifyName\",\n \"emailsNotice\": [],\n \"fdaPhoneNumber\": \"12345667890\",\n \"paymentFailedAt\": null,\n \"woocommerceConnection\": null,\n \"magentoConnection\": null,\n \"modalsStatuses\": {\n \"appPlusDetailsModal\": false\n },\n \"prestashopConnection\": {\n \"host\": \"host\"\n },\n \"secondPnsiUsername\": \"secondFdaUsername\",\n \"secondPnsiPassword\": \"secondFdaPassword\"\n },\n \"relatedShipper\": {\n \"id\": 2,\n \"email\": \"email\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"12345678909\",\n \"role\": 1,\n \"type\": 3,\n \"useAuthy\": 0,\n \"authyCode\": null,\n \"hash\": \"hash\",\n \"salt\": \"salt\",\n \"tempHash\": \"tempHash\",\n \"stripeCustomerId\": null,\n \"activated\": \"2023-01-01T00:00:00\",\n \"parent\": 2,\n \"country\": \"country\",\n \"company\": \"company\",\n \"companyType\": null,\n \"registrationNumber\": null,\n \"state\": \"state\",\n \"city\": \"city\",\n \"postalCode\": \"11111\",\n \"address\": \"1\",\n \"pnsiUsername\": null,\n \"pnsiPassword\": null,\n \"stripeSubscriptionId\": null,\n \"stripeCardLast\": null,\n \"shopifyId\": null,\n \"mmUserId\": null,\n \"mmTeamId\": null,\n \"mmPersonalToken\": null,\n \"exemption\": \"1\",\n \"asAdmin\": null,\n \"pnCount\": 0,\n \"trialEnd\": \"2023-01-01T00:00:00\",\n \"cancelling\": null,\n \"createdAt\": \"2023-01-01T00:00:00\",\n \"updatedAt\": \"2023-01-01T00:00:00\",\n \"shopifyApiKey\": null,\n \"shopifyShopOrderHook\": null,\n \"stripeCard\": null,\n \"address2\": \"1\",\n \"shopifySecret\": null,\n \"shopifyName\": null,\n \"emailsNotice\": [],\n \"fdaPhoneNumber\": \"12345678909\",\n \"paymentFailedAt\": null,\n \"woocommerceConnection\": null,\n \"magentoConnection\": null,\n \"modalsStatuses\": {\n \"appPlusDetailsModal\": false\n },\n \"prestashopConnection\": null,\n \"secondPnsiUsername\": \"secondFdaUsername\",\n \"secondPnsiPassword\": \"secondFdaPassword\"\n },\n \"isAssociatedWithPnPlus\": true\n },\n \"userToPay\": {\n \"id\": 8753,\n \"paymentFailedAt\": null,\n \"role\": 10,\n \"type\": 1\n },\n \"isValid\": {\n \"recipient\": true,\n \"product\": true\n }\n }\n ],\n \"count\": 28\n }\n}"}],"_postman_id":"93c4c1ba-b9ac-4a89-984b-03eae1b86336"},{"name":"Get All Orders/Notices (CSV)","id":"468edb04-1f09-4762-96e2-d8ba8adce6c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.priornotify.com/notices/export-json","description":"

Filtering

Requests that return multiple items can be filtered by fields.
Notices that want to return can be specified with the parameter

Example:
https://portal.priornotify.com/notices/export-csv?confirmationNumber=000000000000

Notice

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
start	`2023-01-01 00:00:00`
end	`2023-01-01 23:59:59`
product	`Apple`
recipient	`FirstName LastName`
confirmationNumber	`000000000000`
status	`received` `accepted` `ready_to_submit` `waiting_for_shipper` `completed` `cancelled`

Request that returns notice's web-entry document in PDF format.

Request that returns notice's confirmation document in PDF format.

Please refer to Step 3 in our User Interface.

The “First Layer” refers to the most exterior layer of the packaging used for the order.

The name used for the “Packaging Type” must be exactly the same as one of the options shown in Step 3 in our User Interface.

The number used for the “Number of Packaging” must be a natural number (greater than zero, no decimal numbers).

This route allows to submit order by Identifier. Just input order Identifier to URL.

\n","urlObject":{"protocol":"https","path":["notices","orderId","submit"],"host":["portal","priornotify","com"],"query":[],"variable":[]}},"response":[{"id":"7b151b68-3244-4afd-bbd3-8c9a9fb3ae71","name":"https://portal.priornotify.com//notices/noticeId/submit","originalRequest":{"method":"POST","header":[],"url":"https://portal.priornotify.com/notices/4444/submit"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"data\": [\n {\n \"noticeId\": 4444,\n \"isActive\": true\n }\n ]\n }\n}"}],"_postman_id":"d9c3df45-3454-4a07-ab28-ecddb967a0f3"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Here must be your generated API Key"}]}},"event":[{"listen":"prerequest","script":{"id":"72cb8499-38ae-43d0-a7f2-2a1f46670326","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"004fb170-2063-4176-8b1f-f39b6098ea47","type":"text/javascript","exec":[""]}}],"variable":[{"id":"3712e818-5b8c-49eb-8ce2-89f41ef17c3b","key":"auth_key","value":"Authorization"},{"id":"2178ab8a-89c6-493f-afcc-9d28e0a9cffa","key":"AuthHeader","value":"Here must be your generated API Key"}]}