Get Material Availability

GET

/api/v1/materials/:materialId/availability

GET

/api/v1/materials/:materialId/availability

$ curl https://api.getply.com/api/v1/materials/e5f6a7b8-c9d0-1234-efab-345678901234/availability \
>      -H "API_KEY: <apiKey>"

1 {
2   "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
3   "name": "3/4 inch PVC Pipe (10ft)",
4   "inventory": [
5     {
6       "location": {
7         "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
8         "name": "Main Warehouse",
9         "type": "WAREHOUSE",
10         "integrationId": "WH-001"
11       },
12       "quantity": 120,
13       "criticalAmount": 10,
14       "lowAmount": 25
15     }
16   ],
17   "totalQuantity": 120,
18   "integrationId": "ST-998877",
19   "qboId": "1042",
20   "itemNumber": "PVC-34-10",
21   "description": "Schedule 40 PVC pipe for plumbing applications.",
22   "costForBusiness": 28.5,
23   "costForClient": 38
24 }

Returns a single material by ID together with its on-hand inventory aggregated per location, plus the total quantity across those locations. Job-site locations are excluded.

Requires scope: materials:read

Authentication

API_KEYstring

API Key authentication via header

Path parameters

materialIdUUIDRequired

Material ID.

Response

This endpoint returns an object.

idUUID

Unique identifier for the material.

namestring

Display name of the material.

inventorylist of objects

On-hand inventory broken down by location. Job-site locations are excluded; locations holding no stock for this material are omitted.

totalQuantitydouble

Total quantity of the material on hand across all returned locations.

integrationIdstring

The material’s identifier in the connected field service management (FSM) system, when the material is linked to one. Null if the material has no FSM integration link.

qboIdstring

The material’s QuickBooks Online (QBO) item id, when linked to QBO.

itemNumberstring

Item/SKU number for the material.

descriptionstring

Detailed description of the material.

costForBusinessdouble

Internal business cost price in USD.

costForClientdouble

Client-facing cost price in USD.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error