GOgolocad
Inventory Product

GET /openapi/{version}/products/inventory/

Retrieve inventory products with filtering, pagination, and search. Example:

curl --location '{{url}}/openapi/v2/products/inventory?search=Wax' \
--header 'Authorization: Bearer {{token}}'

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

versionstring required

Query parameters

is_activeboolean

Filter by active status. Example: ?is_active=true returns only active products; ?is_active=false returns inactive products.

limitinteger

Number of results to return per page (default: 20, max: 5000)

offsetinteger

The initial index from which to return the results (default: 0)

searchstring

Search products by name or SKU.

skuunknown

Filter by one or more SKUs (comma-separated). Please note if 1 of the sku is not found than the api call will not result in any error and result data will simply not contain that sku

Response

Successful retrieval of a list of inventory products, filtered by the search criteria.

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.