Admin API Reference

This is the API reference for get an overview about grid-products.

Postman Collection

For easy configuration and testing, here's a Postman collection you can import into Postman.

Configuration Notes:

Before making API requests, update the following placeholders and headers to match your setup:

1. URL Placeholders: Replace <tenant-id>, <environment>, and <space-id> with your specific tenant, environment, and space values.
2. Data Residency: Replace <data-residency> with one of these options: eu, us, in, au, or uae.
3. Headers: Please change the <accessToken> in the (Product) x-api-key or (Space) Authorization value with your generated access token in grid console.

Authentication

To use the Grid Products API, every request requires an access token. Here's how to generate one:

1. Go to the Apps → Developer tab in the Phygrid Console.
2. Generate an Access Token.
3. Add Authorization in the API request header, with the Bearer <access token> as value for the Spaces related endpoints below

URLs Overview

Grid Admin API: https://api.omborigrid.com/api

In every endpoint you will need to replace {base-url} with the URL specified above.

Space Overview

GET Space Overview

Returns overview information of tenant's products int the space.

GET {base-url}/admin/overview/{spaceId}

Query Parameters

To use query parameters, add them as GET properties to the URL.

Response

{
  "data": {
    "productsCount": 123,
    "variantsCount": 123,
    "productsMissingPricesCount": 123,
    "productsMissingQuantityCount": 123,
    "productsMissingCatalogCount": 123,
    "totalProductsQuantity": 123,
    "productStatus": [
      {
        "status": "<status>",
        "count": 123
      }
    ]
  }
}