POST Catalog/Collections

Request Information

URI Parameters

None.

Body Parameters

GetCollectionsRequest
NameDescriptionTypeAdditional information
Filter

CollectionFilter

None.

Range

AdminFilterRange

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
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Collections

Collection of Collection

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "Collections": [
    {
      "ID": 1,
      "Created": "2025-12-06T09:16:34.9174514+01:00",
      "Disabled": "2025-12-06T09:16:34.9174514+01:00",
      "Name": "sample string 3",
      "Description": "sample string 4"
    },
    {
      "ID": 1,
      "Created": "2025-12-06T09:16:34.9174514+01:00",
      "Disabled": "2025-12-06T09:16:34.9174514+01:00",
      "Name": "sample string 3",
      "Description": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<CollectionsView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Catalog">
  <Collections>
    <Collection>
      <Created>2025-12-06T09:16:34.9174514+01:00</Created>
      <Description>sample string 4</Description>
      <Disabled>2025-12-06T09:16:34.9174514+01:00</Disabled>
      <ID>1</ID>
      <Name>sample string 3</Name>
    </Collection>
    <Collection>
      <Created>2025-12-06T09:16:34.9174514+01:00</Created>
      <Description>sample string 4</Description>
      <Disabled>2025-12-06T09:16:34.9174514+01:00</Disabled>
      <ID>1</ID>
      <Name>sample string 3</Name>
    </Collection>
  </Collections>
  <TotalCount>1</TotalCount>
</CollectionsView>