api.catalog.get

GET /Catalog/{id} — Catalog

Python

api.catalog.get(catalog_id: int) -> CatalogExpandedDto

CLI

ab catalog get <catalog_id>

Retrieve a single catalog by ID.

Args: catalog_id: Catalog identifier.

Returns: CatalogExpandedDto: Catalog details with seller/lot counts.

Response

Returns CatalogExpandedDto.

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

lots

Optional[list[LotCatalogInformationDto]]

no

Lot summaries belonging to the catalog


← Back to api.catalog