Developer
HomeGet startedAPI docs
Support
Log in
Sign up

Fetch inventory balance

You can retrieve balance for an entire STORE inventory or for specific products within that inventory.

Prerequisites

Fetch inventory balance for all stores

When fetching inventory balance for all stores, the balance data can be big. If the response includes the Link header, that means the response contains more than one page.
To fetch the subsequent pages to get a complete inventory balance data for all stores, you need to call the URL that is specified in the Link header until the response does not include that header.
  1. Send a request to start fetching inventory balance for all stores. Check whether the response includes the Link header.
    1
    GET /stock
    Example: The following example response includes the Link header. That means you need to fetch the subsequent pages to get a complete inventory balance data for all stores, as there is more than one page for inventory balance for all stores.
    Response header
    LINK: <https://inventory.izettle.com/v3/stock?cursor=81f69e53-e25a-11ec-bb66-2bc1878b8583&limit=100>; rel="next"
    Response body
    1
    [
    2
           {
    3
             "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    4
             "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
    5
             "productUuid": "b9675342-5ce0-11ec-bf63-0242ac130002",
    6
             "variantUuid": "d3b93e04-5ce0-11ec-bf63-0242ac130002",
    7
             "balance": 42,
    8
             "lowStockLevel": 7,
    9
             "lowStockAlert": true,
    10
             "updated": "2021-01-01T00:00:00.000Z",
    11
             "checksum": "3770345797"
    12
           },
    13
           ...
    14
           {
    15
             "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    16
             "inventoryUuid": "8c92da3c-2de9-11ed-ba03-2f8a52174076",
    17
             "productUuid": "24977020-5ce1-11ec-bf63-0242ac130002",
    18
             "variantUuid": "f5c98ab2-5ce0-11ec-bf63-0242ac130002",
    19
             "balance": 1337,
    20
             "lowStockLevel": 7,
    21
             "lowStockAlert": true,
    22
             "updated": "2021-01-01T00:00:00.000Z",
    23
             "checksum": "3364489309"
    24
           }
    25
         ]
  2. If the previous response includes the Link header, send a request to the URL in the Link header.
    1
    GET https://inventory.izettle.com/v3/stock?cursor=59d2f586-b99b-11ec-908d-71b78005c93b&limit=100
  3. Repeat step 2 until the response does not include the Link header. That means inventory balance for all stores are fetched.

Fetch inventory balance of a STORE inventory

When fetching inventory balance of a STORE inventory, you fetch the total stock of all product variants in that inventory.
  1. Send a request to start fetching inventory balance. Check whether the response includes the Link header.
    1
    GET /stock/{inventoryUuid}
    Example: This call retrieves stock for the inventoryUuid 6e5e8d52-5ce0-11ec-bf63-0242ac130002.
    Request
    1
    GET /stock/6e5e8d52-5ce0-11ec-bf63-0242ac130002
    Response header
    LINK: <https://inventory.izettle.com/v3/stock/fd4a39a0-e2ef-11e6-ba64-85247ae2a737?cursor=81f69e53-e25a-11ec-bb66-2bc1878b8583&limit=100>; rel="next"
    Response body
    1
    [
    2
      {
    3
        "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    4
        "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
    5
        "productUuid": "b9675342-5ce0-11ec-bf63-0242ac130002",
    6
        "variantUuid": "d3b93e04-5ce0-11ec-bf63-0242ac130002",
    7
        "balance": 42,
    8
        "lowStockLevel": 7,
    9
        "lowStockAlert": true,
    10
        "updated": "2021-01-01T00:00:00.000Z",
    11
        "checksum": "3770345797"
    12
      },
    13
      ...
    14
      {
    15
        "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    16
        "inventoryUuid": "8c92da3c-2de9-11ed-ba03-2f8a52174076",
    17
        "productUuid": "24977020-5ce1-11ec-bf63-0242ac130002",
    18
        "variantUuid": "f5c98ab2-5ce0-11ec-bf63-0242ac130002",
    19
        "balance": 1337,
    20
        "lowStockLevel": 7,
    21
        "lowStockAlert": true,
    22
        "updated": "2021-01-01T00:00:00.000Z",
    23
        "checksum": "3364489309"
    24
      }
    25
    ]
  2. If the previous response includes the Link header, send a request to the URL in the header.
    1
    GET <https://inventory.izettle.com/v3/stock/fd4a39a0-e2ef-11e6-ba64-85247ae2a737?cursor=81f69e53-e25a-11ec-bb66-2bc1878b8583&limit=100
  3. Repeat step 2 until the response does not include the Link header. That means all the inventory balance is fetched.

Fetch balances of a few products in an inventory

If you want to fetch balances of a few products instead of all products in a STORE inventory, specify UUIDs of those products and separate them with a comma in the request body.
1
POST /stock/{inventoryUuid}/products
1
["{productUuid}", "{productUuid}"]
Example: This example retrieves the balances for products b9675342-5ce0-11ec-bf63-0242ac130002and 24977020-5ce1-11ec-bf63-0242ac130002 in the inventory 6e5e8d52-5ce0-11ec-bf63-0242ac130002.
Request
1
POST /stock/6e5e8d52-5ce0-11ec-bf63-0242ac130002/products
Request body
1
["b9675342-5ce0-11ec-bf63-0242ac130002", "24977020-5ce1-11ec-bf63-0242ac130002"]
Response
1
[
2
    {
3
        "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
        "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
5
        "productUuid": "b9675342-5ce0-11ec-bf63-0242ac130002",
6
        "variantUuid": "d3b93e04-5ce0-11ec-bf63-0242ac130002",
7
        "balance": 42,
8
        "lowStockLevel": 7,
9
        "lowStockAlert": true,
10
        "updated": "2021-01-01T00:00:00.000Z",
11
        "checksum": "3770345797"
12
    },
13
    {
14
        "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
15
        "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
16
        "productUuid": "24977020-5ce1-11ec-bf63-0242ac130002",
17
        "variantUuid": "f5c98ab2-5ce0-11ec-bf63-0242ac130002",
18
        "balance": 123,
19
        "lowStockLevel": 7,
20
        "lowStockAlert": true,
21
        "updated": "2021-01-01T00:00:00.000Z",
22
        "checksum": "3364489309"
23
    }
24
]

Fetch inventory balance of a product in a STORE inventory

This request returns inventory balance of a specific product in a STORE inventory.
1
GET /stock/{inventoryUuid}/products/{productUuid}
Example: This call fetches balance of the product with productUuid as b9675342-5ce0-11ec-bf63-0242ac130002 in an inventory with inventoryUuid as 6e5e8d52-5ce0-11ec-bf63-0242ac130002.
Request
1
GET /stock/6e5e8d52-5ce0-11ec-bf63-0242ac130002/products/b9675342-5ce0-11ec-bf63-0242ac130002
Response
1
[
2
    {
3
        "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
        "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
5
        "productUuid": "b9675342-5ce0-11ec-bf63-0242ac130002",
6
        "variantUuid": "d3b93e04-5ce0-11ec-bf63-0242ac130002",
7
        "balance": 42,
8
        "lowStockLevel": 7,
9
        "lowStockAlert": true,
10
        "updated": "2021-01-01T00:00:00.000Z",
11
        "checksum": "3770345797"
12
    }
13
]

Fetch updates to inventory balances for all stores

By specifying a timestamp in the request, you can fetch balance updates that are made since the time for all STORE inventories. Balances with timestamps newer than or equal to the provided timestamp will be returned.
1
GET /stock/updates/?ts={date-time}
Example: Fetch balance updates of all STORE inventories since 1 January, 2021.
Request
1
GET /stock/updates/?ts=2022-01-01T00:00:00.00
Response
1
[
2
  {
3
    "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
    "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
5
    "productUuid": "b9675342-5ce0-11ec-bf63-0242ac130002",
6
    "variantUuid": "d3b93e04-5ce0-11ec-bf63-0242ac130002",
7
    "balance": 42,
8
    "lowStockLevel": 7,
9
    "lowStockAlert": true,
10
    "updated": "2021-09-28T00:00:00.000Z",
11
    "checksum": "3770345797"
12
  },
13
  ...
14
  {
15
    "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
16
    "inventoryUuid": "6e5e8d52-5ce0-11ec-bf63-0242ac130002",
17
    "productUuid": "24977020-5ce1-11ec-bf63-0242ac130002",
18
    "variantUuid": "f5c98ab2-5ce0-11ec-bf63-0242ac130002",
19
    "balance": 123,
20
    "lowStockLevel": 7,
21
    "lowStockAlert": true,
22
    "updated": "2021-01-02T00:00:00.000Z",
23
    "checksum": "3364489309"
24
  },
25
  {
26
    "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
27
    "inventoryUuid": "8c92da3c-2de9-11ed-ba03-2f8a52174076",
28
    "productUuid": "24977020-5ce1-11ec-bf63-0242ac130002",
29
    "variantUuid": "f5c98ab2-5ce0-11ec-bf63-0242ac130002",
30
    "balance": 1337,
31
    "lowStockLevel": 7,
32
    "lowStockAlert": true,
33
    "updated": "2021-01-01T00:00:00.000Z",
34
    "checksum": "4046707849"
35
  }
36
]

Find deleted product or product variants

To find deleted product or product variants, do one of the following:

Related information