DIdistru
Product

Get a product

Changed on

Get a single product by ID. Unlike the list endpoint, the response always includes the product's bill_of_materials (or null if it has none).

Returns 404 if no product with that ID exists in your company, and 403 if the authenticated user cannot see it under their team restrictions.

Required permission: products_permissions_view.

get/public/v1/products/{id}

Request

  • Base URL
    https://app.distru.com
  • Auth
    HTTP bearer

Path parameters

idstring required

Product ID.

Query parameters

include_packages_with_active_quantity_by_locationboolean

When true, the product carries packages_with_active_quantity_by_location — its packages that hold active quantity, grouped by location (empty when the product is not package-tracked). Defaults to false, in which case the field is omitted.

include_batches_with_active_quantity_by_locationboolean

When true, the product carries batches_with_active_quantity_by_location — its batches that hold active quantity, grouped by location, each batch carrying its active quantity at that location (empty when the product is not batch-tracked). Defaults to false, in which case the field is omitted.

Response

A single product

Example response

{
  "data": {
    "batches_with_active_quantity_by_location": [
      {
        "location": {
          "address": "1234 Warehouse Street, Oakland, CA",
          "company_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "id": "02c88a3f-d759-4973-88f9-60049d682524",
          "license_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "name": "Warehouse 1"
        }
      }
    ],
    "brand": {
      "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
      "name": "Retailer 1"
    },
    "packages_with_active_quantity_by_location": [
      {
        "location": {
          "address": "1234 Warehouse Street, Oakland, CA",
          "company_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "id": "02c88a3f-d759-4973-88f9-60049d682524",
          "license_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "name": "Warehouse 1"
        }
      }
    ],
    "quantity_active_by_location": [
      {
        "location": {
          "address": "1234 Warehouse Street, Oakland, CA",
          "company_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "id": "02c88a3f-d759-4973-88f9-60049d682524",
          "license_id": "02c88a3f-d759-4973-88f9-60049d682524",
          "name": "Warehouse 1"
        }
      }
    ],
    "vendor": {
      "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
      "name": "Retailer 1"
    }
  }
}

Changes

  • e8b3a3d07ad5Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status