# PSRESTful API Documentation

> PSRESTful is a RESTful JSON proxy layer on top of PromoStandards, the promotional products industry's open standards — providing modern REST endpoints, caching, simplified authentication, and extra APIs for product data, inventory, pricing, orders, and more.

## Getting Started

- [PSRESTful API Documentation](https://docs.psrestful.com): Welcome page with overview, basic flow diagram, and links to key resources
- [Why PSRESTful?](https://docs.psrestful.com/why-ps-restful): Discover why PSRESTful is the best way to integrate with PromoStandards — JSON responses, simplified authentication, caching, and modern REST API design
- [Authentication](https://docs.psrestful.com/authentication): Learn how to authenticate with PSRESTful API using API keys, Bearer tokens, or Basic Auth
- [Environments](https://docs.psrestful.com/environments): Understand how PSRESTful handles production and sandbox environments for supplier integrations
- [Rate Limits](https://docs.psrestful.com/rate-limits): How rate limits apply to the API to ensure fair usage and prevent abuse
- [Caching](https://docs.psrestful.com/caching): Learn how PSRESTful caches API responses with configurable timeouts by service type and how to bypass cache when needed
- [Compression](https://docs.psrestful.com/compression): Learn how PSRESTful supports HTTP compression with gzip, Brotli, and Zstandard to reduce bandwidth and speed up API responses
- [Roles & Permissions](https://docs.psrestful.com/roles): Understand the five user roles in PSRESTful and what each role can access
- [Protocol Buffers](https://docs.psrestful.com/protobuf): Learn how PSRESTful supports binary Protocol Buffer responses for faster parsing and smaller payloads on read-only endpoints

## PromoStandards Overview

- [PromoStandards Core Services Overview](https://docs.psrestful.com/promo-standards-core-services-overview): Summary of the most important PromoStandards services and how they fit together in a real distributor workflow
- [PromoStandards General Rollout Strategy for Distributors](https://docs.psrestful.com/promostandards-general-rollout-strategy-for-distributors): Recommended rollout strategy for distributors adopting PromoStandards services

## API Features

- [Credentials API](https://docs.psrestful.com/credentials-api): Manage supplier credentials for PromoStandards API access through PSRESTful's secure Credentials API
- [Sub-Accounts API](https://docs.psrestful.com/sub-accounts-api): Overview of Sub-Accounts API for managing sub-accounts
- [Extra APIs](https://docs.psrestful.com/extra-apis): Additional PSRESTful APIs for products, suppliers, brands, categories, inventory, and decorations beyond PromoStandards services
- [PSMEDx API](https://docs.psrestful.com/psmedx-api): Image processing and manipulation APIs for promotional products including background removal, decoration, color extraction, and vectorization
- [Design Decisions](https://docs.psrestful.com/design-decisions): Why PSRESTful uses a proxy layer architecture for PromoStandards, and how Extra APIs provide a more RESTful experience with caching

## Guides: Product Data

- [How to Get All Sellable Products](https://docs.psrestful.com/guides/product-data/how-to-get-all-sellable-products): Guide on using the API to get all sellable products from a supplier
- [How to Get Product Details](https://docs.psrestful.com/guides/product-data/how-to-get-product): Guide on using the API to get detailed product information
- [How to Get Products Modified Since a Date](https://docs.psrestful.com/guides/product-data/how-to-get-products-modified-since): Guide on fetching products that have been modified since a specific date
- [How to Get Closeout Products](https://docs.psrestful.com/guides/product-data/how-to-get-closeout-products): Guide on fetching closeout products from suppliers

## Guides: Media Content

- [How to Get Product Media Content](https://docs.psrestful.com/guides/media-content/how-to-get-product-media-content): Guide on fetching product media content (images, videos, documents)
- [How to Get Media Modified Since a Date](https://docs.psrestful.com/guides/media-content/how-to-get-media-modified-since): Guide on fetching media content modified since a specific date

## Guides: Pricing and Configuration

- [How to Get Configuration and Pricing](https://docs.psrestful.com/guides/ppc/how-to-get-pricing-and-configuration): Guide on fetching product configuration and pricing
- [How to Get FOB Points](https://docs.psrestful.com/guides/ppc/how-to-get-fob-points): Guide on fetching all FOB points for a product
- [How to Get All Available Locations](https://docs.psrestful.com/guides/ppc/how-to-get-all-available-locations): Guide on fetching available decoration locations for a product
- [How to Get All Available Charges](https://docs.psrestful.com/guides/ppc/how-to-get-all-available-charges): Guide on fetching available charges for a product
- [How to Get Decoration Colors](https://docs.psrestful.com/guides/ppc/how-to-get-decoration-colors): Guide on fetching decoration colors for a product

## Guides: Inventory

- [How to Get Inventory Levels](https://docs.psrestful.com/guides/inventory/how-to-get-inventory-levels): Guide on fetching inventory levels for a product
- [How to Get Filter Values](https://docs.psrestful.com/guides/inventory/how-to-filter-values): Guide on fetching filter values for inventory queries

## Guides: Purchase Orders

- [How to Place a Blank Order](https://docs.psrestful.com/guides/purchase-order/send-po/place-blank-order): Guide on placing a Purchase Order for blank goods
- [How to Place a Configured Order](https://docs.psrestful.com/guides/purchase-order/send-po/place-configured-order): Guide on placing a Purchase Order for a configured order
- [How to Place a Sample Order](https://docs.psrestful.com/guides/purchase-order/send-po/place-sample-order): Guide on placing a Purchase Order for a sample order

## Guides: Order Status

- [How to Get Order Status Types](https://docs.psrestful.com/guides/order-status/how-to-get-order-status-types): Guide on fetching order status types for a given supplier
- [How to Get Order Status Details](https://docs.psrestful.com/guides/order-status/how-to-get-order-status-details): Guide on fetching order status details for a given purchase order

## Guides: Order Shipment Notification

- [How to Get Order Shipment Notifications](https://docs.psrestful.com/guides/order-shipment-notification/how-to-get-order-shipment-notifications): Guide on fetching order shipment notifications for a given purchase order

## Guides: Invoice

- [How to Get Invoices](https://docs.psrestful.com/guides/invoice/how-to-get-invoices): Guide on fetching invoices for a given supplier

## PromoStandards Specifications

- [Standards Overview](https://docs.psrestful.com/standards/overview): Overview of all PromoStandards services and their versions
- [Product Data 1.0.0](https://docs.psrestful.com/standards/product-data-1.0.0): PromoStandards Product Data Service version 1.0.0 specification
- [Product Data 2.0.0](https://docs.psrestful.com/standards/product-data-2.0.0): PromoStandards Product Data Service version 2.0.0 specification
- [Media Content 1.1.0](https://docs.psrestful.com/standards/media-content-1.1.0): PromoStandards Media Content Service version 1.1.0 specification
- [PPC 1.0.0](https://docs.psrestful.com/standards/ppc-1.0.0): PromoStandards Promotional Products Configuration, Decoration, and Pricing Service version 1.0.0 specification
- [Inventory 1.2.1](https://docs.psrestful.com/standards/inventory-1.2.1): PromoStandards Inventory Service version 1.2.1 specification
- [Inventory 2.0.0](https://docs.psrestful.com/standards/inventory-2.0.0): PromoStandards Inventory Service version 2.0.0 specification
- [Product Compliance 1.0.0](https://docs.psrestful.com/standards/product-compliance-1.0.0): PromoStandards Product Compliance Service version 1.0.0 specification
- [Purchase Order 1.0.0](https://docs.psrestful.com/standards/purchase-order-1.0.0): PromoStandards Purchase Order Service version 1.0.0 specification
- [Order Status 1.0.0](https://docs.psrestful.com/standards/order-status-1.0.0): PromoStandards Order Status Service version 1.0.0 specification
- [Order Status 2.0.0](https://docs.psrestful.com/standards/order-status-2.0.0): PromoStandards Order Status Service version 2.0.0 specification
- [Order Shipment Notification 1.0.0](https://docs.psrestful.com/standards/order-shipment-notification-1.0.0): PromoStandards Order Shipment Notification Service version 1.0.0 specification
- [Order Shipment Notification 2.0.0](https://docs.psrestful.com/standards/order-shipment-notification-2.0.0): PromoStandards Order Shipment Notification Service version 2.0.0 specification
- [Invoice 1.0.0](https://docs.psrestful.com/standards/invoice-1.0.0): PromoStandards Invoice Service version 1.0.0 specification
- [Service Codes](https://docs.psrestful.com/standards/service-codes): PromoStandards Web Service Codes — critical for making correct requests to PromoStandards services
- [Standardized Codes](https://docs.psrestful.com/standards/standardized-codes): PromoStandards Promotional Products Services standardized error codes summarized per service

## Optional

- [Guides Index](https://docs.psrestful.com/guides): Index of all step-by-step guides for using the PSRESTful API
- [Standards Index](https://docs.psrestful.com/standards): Index of all PromoStandards service documentation
- [API Reference (External)](https://api.psrestful.com/docs): Interactive Swagger API documentation for PSRESTful