Get Material Inventory Snapshot | Ply

Returns inventory data for a specific material at a specific location, optionally as of a point in time. If at is omitted, defaults to current server time.

Requires scope: inventory_history:read

Authentication

API_KEYstring

API Key authentication via header

Path parameters

locationIdUUIDRequired

Location ID.

materialDetailsIdUUIDRequired

Material details (variation) ID.

Query parameters

atdatetimeOptional

ISO 8601 timestamp to evaluate inventory at. Omit for current state. Example: 2026-03-01T00:00:00Z

Response

This endpoint returns an object.

materialDetailsIdUUID

ID of the material details (variation) record.

quantitydouble

On-hand quantity at the location as of the snapshot time.

materialobject

Reference to the material.

variationNamestring

Name of the material variation, if applicable.

costPerUnitdouble

Cost per unit of this material.

totalCostdouble

Total cost (quantity × costPerUnit) for this line.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"materialDetailsId": "b8c9d0e1-f2a3-4567-bcde-678901234567",
3	"quantity": 92,
4	"material": {
5	"id": "e5f6a7b8-c9d0-1234-efab-345678901234",
6	"name": "3/4 inch PVC Pipe (10ft)"
7	},
8	"variationName": null,
9	"costPerUnit": 4.85,
10	"totalCost": 446.2
11	}

$	curl -G https://api.getply.com/api/v1/inventory/history/locations/c3d4e5f6-a7b8-9012-cdef-123456789012/materials/b8c9d0e1-f2a3-4567-bcde-678901234567 \
>	-H "API_KEY: <apiKey>" \
>	--data-urlencode at=2026-03-01T00:00:00Z