GET api/Materials/Inventories?Offset={Offset}&Limit={Limit}&Sort={Sort}&Filter={Filter}

List all Inventories

Request Information

URI Parameters

NameDescriptionTypeAdditional information
See using pagination
Offset

Number of items to skip from the start

integer

Equal or above: 0

Limit

Maximum number of items to return

integer

Equal or above: 1

Sort

Field to sort by

string

None.

Filter

JSON formated filter (see using filters), see InventoryFilterParams

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of InventoryList
NameDescriptionTypeAdditional information
Store

BasicDetail

None.

Code

string

None.

Description

string

None.

Date

date

None.

Consolidated

boolean

None.

Materials

Collection of InventoryMaterials

None.

Account

string

None.

Response Formats

Sample:
[
  {
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Date": "2025-07-16T09:12:29.8553416+01:00",
    "Consolidated": true,
    "Materials": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Lot": "sample string 3",
        "Quantity": 1.1,
        "UnitaryCost": 4.1
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Lot": "sample string 3",
        "Quantity": 1.1,
        "UnitaryCost": 4.1
      }
    ],
    "Account": "sample string 5"
  },
  {
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Date": "2025-07-16T09:12:29.8553416+01:00",
    "Consolidated": true,
    "Materials": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Lot": "sample string 3",
        "Quantity": 1.1,
        "UnitaryCost": 4.1
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Lot": "sample string 3",
        "Quantity": 1.1,
        "UnitaryCost": 4.1
      }
    ],
    "Account": "sample string 5"
  }
]
Sample:
<ArrayOfInventoryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Materiais">
  <InventoryList>
    <Account>sample string 5</Account>
    <Code>sample string 1</Code>
    <Consolidated>true</Consolidated>
    <Date>2025-07-16T09:12:29.8553416+01:00</Date>
    <Description>sample string 2</Description>
    <Materials>
      <InventoryMaterials>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Lot>sample string 3</Lot>
        <Quantity>1.1</Quantity>
        <UnitaryCost>4.1</UnitaryCost>
      </InventoryMaterials>
      <InventoryMaterials>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Lot>sample string 3</Lot>
        <Quantity>1.1</Quantity>
        <UnitaryCost>4.1</UnitaryCost>
      </InventoryMaterials>
    </Materials>
    <Store xmlns:d3p1="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">
      <d3p1:Code>sample string 1</d3p1:Code>
      <d3p1:Description>sample string 2</d3p1:Description>
    </Store>
  </InventoryList>
  <InventoryList>
    <Account>sample string 5</Account>
    <Code>sample string 1</Code>
    <Consolidated>true</Consolidated>
    <Date>2025-07-16T09:12:29.8553416+01:00</Date>
    <Description>sample string 2</Description>
    <Materials>
      <InventoryMaterials>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Lot>sample string 3</Lot>
        <Quantity>1.1</Quantity>
        <UnitaryCost>4.1</UnitaryCost>
      </InventoryMaterials>
      <InventoryMaterials>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Lot>sample string 3</Lot>
        <Quantity>1.1</Quantity>
        <UnitaryCost>4.1</UnitaryCost>
      </InventoryMaterials>
    </Materials>
    <Store xmlns:d3p1="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">
      <d3p1:Code>sample string 1</d3p1:Code>
      <d3p1:Description>sample string 2</d3p1:Description>
    </Store>
  </InventoryList>
</ArrayOfInventoryList>
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Store.Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Store.Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Date"

2025-07-16T09:12:29.8553416+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Consolidated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[0].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[0].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[0].Lot"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[0].Quantity"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[0].UnitaryCost"

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[1].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[1].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[1].Lot"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[1].Quantity"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Materials[1].UnitaryCost"

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Account"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Store.Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Store.Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Date"

2025-07-16T09:12:29.8553416+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Consolidated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[0].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[0].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[0].Lot"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[0].Quantity"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[0].UnitaryCost"

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[1].Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[1].Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[1].Lot"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[1].Quantity"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Materials[1].UnitaryCost"

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Account"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file