API reference Stock Add stock keys

Add stock keys

POST methodhttps://api.anyshop.io/v1/products/{id}/stock_items

Duplicates within the upload and keys already in stock are left out and counted.

Scope stock:write
Idempotent with Idempotency-Key
403 store_suspended while suspended

Path parameters

idstring required

Body

application/json1 required, 0 optional

keysarray of strings requiredThe keys, one per item: 1 to 10,000, each up to 500 characters. They go into the stock of your API key's mode1 to 10,000 items

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_ or as_test_

curl -X POST \
  https://api.anyshop.io/v1/products/prod_01m3rr5kmbeb2s18x1kpntjxqb/stock_items \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "keys": [
      "TEST1-K2LM-3F9Q",
      "TEST2-P8WN-4H7R",
      "TEST2-P8WN-4H7R"
    ]
  }'

{
  "object": "stock_upload",
  "product": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
  "livemode": false,
  "submitted": 3,
  "added": 2,
  "repeated_in_upload": 1,
  "already_in_stock": 0
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The stock_upload object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After