DIdistru
Batch

Get a batch

Changed on

Fetch one batch by its Distru batch ID, including its cost and on-hand quantity totals, custom field values, primary test result, and (when your company has bin tracking enabled) its bins. Returns 404 if no batch with that id exists in your company, and 403 if the authenticated user cannot access it under their team restrictions.

Required permission: products_permissions_view.

get/public/v1/batches/{id}

Request

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

Path parameters

idstring required

The Distru batch ID to fetch.

Response

A single batch

Example response

{
  "data": {
    "product": {
      "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"
      }
    },
    "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"
        }
      }
    ]
  }
}

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

    • info

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