POST Catalog/Collections

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BrandID	integer	None.
Filter	CollectionFilter	None.
Range	FilterRange	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CollectionsView

Name	Type	Additional information
TotalCount	integer	None.
Collections	Collection of Collection	None.
FilterableProperties	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Collections": [
    {
      "ID": 1,
      "Created": "2025-03-29T03:22:21.2550142+01:00",
      "Disabled": "2025-03-29T03:22:21.2550142+01:00",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "StoreID": 5
    },
    {
      "ID": 1,
      "Created": "2025-03-29T03:22:21.2550142+01:00",
      "Disabled": "2025-03-29T03:22:21.2550142+01:00",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "StoreID": 5
    }
  ],
  "FilterableProperties": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CollectionsView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Catalog">
  <FilterableProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Services.Views">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FilterableProperties>
  <Collections>
    <Collection>
      <Created>2025-03-29T03:22:21.2550142+01:00</Created>
      <Description>sample string 4</Description>
      <Disabled>2025-03-29T03:22:21.2550142+01:00</Disabled>
      <ID>1</ID>
      <Name>sample string 3</Name>
      <StoreID>5</StoreID>
    </Collection>
    <Collection>
      <Created>2025-03-29T03:22:21.2550142+01:00</Created>
      <Description>sample string 4</Description>
      <Disabled>2025-03-29T03:22:21.2550142+01:00</Disabled>
      <ID>1</ID>
      <Name>sample string 3</Name>
      <StoreID>5</StoreID>
    </Collection>
  </Collections>
  <TotalCount>1</TotalCount>
</CollectionsView>