[Beta – preprod] List products for a company

GET 
/companies/:companyID/products

[Beta – preprod] List products for a company

Request

Path Parameters

companyID uuidrequired

Query Parameters

available booleanrequired
page number

Default value: 1

limit number

Possible values: >= 1 and <= 100

Default value: 20

Responses

200

success - paginated list of products

application/json

Schema

Schema

data

object[]

required

Array [

id uuidrequired

referentialId uuidnullablerequired

name stringnullablerequired

Catalogue name, falling back to the referential name.

type stringnullablerequired

Possible values: [custom, referential]

Explicit product kind: 'custom' when a custom_product row references this entry, 'referential' when it points to a referential product. Derived from the data, not from the unreliable productSource column.

isActive booleanrequired

commercializationStatus stringnullablerequired

commercializationStart stringnullablerequired

commercializationEnd stringnullablerequired

]

pagination

object

required

page numberrequired

Current pagination page

limit numberrequired

Number of items per page

total numberrequired

Total number of matching items

totalPages numberrequired

Total number of pages

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "referentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "type": "custom",
      "isActive": true,
      "commercializationStatus": "string",
      "commercializationStart": "string",
      "commercializationEnd": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}

Loading...