TRtrykintsugi
Products

Get products

Changed on

Retrieve a paginated list of products based on filters and search query.

get/v1/products

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/products
  • Auth
    API key in header X-API-KEY

Query parameters

querystring nullable

Search term to filter products by name or other details.

status__instring nullable

Filter products by status (comma-separated)

product_category__instring nullable

Filter products by category (comma-separated)

product_subcategory__instring nullable

Filter products by subcategory (comma-separated)

source__instring nullable

Filter products by source (comma-separated)

connection_id__instring nullable

Filter products by connection ID (comma-separated). Use direct_api for products without a connection.

order_bystring nullable

Order results by specified fields (comma-separated)

pageinteger
sizeinteger

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved products

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Example response

{
  "items": [
    {
      "product_subcategory": "General Clothing"
    }
  ]
}

Changes

  • b00368d67377Revision changes
    • warning

      added the new SALEOR enum value to the // response property for the response status

  • cf78c16e3186Revision changes
    • warning

      added the new FRISBII_BILLING enum value to the // response property for the response status