api.catalog.create

POST /Catalog — Catalog

Python

api.catalog.create(*, data: AddCatalogRequest | dict) -> CatalogWithSellersDto

CLI

ab catalog create [--data ...]

POST /Catalog.

Args: data: Catalog creation payload with customer_catalog_id, agent, title, start_date (required datetime), end_date (required datetime), and seller_ids. Accepts an :class:AddCatalogRequest instance or a dict.

Request model: :class:AddCatalogRequest

Request body — AddCatalogRequest

Field	Type	Required	Description
customerCatalogId	Optional[str]	no	Customer-facing catalog ID
agent	Optional[str]	no	Assigned agent code
title	Optional[str]	no	Catalog title
startDate	datetime	yes	Catalog start date-time
endDate	datetime	yes	Catalog end date-time
sellerIds	Optional[list[int]]	no	Seller IDs to attach

Response

Returns CatalogWithSellersDto.

Field	Type	Required	Description
id	int	yes	Catalog ID
customerCatalogId	Optional[str]	no	Customer-facing catalog ID
agent	Optional[str]	no	Assigned agent code
title	Optional[str]	no	Catalog title
startDate	datetime	yes	Catalog start date-time
endDate	datetime	yes	Catalog end date-time
isCompleted	bool	yes	Whether the catalog is completed
sellers	Optional[list[SellerDto]]	no	Attached sellers

---

← Back to api.catalog