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

List all Materials stock levels

Request Information

URI Parameters

Name

Description

Type

Additional information

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.

store

The Store code where to consult

string

Required

Filter

JSON formated filter (see using filters), see StoreMaterialFilterParams

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of StoreMaterial

Name	Type	Additional information
Code	string	None.
Description	string	None.
Unit	string	None.
Store	BasicDetail	None.
Quantity	decimal number	None.
Cost	decimal number	None.
Location	string	None.
Picture	string	None.
ManagedByLots	boolean	None.
StructuredCode	string	None.
ManufacturerCode	string	None.
ExternalCode	string	None.
Notes	string	None.

Response Formats

Sample:

[
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Unit": "sample string 3",
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Quantity": 4.1,
    "Cost": 5.1,
    "Location": "sample string 6",
    "Picture": "sample string 7",
    "ManagedByLots": true,
    "StructuredCode": "sample string 9",
    "ManufacturerCode": "sample string 10",
    "ExternalCode": "sample string 11",
    "Notes": "sample string 12"
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Unit": "sample string 3",
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Quantity": 4.1,
    "Cost": 5.1,
    "Location": "sample string 6",
    "Picture": "sample string 7",
    "ManagedByLots": true,
    "StructuredCode": "sample string 9",
    "ManufacturerCode": "sample string 10",
    "ExternalCode": "sample string 11",
    "Notes": "sample string 12"
  }
]

Sample:

<ArrayOfStoreMaterial xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Materiais">
  <StoreMaterial>
    <Code>sample string 1</Code>
    <Cost>5.1</Cost>
    <Description>sample string 2</Description>
    <ExternalCode>sample string 11</ExternalCode>
    <Location>sample string 6</Location>
    <ManagedByLots>true</ManagedByLots>
    <ManufacturerCode>sample string 10</ManufacturerCode>
    <Notes>sample string 12</Notes>
    <Picture>sample string 7</Picture>
    <Quantity>4.1</Quantity>
    <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>
    <StructuredCode>sample string 9</StructuredCode>
    <Unit>sample string 3</Unit>
  </StoreMaterial>
  <StoreMaterial>
    <Code>sample string 1</Code>
    <Cost>5.1</Cost>
    <Description>sample string 2</Description>
    <ExternalCode>sample string 11</ExternalCode>
    <Location>sample string 6</Location>
    <ManagedByLots>true</ManagedByLots>
    <ManufacturerCode>sample string 10</ManufacturerCode>
    <Notes>sample string 12</Notes>
    <Picture>sample string 7</Picture>
    <Quantity>4.1</Quantity>
    <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>
    <StructuredCode>sample string 9</StructuredCode>
    <Unit>sample string 3</Unit>
  </StoreMaterial>
</ArrayOfStoreMaterial>

Sample:

--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].Unit"

sample string 3
--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].Quantity"

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

5.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Location"

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

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

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

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

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

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

sample string 12
--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].Unit"

sample string 3
--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].Quantity"

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

5.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Location"

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

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

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

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

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

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

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file