### Get All Products Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a list of all available products. ```APIDOC ## GET /products ### Description Retrieves a list of all available products. ### Method GET ### Endpoint /products ### Parameters #### Query Parameters - **perPage** (integer) - Optional - The number of items to return per page (default: 10). - **page** (integer) - Optional - The page number to retrieve (1-based). ### Response #### Success Response (200) - **products** (array) - List of product objects. - **product_id** (integer) - The product's unique identifier. - **name** (string) - The name of the product. - **description** (string) - A description of the product. - **total_resources** (integer) - The total number of products available. - **total_pages** (integer) - The total number of pages. - **current_page** (integer) - The current page number. - **per_page** (integer) - The number of items per page. #### Response Example ```json { "products": [ { "product_id": 3001, "name": "Widget", "description": "A useful widget" }, { "product_id": 3002, "name": "Gadget", "description": "An electronic gadget" } ], "total_resources": 50, "total_pages": 5, "current_page": 1, "per_page": 10 } ``` ``` -------------------------------- ### Get Product by Identifier Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieve detailed information for a specific product using its unique identifier (ID). This is a GET request that requires the product ID in the URL path and an Authorization header containing your API key. ```bash curl --location 'https://portal.priornotify.com/products/5001' \ --header 'Authorization: your_api_key_here' ``` -------------------------------- ### GET /products Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieves all products with support for pagination. ```APIDOC ## GET /products ### Description Retrieves all products with support for pagination. ### Method GET ### Endpoint `/products` ### Parameters #### Headers - **Authorization** (string) - Required - API key for authentication. #### Query Parameters - **page** (integer) - Optional - The page number to retrieve (1-based). Defaults to 1. - **perPage** (integer) - Optional - The number of items per page. Defaults to 10. ### Request Example ```bash curl --location 'https://portal.priornotify.com/products?page=1&perPage=15' \ --header 'Authorization: your_api_key_here' ``` ### Response #### Success Response (200 OK) - **data** (object) - **products** (array of objects) - A list of product objects. - **id** (integer) - Unique identifier for the product. - **name** (string) - Name of the product. - **description** (string) - Description of the product. - **weight** (number) - Weight of the product. - **unitOfWeight** (string) - Unit of weight (e.g., Pounds, Kilograms). - **FDAProductCode** (integer) - FDA product code. - **USACustomsCode** (string) - USA Customs code. - **unitPriceInCents** (integer) - Price of the product in cents. - **createdAt** (string) - Timestamp when the product was created (ISO 8601 format). - **updatedAt** (string) - Timestamp when the product was last updated (ISO 8601 format). - **totalItems** (integer) - Total number of items available across all pages. - **totalPages** (integer) - Total number of pages. - **currentPage** (integer) - The current page number. - **perPage** (integer) - The number of items per page. #### Response Example ```json { "data": { "products": [ { "id": 5001, "name": "Organic Almonds", "description": "Raw organic almonds from California", "weight": 25, "unitOfWeight": "Pounds", "FDAProductCode": 96, "USACustomsCode": "0802-12-0000", "unitPriceInCents": 2500, "createdAt": "2024-11-15T10:30:00Z", "updatedAt": "2024-12-01T14:22:00Z" }, { "id": 5002, "name": "Olive Oil Extra Virgin", "description": "Cold-pressed extra virgin olive oil", "weight": 1, "unitOfWeight": "Liters", "FDAProductCode": 73, "USACustomsCode": "1509-10-0000", "unitPriceInCents": 1850, "createdAt": "2024-11-15T10:30:00Z", "updatedAt": "2024-11-20T09:00:00Z" } ], "totalItems": 45, "totalPages": 3, "currentPage": 1, "perPage": 15 } } ``` ``` -------------------------------- ### Get Product by Identifier Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a specific product using its unique identifier. ```APIDOC ## GET /products/{identifier} ### Description Retrieves a specific product using its unique identifier. ### Method GET ### Endpoint /products/{identifier} ### Parameters #### Path Parameters - **identifier** (integer) - Required - The unique identifier of the product. ### Response #### Success Response (200) - **product_id** (integer) - The product's unique identifier. - **name** (string) - The name of the product. - **description** (string) - A description of the product. #### Response Example ```json { "product_id": 3001, "name": "Widget", "description": "A useful widget" } ``` ``` -------------------------------- ### GET /products/{id} Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieves detailed information for a specific product by its unique identifier. ```APIDOC ## GET /products/{id} ### Description Retrieves detailed information for a specific product by its unique identifier. ### Method GET ### Endpoint `/products/{id}` ### Parameters #### Headers - **Authorization** (string) - Required - API key for authentication. #### Path Parameters - **id** (integer) - Required - The unique identifier of the product. ### Request Example ```bash curl --location 'https://portal.priornotify.com/products/5001' \ --header 'Authorization: your_api_key_here' ``` ### Response #### Success Response (200 OK) - **data** (object) - **id** (integer) - Unique identifier for the product. - **name** (string) - Name of the product. - **description** (string) - Description of the product. - **weight** (number) - Weight of the product. - **unitOfWeight** (string) - Unit of weight (e.g., Pounds, Kilograms). - **FDAProductCode** (integer) - FDA product code. - **USACustomsCode** (string) - USA Customs code. - **unitPriceInCents** (integer) - Price of the product in cents. - **createdAt** (string) - Timestamp when the product was created (ISO 8601 format). - **updatedAt** (string) - Timestamp when the product was last updated (ISO 8601 format). #### Response Example ```json { "data": { "id": 5001, "name": "Organic Almonds", "description": "Raw organic almonds from California", "weight": 25, "unitOfWeight": "Pounds", "FDAProductCode": 96, "USACustomsCode": "0802-12-0000", "unitPriceInCents": 2500, "createdAt": "2024-11-15T10:30:00Z", "updatedAt": "2024-12-01T14:22:00Z" } } ``` #### Error Response (404 Not Found) - **message** (string) - Description of the error. #### Error Example ```json { "message": "Product not found with identifier: 5001" } ``` ``` -------------------------------- ### Get All Products with Pagination Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieve a list of all products with support for pagination. You can specify the page number and the number of items per page using query parameters. The Authorization header with your API key is required. ```bash curl --location 'https://portal.priornotify.com/products?page=1&perPage=15' \ --header 'Authorization: your_api_key_here' ``` -------------------------------- ### Get All Orders/Notices (JSON) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a list of all orders or notices in JSON format. ```APIDOC ## GET /orders/notices (JSON) ### Description Retrieves a list of all orders or notices in JSON format. ### Method GET ### Endpoint /orders/notices ### Parameters #### Query Parameters - **perPage** (integer) - Optional - The number of items to return per page (default: 10). - **page** (integer) - Optional - The page number to retrieve (1-based). ### Response #### Success Response (200) - **orders** (array) - List of order/notice objects. - **total_resources** (integer) - The total number of orders/notices available. - **total_pages** (integer) - The total number of pages. - **current_page** (integer) - The current page number. - **per_page** (integer) - The number of items per page. #### Response Example ```json { "orders": [ { "order_id": 1001, "status": "Processing", "created_at": "01/15/2024" }, { "order_id": 1002, "status": "Shipped", "created_at": "01/14/2024" } ], "total_resources": 25, "total_pages": 3, "current_page": 1, "per_page": 10 } ``` ``` -------------------------------- ### Add/Update Product Packaging for Order (cURL) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index This cURL command demonstrates how to make a POST request to add or update product packaging for an order. It includes the necessary URL, authorization headers (implicitly via API Key in collection), and a JSON payload specifying the order's packaging details. The example shows setting a quantity and details for multiple packages. ```curl curl --location 'https://portal.priornotify.com/notices/4444/settings' \ --data '{ "name": "default_packages", "value": { "quantity":1, "packages": [{"type":"Bin","number":1},{"type":"","number":0},{"type":"","number":0},{"type":"","number":0},{"type":"","number":0}] } }' ``` -------------------------------- ### Get All Orders/Notices (CSV) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a list of all orders or notices in CSV format. ```APIDOC ## GET /orders/notices (CSV) ### Description Retrieves a list of all orders or notices in CSV format. ### Method GET ### Endpoint /orders/notices ### Parameters #### Query Parameters - **perPage** (integer) - Optional - The number of items to return per page (default: 10). - **page** (integer) - Optional - The page number to retrieve (1-based). ### Response #### Success Response (200) - **csv_data** (string) - The order/notice data in CSV format. #### Response Example ```csv OrderID,Status,CreatedAt 1001,Processing,01/15/2024 1002,Shipped,01/14/2024 ``` ``` -------------------------------- ### Handle API Errors: Not Found (404) Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Shows a 404 Not Found error, indicating that the requested resource does not exist. This example attempts to access a specific product by an identifier that is not present in the system. ```bash curl --location 'https://portal.priornotify.com/products/99999' \ --header 'Authorization: your_api_key_here' ``` -------------------------------- ### Get All Orders/Notices (JSON) using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieves all orders and notices in JSON format, supporting pagination with 'page' and 'perPage' parameters. Requires an API key for authentication. Returns a 200 OK response containing a list of notices and pagination details. ```bash # Parameters: ?page=&perPage= # Returns order details including submission status and FDA confirmation curl --location 'https://portal.priornotify.com/notices?page=1&perPage=20' \ --header 'Authorization: your_api_key_here' ``` -------------------------------- ### GET /notices/:noticeId/web-entry-document Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a notice's web-entry document in PDF format. Requires an API Key for authorization. ```APIDOC ## GET /notices/:noticeId/web-entry-document ### Description Request that returns notice's web-entry document in PDF format. ### Method GET ### Endpoint https://portal.priornotify.com/notices/:noticeId/web-entry-document ### Parameters #### Path Parameters - **noticeId** (string) - Required - The ID of the notice to retrieve the document for. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices/42395/web-entry-document' ``` ### Response #### Success Response (200) - **response.pdf** (file) - The web-entry document in PDF format. #### Response Example ``` response.pdf ``` ``` -------------------------------- ### Get Notice's Web Entry Document Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves the web entry document for a specific notice. ```APIDOC ## GET /notices/{notice_id}/web_entry_document ### Description Retrieves the web entry document for a specific notice. ### Method GET ### Endpoint /notices/{notice_id}/web_entry_document ### Parameters #### Path Parameters - **notice_id** (integer) - Required - The unique identifier of the notice. ### Response #### Success Response (200) - **document_url** (string) - URL to the web entry document. #### Response Example ```json { "document_url": "https://priornotify.com/documents/webentry/xyz123" } ``` ``` -------------------------------- ### GET /notices/:noticeId/pn-confirmation-document Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves a notice's confirmation document in PDF format. Requires an API Key for authorization. ```APIDOC ## GET /notices/:noticeId/pn-confirmation-document ### Description Request that returns notice's confirmation document in PDF format. ### Method GET ### Endpoint https://portal.priornotify.com/notices/:noticeId/pn-confirmation-document ### Parameters #### Path Parameters - **noticeId** (string) - Required - The ID of the notice to retrieve the document for. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices/42395/pn-confirmation-document' ``` ### Response #### Success Response (200) - **response.pdf** (file) - The confirmation document in PDF format. #### Response Example ``` response.pdf ``` ``` -------------------------------- ### Get All Orders/Notices (JSON) Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Retrieves a paginated list of all orders and notices in JSON format. This endpoint is useful for programmatic access and integration. ```APIDOC ## Get All Orders/Notices (JSON) ### Description Retrieve all orders and notices with pagination in JSON format. ### Method GET ### Endpoint `/notices` ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Defaults to 1. - **perPage** (integer) - Optional - The number of items to return per page. Defaults to 20. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices?page=1&perPage=20' \ --header 'Authorization: your_api_key_here' ``` ### Response #### Success Response (200) - **data** (object) - Contains the list of notices and pagination information. - **notices** (array) - A list of notice objects. - Each object contains: - **noticeId** (integer) - The unique identifier for the notice. - **orderId** (integer) - The identifier for the associated order. - **productName** (string) - The name of the product. - **quantityOrdered** (integer) - The quantity of the product ordered. - **shipDate** (string) - The date the order was shipped (MM/DD/YYYY format). - **trackingNumber** (string) - The shipping tracking number. - **carrierName** (string) - The name of the shipping carrier. - **submissionStatus** (string) - The submission status of the notice (e.g., "submitted", "pending"). - **fdaConfirmationNumber** (string) - The FDA confirmation number, if applicable. - **isActive** (boolean) - Indicates if the notice is active. - **recipient** (object) - Details of the recipient. - **firstName** (string) - Recipient's first name. - **lastName** (string) - Recipient's last name. - **company** (string) - Recipient's company name. - **city** (string) - Recipient's city. - **state** (string) - Recipient's state. - **totalItems** (integer) - The total number of notices available. - **totalPages** (integer) - The total number of pages. - **currentPage** (integer) - The current page number. - **perPage** (integer) - The number of items per page. #### Response Example ```json { "data": { "notices": [ { "noticeId": 42395, "orderId": 12345, "productName": "Organic Almonds", "quantityOrdered": 500, "shipDate": "12/15/2024", "trackingNumber": "1Z999AA10123456784", "carrierName": "United Parcel Service (UPS) - Air Transport", "submissionStatus": "submitted", "fdaConfirmationNumber": "PN-2024-123456", "isActive": true, "recipient": { "firstName": "John", "lastName": "Smith", "company": "Acme Foods Inc", "city": "Seattle", "state": "WA" } } ], "totalItems": 150, "totalPages": 8, "currentPage": 1, "perPage": 20 } } ``` ``` -------------------------------- ### Get Notice's Confirmation Document Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Retrieves the confirmation document for a specific notice. ```APIDOC ## GET /notices/{notice_id}/confirmation_document ### Description Retrieves the confirmation document for a specific notice. ### Method GET ### Endpoint /notices/{notice_id}/confirmation_document ### Parameters #### Path Parameters - **notice_id** (integer) - Required - The unique identifier of the notice. ### Response #### Success Response (200) - **document_url** (string) - URL to the confirmation document. #### Response Example ```json { "document_url": "https://priornotify.com/documents/confirmation/abc789" } ``` ``` -------------------------------- ### Get All Orders/Notices (CSV) using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Exports all orders and notices in CSV format, suitable for reporting and analysis. Requires an API key for authentication. Downloads the CSV data to a specified output file. Returns a 200 OK response with the CSV content. ```bash curl --location 'https://portal.priornotify.com/notices/csv' \ --header 'Authorization: your_api_key_here' \ --output orders_export.csv ``` -------------------------------- ### Get Notice's Web Entry Document Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Downloads the official FDA web entry document for a submitted notice in PDF format. This document is crucial for customs clearance and regulatory compliance. ```APIDOC ## Get Notice's Web Entry Document ### Description Download the FDA web entry document for a submitted notice in PDF format. ### Method GET ### Endpoint `/notices/{noticeId}/web-entry-document` ### Parameters #### Path Parameters - **noticeId** (integer) - Required - The identifier of the submitted notice for which to retrieve the document. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices/42395/web-entry-document' \ --header 'Authorization: your_api_key_here' \ --output notice_42395_web_entry.pdf ``` ### Response #### Success Response (200) - **Content-Type**: `application/pdf` - The response body contains the binary PDF data of the FDA web entry document. #### Use case Retrieve official FDA entry document for customs clearance. ``` -------------------------------- ### Get All Orders/Notices (CSV) Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Exports all orders and notices in CSV format, suitable for reporting and data analysis. This provides a tabular view of the data. ```APIDOC ## Get All Orders/Notices (CSV) ### Description Export all orders and notices in CSV format for reporting and analysis. ### Method GET ### Endpoint `/notices/csv` ### Parameters No specific query parameters are required for this endpoint, but an Authorization header is necessary. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices/csv' \ --header 'Authorization: your_api_key_here' \ --output orders_export.csv ``` ### Response #### Success Response (200) - The response will be a CSV file containing order and notice data. #### Response Example (CSV Content) ```csv noticeId,orderId,productName,quantityOrdered,shipDate,trackingNumber,carrierName,submissionStatus,fdaConfirmationNumber,recipientName,recipientCompany 42395,12345,Organic Almonds,500,12/15/2024,1Z999AA10123456784,United Parcel Service (UPS) - Air Transport,submitted,PN-2024-123456,John Smith,Acme Foods Inc 42396,12346,Olive Oil Extra Virgin,250,12/16/2024,794612345678,Federal Express (FedEx) - Air Transport,pending,,Jane Doe,Beta Imports LLC ``` ``` -------------------------------- ### Get Notice's Confirmation Document Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Downloads the PriorNotify confirmation document for a submitted notice in PDF format. This document serves as proof of submission and is useful for record-keeping. ```APIDOC ## Get Notice's Confirmation Document ### Description Download the PriorNotify confirmation document for a submitted notice in PDF format. ### Method GET ### Endpoint `/notices/{noticeId}/pn-confirmation-document` ### Parameters #### Path Parameters - **noticeId** (integer) - Required - The identifier of the submitted notice for which to retrieve the confirmation document. ### Request Example ```bash curl --location 'https://portal.priornotify.com/notices/42395/pn-confirmation-document' \ --header 'Authorization: your_api_key_here' \ --output notice_42395_confirmation.pdf ``` ### Response #### Success Response (200) - **Content-Type**: `application/pdf` - The response body contains the binary PDF data of the PriorNotify confirmation document. #### Use case Retrieve PriorNotify confirmation for record keeping and compliance audits. ``` -------------------------------- ### Create Products (CSV) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Allows the creation of new products using data in CSV format. ```APIDOC ## POST /products (CSV) ### Description Creates new products using data provided in CSV format. ### Method POST ### Endpoint /products ### Parameters #### Request Body - **csv_data** (string) - Required - The product data in CSV format. ### Request Example ``` "ProductID","Name","Description" "PROD001","Widget","A useful widget" "PROD002","Gadget","An electronic gadget" ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of product creation. - **product_ids** (array) - List of created product IDs. #### Response Example ```json { "message": "Products created successfully", "product_ids": [3001, 3002] } ``` ``` -------------------------------- ### Create Products via CSV Upload Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Upload product catalog entries using CSV format. This endpoint requires specific columns including name, description, weight, unit of weight, FDA Product Code, USA Customs Code, and unit price in cents. The API key must be included in the Authorization header and Content-Type set to text/csv. ```bash curl --location --request POST 'https://portal.priornotify.com/products/csv' \ --header 'Authorization: your_api_key_here' \ --header 'Content-Type: text/csv' \ --data 'name,description,weight,unitOfWeight,FDAProductCode,USACustomsCode,unitPriceInCents Organic Almonds,Raw organic almonds from California,25,Pounds,96,0802-12-0000,2500 Olive Oil Extra Virgin,Cold-pressed extra virgin olive oil,1,Liters,73,1509-10-0000,1850 Dark Chocolate Bars,70% cacao dark chocolate,100,Grams,17,1806-32-0000,450' ``` -------------------------------- ### Download Notice Web Entry Document using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Downloads the FDA web entry document for a specific submitted notice in PDF format. Requires the 'noticeId' and an API key. The downloaded file is saved locally. Returns a 200 OK response with PDF data. ```bash # noticeId: The identifier of the submitted notice # Returns: PDF document from FDA system curl --location 'https://portal.priornotify.com/notices/42395/web-entry-document' \ --header 'Authorization: your_api_key_here' \ --output notice_42395_web_entry.pdf ``` -------------------------------- ### Create Orders (JSON) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Allows the creation of new orders using data in JSON format. ```APIDOC ## POST /orders (JSON) ### Description Creates new orders using data provided in JSON format. ### Method POST ### Endpoint /orders ### Parameters #### Request Body - **orders** (array) - Required - An array of order objects. - **order_id** (string) - Required - The unique identifier for the order. - **product_id** (string) - Required - The identifier for the product. - **quantity** (integer) - Required - The quantity of the product ordered. ### Request Example ```json { "orders": [ { "order_id": "12345", "product_id": "ABC", "quantity": 2 }, { "order_id": "67890", "product_id": "XYZ", "quantity": 1 } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of order creation. - **order_ids** (array) - List of created order IDs. #### Response Example ```json { "message": "Orders created successfully", "order_ids": [1001, 1002] } ``` ``` -------------------------------- ### Bulk Update Products by Identifier Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Updates multiple existing products in bulk using their unique identifiers. ```APIDOC ## PUT /products/bulk ### Description Updates multiple existing products in bulk using their unique identifiers. ### Method PUT ### Endpoint /products/bulk ### Parameters #### Request Body - **products** (array) - Required - An array of product objects to update. - **product_id** (integer) - Required - The unique identifier of the product. - **name** (string) - Optional - The new name for the product. - **description** (string) - Optional - The new description for the product. ### Request Example ```json { "products": [ { "product_id": 3001, "name": "Super Widget", "description": "An improved widget" }, { "product_id": 3005, "description": "Updated description for gadget" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of bulk product update. - **updated_product_ids** (array) - List of product IDs that were updated. #### Response Example ```json { "message": "Products updated successfully", "updated_product_ids": [3001, 3005] } ``` ``` -------------------------------- ### Download Notice Confirmation Document using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Downloads the PriorNotify confirmation document for a specific submitted notice in PDF format. Requires the 'noticeId' and an API key. The downloaded file is saved locally. Returns a 200 OK response with PDF data. ```bash # noticeId: The identifier of the submitted notice # Returns: PriorNotify confirmation PDF with submission details curl --location 'https://portal.priornotify.com/notices/42395/pn-confirmation-document' \ --header 'Authorization: your_api_key_here' \ --output notice_42395_confirmation.pdf ``` -------------------------------- ### Create Orders (CSV) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Allows the creation of new orders using data in CSV format. ```APIDOC ## POST /orders (CSV) ### Description Creates new orders using data provided in CSV format. ### Method POST ### Endpoint /orders ### Parameters #### Request Body - **csv_data** (string) - Required - The order data in CSV format. ### Request Example ``` "OrderID","ProductID","Quantity" "12345","ABC","2" "67890","XYZ","1" ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of order creation. - **order_ids** (array) - List of created order IDs. #### Response Example ```json { "message": "Orders created successfully", "order_ids": [1001, 1002] } ``` ``` -------------------------------- ### Add/Update Product Packaging for Order (JSON) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Adds or updates product packaging information for a specific order in JSON format. ```APIDOC ## POST /orders/{order_id}/packaging ### Description Adds or updates product packaging information for a specific order. ### Method POST ### Endpoint /orders/{order_id}/packaging ### Parameters #### Path Parameters - **order_id** (integer) - Required - The unique identifier of the order. #### Request Body - **packaging_details** (object) - Required - Details of the product packaging. - **product_id** (integer) - Required - The identifier of the product. - **package_type** (string) - Required - The type of packaging (e.g., 'Box', 'Envelope'). - **tracking_number** (string) - Optional - The tracking number for the package. ### Request Example ```json { "packaging_details": { "product_id": 3001, "package_type": "Box", "tracking_number": "TRACK123XYZ" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of packaging update. - **order_id** (integer) - The order ID for which packaging was updated. #### Response Example ```json { "message": "Product packaging updated successfully for order 1001", "order_id": 1001 } ``` ``` -------------------------------- ### Add/Update Product Packaging for Order (JSON) Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index This POST request allows for the addition or update of product packaging details for a specific order. It requires an API Key for authorization and accepts a JSON body containing packaging information like quantity and types of packages. The request targets the settings endpoint for a given order ID. ```json { "name": "default_packages", "value": { "quantity":"quantity", "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"}] } } ``` -------------------------------- ### POST /notices/{noticeId}/settings Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Allows specifying the quantity and number of each packaging type for a given notice. ```APIDOC ## POST /notices/{noticeId}/settings ### Description Allows specifying the quantity and number of each packaging type for a given notice. ### Method POST ### Endpoint `/notices/{noticeId}/settings` ### Parameters #### Path Parameters - **noticeId** (integer) - Required - The identifier for the notice. #### Request Body - **name** (string) - Required - The name of the setting, typically "default_packages". - **value** (object) - Required - Contains packaging details. - **quantity** (integer) - Required - The total quantity. - **packages** (array) - Required - A list of package details. - **type** (string) - Optional - The type of package (e.g., "Bin", "Box"). - **number** (integer) - Required - The number of packages of the specified type. ### Request Example ```json { "name": "default_packages", "value": { "quantity": 1, "packages": [ {"type": "Bin", "number": 1}, {"type": "", "number": 0}, {"type": "", "number": 0}, {"type": "", "number": 0}, {"type": "", "number": 0} ] } } ``` ### Response #### Success Response (200) - **(No response body)** #### Response Example (No response body) ``` -------------------------------- ### Handle API Errors: Bad Request (400) Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Demonstrates a 400 Bad Request error, which occurs when the submitted data is invalid or missing required fields. This example shows a request for creating an order that lacks necessary details such as quantity, ship date, and tracking number. ```bash curl --location --request POST 'https://portal.priornotify.com/orders' \ --header 'Authorization: your_api_key_here' \ --header 'Content-Type: application/json' \ --data '{ "orders": [{"productName": "Test Product"}] }' ``` -------------------------------- ### POST /products/csv Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Uploads product catalog entries using CSV format. This is suitable for bulk product creation. ```APIDOC ## POST /products/csv ### Description Uploads product catalog entries using CSV format. This is suitable for bulk product creation. ### Method POST ### Endpoint `/products/csv` ### Parameters #### Headers - **Authorization** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Must be `text/csv`. #### Request Body - **CSV Data** (text/csv) - Required - CSV formatted data with columns: `name`, `description`, `weight`, `unitOfWeight`, `FDAProductCode`, `USACustomsCode`, `unitPriceInCents`. - `unitOfWeight`: Accepts `Grams`, `Kilograms`, `Ounces`, `Pounds`, `Liters`. - `FDAProductCode`: A valid FDA product code. - `USACustomsCode`: Format `XXXX-YY-ZZ` or `XXXX-YY-ZZZZ`. - `unitPriceInCents`: Price in cents (e.g., $10.50 is 1050). ### Request Example ```csv name,description,weight,unitOfWeight,FDAProductCode,USACustomsCode,unitPriceInCents Organic Almonds,Raw organic almonds from California,25,Pounds,96,0802-12-0000,2500 Olive Oil Extra Virgin,Cold-pressed extra virgin olive oil,1,Liters,73,1509-10-0000,1850 Dark Chocolate Bars,70% cacao dark chocolate,100,Grams,17,1806-32-0000,450 ``` ### Response #### Success Response (200 OK) - **data** (object) - **created** (integer) - Number of products successfully created. - **failed** (integer) - Number of products that failed to create. - **productIds** (array of integers) - List of IDs for the created products. #### Response Example ```json { "data": { "created": 3, "failed": 0, "productIds": [5001, 5002, 5003] } } ``` ``` -------------------------------- ### Update Product by ID using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Updates an existing product's details using its unique identifier. Requires an API key and sends product data in JSON format. Returns a 200 OK response with updated product details. ```bash curl --location --request PUT 'https://portal.priornotify.com/products/5001' \ --header 'Authorization: your_api_key_here' \ --header 'Content-Type: application/json' \ --data '{ "name": "Organic Almonds Premium", "description": "Premium raw organic almonds from California orchards", "weight": 25, "unitOfWeight": "Pounds", "FDAProductCode": 96, "USACustomsCode": "0802-12-0000", "unitPriceInCents": 2750 }' ``` -------------------------------- ### Bulk Update Products by IDs using cURL Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Updates multiple products simultaneously by providing a list of product IDs and their desired changes. Requires an API key and sends product updates in JSON format. Returns a 200 OK response indicating the number of updated and failed products. ```bash curl --location --request PUT 'https://portal.priornotify.com/products/bulk-update' \ --header 'Authorization: your_api_key_here' \ --header 'Content-Type: application/json' \ --data '{ "products": [ { "id": 5001, "unitPriceInCents": 2800 }, { "id": 5002, "unitPriceInCents": 1950, "description": "Premium cold-pressed extra virgin olive oil from Greece" }, { "id": 5003, "unitPriceInCents": 475 } ] }' ``` -------------------------------- ### Update Product by Identifier Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index Updates an existing product using its unique identifier. ```APIDOC ## PUT /products/{identifier} ### Description Updates an existing product using its unique identifier. ### Method PUT ### Endpoint /products/{identifier} ### Parameters #### Path Parameters - **identifier** (integer) - Required - The unique identifier of the product to update. #### Request Body - **name** (string) - Optional - The new name for the product. - **description** (string) - Optional - The new description for the product. ### Request Example ```json { "name": "Super Widget", "description": "An improved and super useful widget" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of product update. - **product_id** (integer) - The updated product's identifier. #### Response Example ```json { "message": "Product updated successfully", "product_id": 3001 } ``` ``` -------------------------------- ### POST /notices/{orderId}/settings - Add/Update Product Packaging for Order Source: https://documenter.getpostman.com/view/2300461/Uz5MFE8R/index This endpoint allows you to add or update the product packaging configuration for a specific order. It accepts a JSON payload containing packaging details. ```APIDOC ## POST /notices/{orderId}/settings ### Description This endpoint allows you to add or update the product packaging configuration for a specific order. It accepts a JSON payload containing packaging details. ### Method POST ### Endpoint https://portal.priornotify.com/notices/{orderId}/settings ### Parameters #### Path Parameters - **orderId** (string) - Required - The ID of the order for which to update packaging settings. #### Request Body - **name** (string) - Required - The name of the setting, expected to be "default_packages". - **value** (object) - Required - An object containing the packaging configuration. - **quantity** (integer) - Required - The quantity of packages. - **packages** (array) - Required - A list of package objects. - **type** (string) - Optional - The type of packaging. - **number** (integer) - Optional - The number or identifier for the packaging. ### Request Example ```json { "name": "default_packages", "value": { "quantity": 1, "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"} ] } } ``` ### Response #### Success Response (200) This request does not return a response body. #### Response Example (No response body) ``` -------------------------------- ### Authenticate API Requests Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Demonstrates how to authenticate API requests using an API key provided in the Authorization header. The API key must be generated from the Account Settings page and stored securely. Keys should be rotated every 90 days. ```bash curl --location 'https://portal.priornotify.com/products' \ --header 'Authorization: your_api_key_here' ``` -------------------------------- ### Update Product by Identifier Source: https://context7.com/context7/documenter_getpostman_view_2300461_uz5mfe8r/llms.txt Updates the details of an existing product using its unique identifier. This endpoint allows for modification of product name, description, weight, and pricing. ```APIDOC ## Update Product by Identifier ### Description Update an existing product's details by its ID. ### Method PUT ### Endpoint `/products/{productId}` ### Parameters #### Path Parameters - **productId** (integer) - Required - The unique identifier of the product to update. #### Request Body - **name** (string) - Optional - The updated name of the product. - **description** (string) - Optional - The updated description of the product. - **weight** (integer) - Optional - The updated weight of the product. - **unitOfWeight** (string) - Optional - The unit of measurement for the product's weight (e.g., Pounds, Kilograms). - **FDAProductCode** (integer) - Optional - The associated FDA product code. - **USACustomsCode** (string) - Optional - The associated USA customs code. - **unitPriceInCents** (integer) - Optional - The updated unit price in cents. ### Request Example ```json { "name": "Organic Almonds Premium", "description": "Premium raw organic almonds from California orchards", "weight": 25, "unitOfWeight": "Pounds", "FDAProductCode": 96, "USACustomsCode": "0802-12-0000", "unitPriceInCents": 2750 } ``` ### Response #### Success Response (200) - **data** (object) - Contains the updated product details. - **id** (integer) - The product identifier. - **name** (string) - The product name. - **description** (string) - The product description. - **weight** (integer) - The product weight. - **unitOfWeight** (string) - The unit of weight. - **FDAProductCode** (integer) - The FDA product code. - **USACustomsCode** (string) - The USA customs code. - **unitPriceInCents** (integer) - The unit price in cents. - **updatedAt** (string) - The timestamp when the product was last updated (ISO 8601 format). #### Response Example ```json { "data": { "id": 5001, "name": "Organic Almonds Premium", "description": "Premium raw organic almonds from California orchards", "weight": 25, "unitOfWeight": "Pounds", "FDAProductCode": 96, "USACustomsCode": "0802-12-0000", "unitPriceInCents": 2750, "updatedAt": "2024-12-14T09:15:00Z" } } ``` ```