Transfers

List stock transfers between stores

Transfers of stock from one store to another. A transfer involves two stores: a client restricted to some stores sees it if either the origin or the destination is allowed.

Statuses: hold (draft, hidden by default), open, posted.

needs transfers:read Purchasing and stock

Endpoints#

List: GET/api/v1/transfers One record: GET/api/v1/transfers/{id}

Example request#

List with a page size and a sort:

bash

curl "https://votre-entreprise.evyooht.com/api/v1/transfers?per_page=5&sort=-date" \
  -H "Authorization: Bearer evy_at_votre_jeton"

powershell

$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/transfers?per_page=5&sort=-date" -Headers $headers

javascript

const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/transfers?per_page=5&sort=-date", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);

php

$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/transfers?per_page=5&sort=-date");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

python

import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/transfers",
    params={"per_page": 5, "sort": "-date"},
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

One record by its identifier:

bash

curl "https://votre-entreprise.evyooht.com/api/v1/transfers/48" \
  -H "Authorization: Bearer evy_at_votre_jeton"

powershell

$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/transfers/48" -Headers $headers

javascript

const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/transfers/48", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);

php

$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/transfers/48");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

python

import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/transfers/48",
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

Query parameters of the list#

All filters can be combined: they add up (AND). An unknown parameter or an invalid value is refused with a 400 error, never ignored.

Parameter	Type	Description
`page`	integer	Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper. Default: `1`.
`per_page`	integer	Results per page, from 1 to 100. Default: `25`.
`sort`	string	Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `updated_at`. Default: `-date`. Default: `-date`.
`status`	string	hold, open, posted, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `hold`, `open`, `posted`, `all`.
`from_store_id`	integer	Only transfers leaving this store.
`to_store_id`	integer	Only transfers arriving in this store.
`date_from`	string (date)	Only documents dated on or after this day (YYYY-MM-DD).
`date_to`	string (date)	Only documents dated on or before this day (YYYY-MM-DD), the whole day included.
`search`	string	Text contained in the transfer number.
`updated_since`	string	Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).

Response fields#

The list and the detail route return these fields. A field is null when the value is not recorded. A field marked needs permission is absent (not empty) unless your client holds that permission.

Field	Type	Description
`id`	integer	Unique identifier. Use it in the detail route.
`number`	string\| null	Human-readable document number, for example I1-4149.
`date`	string(date-time, local) \| null	Document date and time (store local time, no time zone).
`from_store_id`	integer\| null	Identifier of the store the goods leave.
`from_store`	string\| null	Name of the store the goods leave.
`to_store_id`	integer\| null	Identifier of the store the goods arrive in.
`to_store`	string\| null	Name of the store the goods arrive in.
`status`	"hold"\| "open" \| "posted" \| null	hold, open or posted.
`quantity_total`	number\| null	Total quantity transferred.
`notes`	string\| null	Free-text notes printed on the document.
`created_at`	string(date-time, local) \| null	When the record was created (local time, no time zone).
`updated_at`	string(date-time, local) \| null	When the record was last modified (local time, no time zone). Use it with the updated_since filter to synchronize.

Relation: lines#

Returned by the detail route only. The lines of the transfer.

Field	Type	Description
`id`	integer	Identifier of the line.
`product_id`	integer\| null	Identifier of the product.
`name`	string\| null	Item name.
`description`	string\| null	Item description.
`quantity`	number\| null	Quantity transferred, in the unit shown in unit.
`unit`	string\| null	Unit of the line.
`base_quantity`	number\| null	Quantity expressed in the base unit of the product.
`average_cost` needs costs:read	number\| null	Average cost of the product. Requires costs:read.

Example response: list#

json

{
  "data": [
    {
      "id": 48,
      "number": "T1-48",
      "date": "2026-03-15T14:30:00",
      "from_store_id": 1,
      "from_store": "Main store",
      "to_store_id": 2,
      "to_store": "Delmas store",
      "status": "hold",
      "quantity_total": 12,
      "notes": "Delivered on Friday.",
      "created_at": "2026-03-15T14:30:00",
      "updated_at": "2026-03-15T14:30:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Example response: one record#

json

{
  "data": {
    "id": 48,
    "number": "T1-48",
    "date": "2026-03-15T14:30:00",
    "from_store_id": 1,
    "from_store": "Main store",
    "to_store_id": 2,
    "to_store": "Delmas store",
    "status": "hold",
    "quantity_total": 12,
    "notes": "Delivered on Friday.",
    "created_at": "2026-03-15T14:30:00",
    "updated_at": "2026-03-15T14:30:00",
    "lines": [
      {
        "id": 9001,
        "product_id": 463,
        "name": "Thermal paper roll 57x18m",
        "description": "Thermal paper roll for receipt printers",
        "quantity": 10,
        "unit": "Box of 100",
        "base_quantity": 1000,
        "average_cost": 92.5
      }
    ]
  }
}

Errors#

The error format and the full list of codes are described in Errors.

Status	When
`400`	A query parameter is invalid or unknown. Every fault is reported at once in `error.details`. Nothing is ignored silently.
`401`	The token is missing, malformed, expired or revoked (`missing_token` or `invalid_token`). Ask for a new token.
`403`	Your token does not carry the permission this route needs (`insufficient_scope`), or the request was not made over HTTPS (`https_required`).
`429`	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header.

Une erreur, une question, un point pas clair ? Écrivez-nous. Si vous écrivez à propos d'une erreur de l'API, joignez son request_id.