When to use the API
The PhyGrid API connects your own systems, such as a PIM, ERP, POS or e-commerce platform, to the products in the PhyGrid Console. It suits catalogues that change often, or that already live in another system. Products you send through the API appear in Content → Products and in every PhyGrid solution, just like products added by hand or from a Google feed.
The API documentation lists every endpoint with its fields and examples.
What you can do with it
- Import and update products: send products and their variants in batches, change only some fields of existing products, or delete products. Large batches are processed in the background, so changes can take a moment to appear
- Manage categories: create, update and delete categories in batches. The API calls them product types
- Keep stock in sync: update stock levels for many products and locations in one request, and reserve or release stock while an order is in progress
- Read the catalogue: list and search products, look up a product by barcode (EAN or UPC) or RFID tag, and get prices and stock for a variant
- Sync to your own systems: take a full snapshot of the catalogue, fetch only the changes since your last sync, or follow changes as they happen
- Build your own experiences: related, similar and trending products, product reviews and visual search, for apps and websites that use your PhyGrid catalogue
Choose your data region
Each tenant’s data is stored in one region. Use the API address for your tenant’s region:
- UAE: api.uae.phygrid.com
- EU (also UK): api.eu.phygrid.com
- India: api.in.phygrid.com
- US: api.us.phygrid.com
- Australia: api.au.phygrid.com
Every request needs an access token for your tenant. See the API documentation for how requests are authenticated.