---
title: Product Catalog endpoints
slug: product-catalog-endpoints
description: This quick reference guide document provides detailed information on API endpoints for product catalog configuration. Learn how to retrieve, list, and retrieve specific product catalog entities using various methods. Instructions for adding a product cata
createdAt: 2023-03-16T14:53:23.000Z
---

# Quick reference

| Verb     | Path                                                   | Method                                            |
| -------- | ------------------------------------------------------ | ------------------------------------------------- |
| GET      | /api/platform/product\_catalog/config/                 | Retrieve the product catalog configuration        |
| GET      | /api/platform/product\_catalog/                        | List all product catalog entities                 |
| GET      | /api/platform/product\_catalog/&#x7B;product\_code}/   | Retrieve a product catalog entity                 |
| *DELETE* | */api/platform/product\_catalog/&#x7B;product\_code}/* | *Deactivate a product catalog (**Next release**)* |
| POST     | /api/v1/product\_catalog/add\_column/                  | Adding a product catalog column                   |

# Adding a product catalog column

The first step before adding products is to configure the schema of the product catalog. We do this by adding product catalog columns, one by one

## Parameters

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
column\_name



column\_type



column\_label
:::

:::VerticalSplitItem
`type: string`, `Required`

The identifier of the column&#x20;

`type: string`, `Required`

The values of the extensions (must be of strings)

`type: string`, `Required`

The label of the column, that will be displayed in the UI
:::
::::

## Example

```shell
curl --location 'https://api.pricemoov.com/api/v1/product_catalog/add_column/' \
--header 'Authorization: jwt <your_token>' \
--header 'Content-Type: application/json' \
--data '{
         "column_name":"category",
         "column_type":"STR",
         "column_label":"Category",
      }'
```

Upon success, the response is 201 OK and returns

```json
{
      "column_label": "Category Brand",
      "column_name": "category_brand",
      "column_type": "STR",
      "default_value": None,
      "editable": True,
      "hidden": False,
      "sortable": False,
      "source_table": None,
}
```

:::hint{type="info"}
Once you have started creating products, product catalog configuration **update** is not supported yet. Please contact our customer engineering team in this case.
:::

# Loading your Product Catalog

Once the product catalog is configured, you can load products into Pricemoov. See [Product Catalog & Extensions endpoints](docId\:TppGGLWHGK3kStuhBUL4L)



&#x20;

