GET /v1/ecommerce/stock-movements

GET

ecommerce

stock-movements

Listar movimientos de stock

curl --request GET \
  --url https://api.keebai.com/v1/ecommerce/stock-movements \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keebai.com/v1/ecommerce/stock-movements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.keebai.com/v1/ecommerce/stock-movements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.keebai.com/v1/ecommerce/stock-movements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/v1/ecommerce/stock-movements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "product": {
        "id": "<string>",
        "name": "<string>",
        "sku": "<string>",
        "image_url": "<string>"
      },
      "variant_id": "<string>",
      "variant_name": "<string>",
      "type": "sale",
      "quantity": 123,
      "stock_after": 123,
      "created_at": "<string>",
      "reference": {
        "kind": "<string>",
        "id": "<string>",
        "label": "<string>"
      },
      "user": {
        "id": "<string>",
        "email": "<string>"
      },
      "note": "<string>",
      "branch_id": "<string>",
      "from_branch_id": "<string>",
      "to_branch_id": "<string>",
      "origin": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Returns the paginated history of stock movements. Every change to stock leaves one: a sale, a cancelled sale, a manual adjustment, a transfer between branches, an import, or a sync from a connected store.

Endpoint

GET https://api.keebai.com/v1/ecommerce/stock-movements

Required scope

ecommerce:stock:read

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer kbai_pk_<token>`

Query parameters

Field	Type	Required	Description
`from`	`string`	No	Start date, `YYYY-MM-DD`. Send it together with `to`.
`to`	`string`	No	End date, `YYYY-MM-DD`. Send it together with `from`.
`types`	`string`	No	Comma-separated list of movement types. See below.
`branch_id`	`string`	No	Only movements of this branch.
`search`	`string`	No	Free-text search.
`limit`	`integer`	No	Page size, `1`–`200`. Defaults to 50.
`offset`	`integer`	No	Records to skip. Defaults to 0.

Movement types

`type`	What moved the stock
`sale`	A sale.
`sale_cancel`	A cancelled sale giving the stock back.
`adjustment`	A manual adjustment, such as `POST .../stock/adjust`.
`set`	Stock set to a fixed value.
`purchase`	A purchase.
`import`	An import.
`sync`	A sync from a connected store.
`transfer`	A transfer between the warehouse and branches, such as `POST .../stock/transfer`.

Example request

curl -G https://api.keebai.com/v1/ecommerce/stock-movements \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  --data-urlencode "from=2026-11-01" \
  --data-urlencode "to=2026-11-04" \
  --data-urlencode "types=adjustment,transfer" \
  --data-urlencode "limit=50"

const params = new URLSearchParams({
  from: "2026-11-01",
  to: "2026-11-04",
  types: "adjustment,transfer",
  limit: "50",
});

const response = await fetch(
  `https://api.keebai.com/v1/ecommerce/stock-movements?${params}`,
  { headers: { Authorization: `Bearer ${process.env.KEEBAI_API_TOKEN}` } },
);
const { items, total } = await response.json();

import os, requests

resp = requests.get(
    "https://api.keebai.com/v1/ecommerce/stock-movements",
    headers={"Authorization": f"Bearer {os.environ['KEEBAI_API_TOKEN']}"},
    params={"from": "2026-11-01", "to": "2026-11-04", "types": "adjustment,transfer", "limit": 50},
    timeout=10,
)
resp.raise_for_status()
movements = resp.json()["items"]

Response

200 OK

{
  "items": [
    {
      "variant_id": "65d3e4f5a6b7c8d9e0f1a2c1",
      "variant_name": "42 / Negro",
      "type": "transfer",
      "quantity": 3,
      "stock_after": 12,
      "from_branch_id": "br_01",
      "to_branch_id": "br_02",
      "note": "Reposición fin de semana",
      "created_at": "2026-11-03T18:22:10.402Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Each item is one movement. type is one of the values above, quantity is how much moved, and stock_after is the master stock left after it.

400 Bad Request

A date not in YYYY-MM-DD, an unknown value in types, limit outside 1–200, or a negative offset. DATE_RANGE_INCOMPLETE — only one of from and to was sent. They go together.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the ecommerce:stock:read scope.

502 Bad Gateway

ECOMMERCE_UPSTREAM_ERROR — the ecommerce service could not answer.

Operational notes

This is the audit trail of stock. To explain why a number changed, read the movements of that product instead of comparing two snapshots.
A transfer does not change the total. It moves stock between the warehouse and branches; the master stock of the product stays the same.

Authorizations

Authorization

string

header

required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

from

string

Desde (YYYY-MM-DD, inclusive, hora de Santiago). Va junto con to

Example:

"2026-11-01"

string

Hasta (YYYY-MM-DD, inclusive, hora de Santiago). Va junto con from

Example:

"2026-11-30"

types

string

Tipos separados por coma: sale, sale_cancel, adjustment, set, purchase, import, sync, transfer

Example:

"sale,adjustment"

branch_id

string

Solo movimientos de esta sucursal

string

Busca por nombre o SKU del producto

limit

number

default:50

Required range: 1 <= x <= 200

offset

number

default:0

Required range: x >= 0

Response

200 - application/json

items

object[]

required

Show child attributes

total

number

required

limit

number

required

offset

number

required

Listar movimientos de stock

curl --request GET \
  --url https://api.keebai.com/v1/ecommerce/stock-movements \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keebai.com/v1/ecommerce/stock-movements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.keebai.com/v1/ecommerce/stock-movements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.keebai.com/v1/ecommerce/stock-movements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/v1/ecommerce/stock-movements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "product": {
        "id": "<string>",
        "name": "<string>",
        "sku": "<string>",
        "image_url": "<string>"
      },
      "variant_id": "<string>",
      "variant_name": "<string>",
      "type": "sale",
      "quantity": 123,
      "stock_after": 123,
      "created_at": "<string>",
      "reference": {
        "kind": "<string>",
        "id": "<string>",
        "label": "<string>"
      },
      "user": {
        "id": "<string>",
        "email": "<string>"
      },
      "note": "<string>",
      "branch_id": "<string>",
      "from_branch_id": "<string>",
      "to_branch_id": "<string>",
      "origin": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Get started

Products

Inventory

Carts

Sales

Electronic invoicing

GET /v1/ecommerce/stock-movements

Endpoint

Required scope

Headers

Query parameters

Movement types

Example request

Response

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes

Authorizations

Query Parameters

Response

​Endpoint

​Required scope

​Headers

​Query parameters

​Movement types

​Example request

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

​403 Forbidden

​502 Bad Gateway

​Operational notes

Authorizations

Query Parameters

Response

Endpoint

Required scope

Headers

Query parameters

Movement types

Example request

Response

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes