api.lots.create

POST /Lot — Catalog

Python

api.lots.create(*, data: AddLotRequest | dict) -> LotDto

CLI

ab lots create [--data ...]

POST /Lot.

Args: data: Lot creation payload with customer_item_id, image_links, initial_data (a :class:LotDataDto with the measurements), catalogs (list of :class:LotCatalogDto), and overriden_data. Accepts an :class:AddLotRequest instance or a dict.

Request model: :class:AddLotRequest

Request body — AddLotRequest

Field

Type

Required

Description

customerItemId

Optional[str]

no

Customer item ID

imageLinks

Optional[list[str]]

no

Image URLs attached to the lot

overridenData

Optional[list[LotDataDto]]

no

Per-catalog override data entries

catalogs

Optional[list[LotCatalogDto]]

no

Catalogs this lot belongs to

initialData

Optional[LotDataDto]

no

Initial lot measurements

Response

Returns LotDto.

Field

Type

Required

Description

id

int

yes

Lot ID

customerItemId

Optional[str]

no

Customer item ID

initialData

Optional[LotDataDto]

no

Initial lot data

overridenData

Optional[list[LotDataDto]]

no

Override entries

catalogs

Optional[list[LotCatalogDto]]

no

Catalog associations (each entry is a LotCatalogDto)

imageLinks

Optional[list[ImageLinkDto]]

no

Attached image links


← Back to api.lots