Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "transferId": "trf-2026-0042",
      "skuId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "sourceShopId": "store-rivoli",
      "destinationShopId": "store-bercy",
      "quantity": 10,
      "shippedAt": "2026-08-01T09:15:00.000Z",
      "ageDays": 3,
      "stale": false
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Inventory

List stock in transit between stores

Returns one PAGE of the goods that have LEFT a store on a transfer and have not yet been received by the destination — the third stock compartment, beside a shop’s on-hand and its reserved figure. These units are in NO store’s on_hand, which is why they need their own read: without it the network total silently under-reports for the whole transit window, and a buyer can be prompted to order stock that is already on a truck.

IT IS NOT SELLABLE. In-transit stock is promisable for a later date and must never be counted as available today — crediting it to the destination would show stock in a shop that cannot physically hand it over. Use it to CORRECT a network rollup (totalInTransit, kept out of totalAvailable) and to discount replenishment orders, never to answer ‘can this store sell it now’.

Oldest shipment first, so anything overdue leads the page. stale=true narrows to shipments past the 7-day threshold — a shipment that never arrives is FLAGGED here, never purged: the compartment’s only exit is the receipt, and receiving a dead shipment at zero books the whole loss as a transfer discrepancy.

GET

inventory

in-transit

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "transferId": "trf-2026-0042",
      "skuId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "sourceShopId": "store-rivoli",
      "destinationShopId": "store-bercy",
      "quantity": 10,
      "shippedAt": "2026-08-01T09:15:00.000Z",
      "ageDays": 3,
      "stale": false
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page

integer

default:1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991

pageSize

integer

default:20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100

destinationShopId

string

Only goods heading FOR this store (what replenishment discounts).

Minimum string length: 1

sourceShopId

string

Only goods that LEFT this store.

Minimum string length: 1

skuId

string

Only this sellable unit.

Minimum string length: 1

transferId

string

Only this transfer's positions.

Minimum string length: 1

stale

enum<string>

true returns only shipments past the staleness threshold.

Available options:

true,

false

Response

One page of the positions currently in transit (oldest shipment first).

items

object[]

required

The rows on this page, in the query's sort order.

Show child attributes

total

integer

required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991

page

integer

required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991

pageSize

integer

required

Rows requested per page.

Required range: 0 < x <= 9007199254740991

pageCount

integer

required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Assistant

Intégrations & données

Système

List stock in transit between stores

Authorizations

Query Parameters

Response