Read products

GET /products

Read a list of products, including their details, with pagination, or a subset of products based on query parameters. Products may have different attributes such as name, description, price, and stock information. The endpoint supports various search criteria for filtering products based on specific attributes.

Headers

Query parameters

  • page integer(int)

    Specify the page number to fetch, defaults to 1.

  • limit integer(int)

    Specify the number of items to fetch per page, defaults to 25.

  • productSearch string

    Perform a search in productNumber, name, and supplier's productNumber and name. Wildcards are allowed using '%'. '%' at the end returns 'starts with'. '%' at the beginning returns 'ends with'. '%' at both ends returns 'contains'.

  • productNumber string

    Searches for product number.

Responses

  • • 200 application/json

    Success

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id number

      A unique identifier for the product within 24SevenOffice ERP-modules.

    • name string

      The name of the product.

      Maximum length is 150.

    • number string | null

      The alternative user-defined product number.

      Maximum length is 100.

    • type string

      Specifies whether the product is defined as a regular or structure product.

      Values are default or structure. Default value is default.

    • status string

      Specifies whether the product's status is active or inactive (expired).

      Values are active or inactive. Default value is active.

    • description string | null

      The description of the product.

      Maximum length is 500.

    • costPrice number | null

      The cost of buying the product from the supplier.

      Default value is 0.

    • salesPrice number | null

      The selling price of the product.

      Default value is 0.

    • indirectCost number | null

      The sum of indirect costs related to the product.

      Default value is 0.

    • stock object

      Stock information for the product.

      Hide stock attributes Show stock attributes
      • isManaged boolean

        A flag variable indicating whether a product should handle adjusting product quantity.

        Default value is false.

      • quantity number

        The quantity of products that are in stock.

        Default value is 0.

      • location string | null

        The location identifier for the product, like a shelf or a facility number for inventory management.

    • ean string | null

      The product's 13-digit European Article Number (EAN).

      Maximum length is 13.

    • eanAlternative string | null

      An alternative article number field, supporting up to 25 digits.

      Maximum length is 25.

    • units object

      Information about the units of measurement for the product.

      Hide units attributes Show units attributes
      • id number | null

        The ID of the units of measurement. Product units can be retrieved from the separate /productunits endpoint.

      • name string | null

        The name of the units of measurement.

      • symbol string | null

        The symbol of the units of measurement.

    • category object

      Information about the category to which the product belongs.

      Hide category attributes Show category attributes
      • id number

        A reference by ID to the category the product belongs to. Product categories can be retrieved from the separate /productcategories endpoint.

      • name string

        The category that the product belongs to.

    • supplier object

      Information about the supplier of the product.

      Hide supplier attributes Show supplier attributes
      • id number | null

        The ID of the supplier. Product suppliers can be retrieved from the separate /customers endpoint (suppliers are customers with a flag variable "isSupplier" set to "true").

      • name string | null

        The name of the supplier.

    • createdAt string

      A timestamp for when a record was created, in ISO 8601 format.

    • modifiedAt string

      A timestamp for when one of the properties of a record was last modified, in ISO 8601 format.
GET /products 
curl \
 -X GET https://rest.api.24sevenoffice.com/v1/products \
 -H "Authorization: string"
Response examples (200) 
# Headers
link: string
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
[
  {
    "id": 123,
    "name": "White shoe laces",
    "number": "SH-1234567",
    "type": "default",
    "status": "active",
    "description": "1 meter long shoe laces - white",
    "costPrice": 50,
    "salesPrice": 400,
    "indirectCost": 12.77,
    "stock": {
      "isManaged": true,
      "quantity": 146,
      "location": "A-313"
    },
    "ean": "0123456789000",
    "eanAlternative": "0123456789012345678901234",
    "units": {
      "id": 2,
      "name": "Metre",
      "symbol": "m"
    },
    "category": {
      "id": 12,
      "name": "Shoe accessories"
    },
    "supplier": {
      "id": 67890,
      "name": "XYZ Inc."
    },
    "createdAt": "2022-01-01 18:00:00.000Z",
    "modifiedAt": "2023-12-31 18:00:00.000Z"
  },
  {
    "id": 456,
    "name": "Black leather belt",
    "number": "BL-9876543",
    "type": "default",
    "status": "active",
    "description": "Genuine leather belt for men",
    "costPrice": 30,
    "salesPrice": 150,
    "indirectCost": 8.5,
    "stock": {
      "isManaged": true,
      "quantity": 82,
      "location": "B-105"
    },
    "ean": "0987654321000",
    "units": {
      "id": 13,
      "name": "Piece",
      "symbol": "pcs"
    },
    "category": {
      "id": 15,
      "name": "Fashion accessories"
    },
    "supplier": {
      "id": 54321,
      "name": "ABC Supplies"
    },
    "createdAt": "2022-02-15 12:00:00.000Z",
    "modifiedAt": "2023-11-30 15:30:00.000Z"
  },
  {
    "id": 789,
    "name": "Blue cotton t-shirt",
    "number": "TC-5678901",
    "type": "default",
    "status": "active",
    "description": "Comfortable round-neck t-shirt for casual wear",
    "costPrice": 15,
    "salesPrice": 35,
    "indirectCost": 5.25,
    "stock": {
      "isManaged": true,
      "quantity": 210,
      "location": "C-212"
    },
    "ean": "5678901234000",
    "units": {
      "id": 13,
      "name": "Piece",
      "symbol": "pcs"
    },
    "category": {
      "id": 18,
      "name": "Apparel"
    },
    "supplier": {
      "id": 12345,
      "name": "Fashion Hub"
    },
    "createdAt": "2022-03-20 09:30:00.000Z",
    "modifiedAt": "2023-10-25 10:45:00.000Z"
  }
]