younifyd
Menu

Get Catalogs

Gets all authorized catalogs

GET/catalogs

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Catalogs action (under Catalog).
  3. Fill in the fields below, then reference the result from later steps as {{getCatalogs.response.data}}.

Request

Query parameters

filterstring

This endpoint supports filtering, see [Filtering](#filtering).

page[limit]integer (int64)

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[offset]integer (int64)

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.

Response

Returns 200 with an object. Read it in later steps with {{getCatalogs.response.data.<field>}}.

dataarray<object>
idstringrequired

A unique identifier of a catalog.

attributesobjectrequired11 fields
relationshipsobject2 fields

Relationships are established between different catalog entities. For example, a catalog rule and a price book are related to a catalog, as both are associated with it.

typestringrequired

One ofcatalog

metaobject

Contains the results for the entire collection.

resultsobject1 fields

Total number of results for the entire collection.

pageobject4 fields
linksobject

Links allow you to move between requests.

selfstring (uri)

Single entities use a `self` parameter with a link the specific resource.

firststring (uri)

Always the first page.

laststring (uri)

This is `null` if there is only one page.

prevstring (uri)

This is `null` if there is only one page.

nextstring (uri)

This is `null` if there is only one page.

json
{
  "data": [
    {
      "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
      "attributes": {
        "name": "catalog-123",
        "hierarchy_ids": [
          "string"
        ],
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "description": "Catalog for Store 123",
        "pricebook_id": "string",
        "pricebook_ids": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "priority": 0
          }
        ],
        "locales": {},
        "owner": "store",
        "enable_price_segmentation": true,
        "include_draft_products": false
      },
      "type": "catalog",
      "relationships": {
        "rules": {
          "links": {
            "related": "string"
          }
        },
        "releases": {
          "links": {
            "related": "string"
          },
          "meta": {
            "count": 0
          }
        }
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 0,
      "offset": 0,
      "current": 0,
      "total": 0
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.