BEbeezup
Catalogs - Catalog

Get the index of the catalog API for this store

The operation will give you all the operations you will be able to do on this store for this API.

get/v2/user/catalogs/{storeId}

Request

Path parameters

storeIdstring guid required

Your store identifier

Response

The catalog index

status'OK' | 'Failed' | 'Outdated' required

Indicates the status of the catalog store.

  • OK: If the latest importation is a success!
  • Failed: If the latest importation has failed !
  • Outdated: If the latest succeed importation is later than 1 day.

Example response

{
  "links": {
    "self": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3",
      "method": "GET"
    },
    "inputConfiguration": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/inputConfiguration",
      "method": "GET"
    },
    "autoImportInfo": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/autoImport",
      "method": "GET"
    },
    "importations": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/importations",
      "method": "GET"
    },
    "startImportation": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/importations/start",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "required": true,
          "type": "object",
          "schema": "startManualImportRequest"
        }
      }
    },
    "catalogColumns": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/catalogColumns",
      "method": "GET"
    },
    "customColumns": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/customColumns",
      "method": "GET"
    },
    "categories": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/categories",
      "method": "GET"
    },
    "products": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/products/list",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "required": true,
          "type": "object",
          "schema": "getProductsRequest"
        }
      }
    },
    "randomProducts": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/products/random",
      "method": "GET"
    },
    "computeExpression": {
      "href": "/v2/user/catalogs/a42b780d-4585-4566-800e-4d77a4d6f8a3/customColumns/computeExpression",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "required": true,
          "type": "object",
          "schema": "computeExpressionRequest"
        }
      }
    }
  },
  "status": "OK"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.