GET
/
api
/
page_sections
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const response = await client.auctions.getPageSections({
    organizationId: '123e4567-e89b-12d3-a456-426614174334',
    placement: 'page',
    websiteId: '123e4567-e89b-12d3-a456-426614174333',
  });

  console.log(response.id);
}

main();
{
  "id": "123e4567-e89b-12d3-a456-426614174337",
  "websiteId": "123e4567-e89b-12d3-a456-426614174333",
  "organizationId": "123e4567-e89b-12d3-a456-426614174334",
  "title": "Featured Collection",
  "pageSectionType": "discovery_items_grid",
  "placement": "page",
  "sortId": 1,
  "pageId": "123e4567-e89b-12d3-a456-426614174336",
  "durationStart": "2023-01-01T00:00:00.000Z",
  "durationEnd": "2023-12-31T23:59:59.999Z",
  "banner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "websiteCollectionBanners": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "websiteCollectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "carousel": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "carouselItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sortId": 123
        }
      ]
    }
  },
  "itemsGrids": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "websiteCollection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "mintingContractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ],
  "discoveryItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "layout": "container_style",
      "loyaltySection": "<string>",
      "pageMediaLink": "<string>",
      "mediaLink": "<string>",
      "website": "<string>",
      "twitter": "<string>",
      "loyaltyRuleGroupId": "<string>",
      "sortId": 123,
      "buttonText": "<string>",
      "externalLink": "<string>",
      "hideQuestInfo": false
    }
  ]
}

Query Parameters

​
websiteId
string
required

Unique identifier for the website to filter by

Example:

"123e4567-e89b-12d3-a456-426614174333"

​
organizationId
string
required

Unique identifier for the organization to filter by

Example:

"123e4567-e89b-12d3-a456-426614174334"

​
websiteCollectionId
string

Unique identifier for the website collection to filter by

Example:

"123e4567-e89b-12d3-a456-426614174335"

​
placement
enum<string>
required

Placement of the page section

Available options:
global,
page
Example:

"page"

​
pageId
string

Unique identifier for the page to filter by

Example:

"123e4567-e89b-12d3-a456-426614174336"

​
all
enum<string>

Whether to get all sections regardless of duration

Available options:
1
Example:

"1"

​
pageSectionType
enum<string> | null

Type of the page section to filter by

Available options:
all_items,
discovery_item,
discovery_items_grid
Example:

"page"

Response

200
application/json
200
​
id
string
required

Unique identifier for the page section

Example:

"123e4567-e89b-12d3-a456-426614174337"

​
websiteId
string
required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174333"

​
organizationId
string
required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174334"

​
placement
enum<string>
required

Placement of the page section

Available options:
global,
page
Example:

"page"

​
durationStart
string
required

Start time of the page section visibility

Example:

"2023-01-01T00:00:00.000Z"

​
title
string | null

Title of the page section

Example:

"Featured Collection"

​
pageSectionType
enum<string> | null

Type of the page section

Available options:
all_items,
discovery_item,
discovery_items_grid
Example:

"discovery_items_grid"

​
sortId
number

Order of the page section

Example:

1

​
pageId
string

ID of the page this section belongs to

Example:

"123e4567-e89b-12d3-a456-426614174336"

​
durationEnd
string | null

End time of the page section visibility

Example:

"2023-12-31T23:59:59.999Z"

​
banner
object | null
​
itemsGrids
object[]
​
discoveryItems
object[]

Was this page helpful?