API / Product
Use case / Master data sync

List Products

Changed on

List all products, archived ones included.

get/v1/products/product

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/products/product
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Query parameters

cursorstring nullable

Pagination cursor. Mutually exclusive with other query parameters

codestring nullable

Product code to match exactly.

code:instring nullable

Product codes to match. Comma-separated list.

product_type_idstring uuid nullable

Unique identifier of the product type the products belong to.

Response

Successful Response

next_cursorstring nullable

Example response

{
  "items": [
    {
      "code": "UN1090",
      "description": "Acetone, flammable liquid",
      "name": "Acetone",
      "product_type": {
        "name": "Chemicals",
        "code": "CHEM"
      },
      "parent_product": {
        "name": "Acetone",
        "code": "UN1090"
      }
    }
  ]
}

Changes