01Läs lagersaldo
GET /api/public/v1/stock kräver api:read. En återförsäljare läser egna rader på aktiva platser som inte har dolts. Ett varumärke läser egna produkter hos aktivt anslutna återförsäljare. Använd limit och cursor som i övriga listor.
curl "https://api.test.stockisto.com/api/public/v1/stock?limit=200" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
200-svaret innehåller data och nextCursor. Varje rad har bland annat stockId, locationId, skuId, status, quantity, evidence, lastVerifiedAt och lastVerifiedAtLabel. Prisets aktualitet anges separat med priceUpdatedAt.
02Uppdatera en rad
PATCH /api/public/v1/stock/{stockId} kräver återförsäljarens nyckel med api:write. Sätt STOCK_ID till en rad från lagerläsningen. Utelämnade fält och null lämnar värdet oförändrat; v1 kan inte tömma ett värde. 200-svaret innehåller den uppdaterade raden.
curl -X PATCH "https://api.test.stockisto.com/api/public/v1/stock/$STOCK_ID" \
-H "Authorization: Bearer $STOCKISTO_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "inStock", "quantity": 4 }'
| Fält | Värde |
|---|---|
status | inStock, lowStock, outOfStock, carriesTheLine, orderable |
quantity | Antal enheter, 0 eller fler. |
isOnDisplayInShowroom | true eller false. |
retailPrice, priceCurrency | Ert pris och dess valuta. |
promoText | En kort erbjudandetext. |
03Uppdatera flera rader
POST /api/public/v1/stock:batch tar 1 till 500 rader med locationId och skuId. Ersätt LOCATION_ID och SKU_ID med era värden. En ny rad kräver status och en produkt från en ansluten leverantör. Sätt BATCH_KEY till ett unikt värde för denna omgång.
curl -X POST "https://api.test.stockisto.com/api/public/v1/stock:batch" \
-H "Authorization: Bearer $STOCKISTO_API_KEY" \
-H "Idempotency-Key: $BATCH_KEY" \
-H "Content-Type: application/json" \
-d '{ "rows": [ { "locationId": "LOCATION_ID", "skuId": "SKU_ID", "status": "inStock" } ] }'
200-svaret innehåller results, created, updated och failed. Varje resultat anger index, locationId, skuId, action, stockId och error. Åtgärderna är created, updated eller failed. Kontrollera varje rad även vid HTTP 200.
04Skicka igen utan dubbla ändringar
Batchanrop tar Idempotency-Key. Samma nyckel och innehåll inom 24 timmar ger första svaret igen med Idempotency-Replay: true. Ändrat innehåll med samma nyckel ger 409. PATCH sätter angivna värden igen och sparar inget idempotenssvar.
05Vad en skrivning ändrar
En status- eller mängdobservation stämplar API-källan och observationstiden. Enbart prisändringar behåller lagrets ålder. Lyckade skrivningar ger stock.updated-webhooks. Ett varumärke kan inte skriva återförsäljarens lager: PATCH ger 404; batchrader misslyckas.
| Felkod | Betydelse |
|---|---|
invalid_status | Använd ett av de fem statusvärdena. |
negative_quantity, negative_price | Använd ett tal som är 0 eller större. |
invalid_price, invalid_currency | Använd ett pris under 100 000 000 och en valuta som stöds. |
location_not_found, sku_not_available | Använd en egen plats och en produkt ni får uppdatera. |
status_required_for_create | Ange status för en ny rad. |
duplicate_row_in_batch | Skicka varje kombination av plats och produkt en gång. |
retailer_key_required_for_stock_write | Använd återförsäljarens nyckel. |