GET api/v1/purchaseitems/products?customerId={customerId}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&monthsBack={monthsBack}

Request Information

URI Parameters

Name	Type	Additional information
customerId	globally unique identifier	Required
Limit	integer	None.
Offset	integer	None.
OrderBy	string	None.
monthsBack	integer	Default value is 12

Body Parameters

None.

Response Information

Resource Description

MultiResultResponseOfPurchasedProductData

Name	Description	Type	Additional information
Meta		MetaMultiResult	None.
Notifications			None.

Response Formats

application/json, text/json

Sample:

{
  "meta": {
    "limit": 1,
    "offset": 2,
    "totalResults": 3
  },
  "notifications": [
    {},
    {}
  ],
  "results": [
    {
      "id": "ef619b53-a7b5-4904-8f3e-a40ff16f1e7b",
      "name": "sample string 2",
      "brandCode": "sample string 3",
      "brandName": "sample string 4",
      "total": 5.0,
      "date": "2026-02-04T06:20:01.0661115+00:00"
    },
    {
      "id": "ef619b53-a7b5-4904-8f3e-a40ff16f1e7b",
      "name": "sample string 2",
      "brandCode": "sample string 3",
      "brandName": "sample string 4",
      "total": 5.0,
      "date": "2026-02-04T06:20:01.0661115+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<MultiResultResponseOfPurchasedProductDatadOvjT49_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta>
    <Limit>1</Limit>
    <Offset>2</Offset>
    <TotalResults>3</TotalResults>
  </Meta>
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos">
    <d2p1:PurchasedProductData>
      <d2p1:BrandCode>sample string 3</d2p1:BrandCode>
      <d2p1:BrandName>sample string 4</d2p1:BrandName>
      <d2p1:Date>2026-02-04T06:20:01.0661115+00:00</d2p1:Date>
      <d2p1:Id>ef619b53-a7b5-4904-8f3e-a40ff16f1e7b</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Total>5</d2p1:Total>
    </d2p1:PurchasedProductData>
    <d2p1:PurchasedProductData>
      <d2p1:BrandCode>sample string 3</d2p1:BrandCode>
      <d2p1:BrandName>sample string 4</d2p1:BrandName>
      <d2p1:Date>2026-02-04T06:20:01.0661115+00:00</d2p1:Date>
      <d2p1:Id>ef619b53-a7b5-4904-8f3e-a40ff16f1e7b</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Total>5</d2p1:Total>
    </d2p1:PurchasedProductData>
  </Results>
</MultiResultResponseOfPurchasedProductDatadOvjT49_P>