List landed costs

Operation ID: landedCosts

Group: Inventory › Landed Costs

Open in the interactive reference

GET /inventory/landed-costs

Read-only: Reads and returns; changes nothing.

Lists landed costs, with their main fields only. For their receipts, charges, and allocation, use POST inventory/landed-costs/search or GET inventory/landed-costs/:id. To find the landed costs for a receipt, a vendor bill, or an item, use POST inventory/landed-costs/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of landedCostsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the landed cost. Format: UUID. Example: "6d18b2f0-49c7-4a35-9e81-2f0c5a7d3b64".
documentNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The landed cost number, for example 'LC-1007'. Example: "LC-1007".
documentStatus string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The status of the landed cost. Possible values: 'DRAFT', 'COMMITTED'. Example: "DRAFT".
documentDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date of the landed cost. Format: YYYY-MM-DD. Example: "2026-08-18".
entityId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier of the legal entity the landed cost belongs to. Format: UUID. See id on GET base/entities (entities). Example: "7039b992-696a-40c7-a181-51759304ef83".
entityName string | null no no no The name of the legal entity in entityId. Example: "Flow UK".
notes string | null no no no Free text on the landed cost. Example: "Sea freight on the August container".
active boolean | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) no Whether the landed cost is active. Example: true.
createdDate date-time | null no no no The date and time the landed cost was created, in UTC. Format: YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-18T09:02:11.004Z".
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the landed cost last changed, in UTC. Format: YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-18T09:14:22.517Z". 
{
  "data": [
    {
      "id": "6d18b2f0-49c7-4a35-9e81-2f0c5a7d3b64",
      "documentNumber": "LC-1007",
      "documentStatus": "DRAFT",
      "documentDate": "2026-08-18",
      "entityId": "7039b992-696a-40c7-a181-51759304ef83",
      "entityName": "Flow UK",
      "notes": "Sea freight on the August container",
      "active": true,
      "createdDate": "2026-08-18T09:02:11.004Z",
      "lastModifiedDate": "2026-08-18T09:14:22.517Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses