pypresscart.models.outlets

Outlet models.

Classes

CitiesResponse(*[, cities])

CountriesResponse(*[, countries])

DisclaimerRecord(*, id[, name, description])

Outlet(*, id, name[, description, ...])

Response from GET /outlets/{outlet_id}.

OutletChannel(*, id[, outlet_id, ...])

Full outlet channel (from GET /outlets/{id}).

OutletChannelSummary(*[, channel_type, ...])

Channel summary included in outlet listings.

OutletListing(*, id[, outlet_id, ...])

An item in the GET /outlets list.

StatesResponse(*[, states])

class pypresscart.models.outlets.CitiesResponse(*, cities=[], **extra_data)[source]

Bases: PresscartModel

Parameters:
cities: list[str]
class pypresscart.models.outlets.CountriesResponse(*, countries=[], **extra_data)[source]

Bases: PresscartModel

Parameters:
countries: list[str]
class pypresscart.models.outlets.DisclaimerRecord(*, id, name=None, description=None, **extra_data)[source]

Bases: PresscartModel

Parameters:

  • id (str)

  • name (str | None)

  • description (str | None)

  • extra_data (Any)

id: str
name: str | None
description: str | None
class pypresscart.models.outlets.Outlet(*, id, name, description=None, website_url=None, logo=None, country=None, state=None, city=None, is_indexed=None, tags=[], outlet_channels=[], created_at=None, updated_at=None, **extra_data)[source]

Bases: PresscartModel

Response from GET /outlets/{outlet_id}.

Parameters:
id: str
name: str
description: str | None
website_url: str | None
country: str | None
state: str | None
city: str | None
is_indexed: bool | None
tags: list[Tag]
outlet_channels: list[OutletChannel]
created_at: datetime | None
updated_at: datetime | None
class pypresscart.models.outlets.OutletChannel(*, id, outlet_id=None, channel_type=None, placement_type=None, channel_handle=None, channel_url=None, social_links=[], is_do_follow=None, domain_authority=None, domain_ranking=None, do_follow_links_allowed=None, disclaimer_name=None, disclaimer_description=None, **extra_data)[source]

Bases: PresscartModel

Full outlet channel (from GET /outlets/{id}).

Parameters:

  • id (str)

  • outlet_id (str | None)

  • channel_type (ChannelType | str | None)

  • placement_type (PlacementType | str | None)

  • channel_handle (str | None)

  • channel_url (str | None)

  • social_links (list[str])

  • is_do_follow (bool | None)

  • domain_authority (int | None)

  • domain_ranking (int | None)

  • do_follow_links_allowed (bool | str | None)

  • disclaimer_name (str | None)

  • disclaimer_description (str | None)

  • extra_data (Any)

id: str
outlet_id: str | None
channel_type: ChannelType | str | None
placement_type: PlacementType | str | None
channel_handle: str | None
channel_url: str | None
is_do_follow: bool | None
domain_authority: int | None
domain_ranking: int | None
disclaimer_name: str | None
disclaimer_description: str | None
class pypresscart.models.outlets.OutletChannelSummary(*, channel_type=None, placement_type=None, is_do_follow=None, domain_authority=None, domain_ranking=None, disclaimer_name=None, disclaimer_description=None, **extra_data)[source]

Bases: PresscartModel

Channel summary included in outlet listings.

Parameters:

  • channel_type (ChannelType | str | None)

  • placement_type (PlacementType | str | None)

  • is_do_follow (bool | None)

  • domain_authority (int | None)

  • domain_ranking (int | None)

  • disclaimer_name (str | None)

  • disclaimer_description (str | None)

  • extra_data (Any)

channel_type: ChannelType | str | None
placement_type: PlacementType | str | None
is_do_follow: bool | None
domain_authority: int | None
domain_ranking: int | None
disclaimer_name: str | None
disclaimer_description: str | None
class pypresscart.models.outlets.OutletListing(*, id, outlet_id=None, name, description=None, requirements=None, min_delivery_days=None, max_delivery_days=None, is_featured=None, created_at=None, outlet_name=None, website_url=None, logo=None, city=None, state=None, country=None, channels=[], tags=[], prices=[], **extra_data)[source]

Bases: PresscartModel

An item in the GET /outlets list.

Note: id here is a product id (what you pass to checkout). outlet_id is what you pass to GET /outlets/{outlet_id}.

Parameters:
id: str
outlet_id: str | None
name: str
description: str | None
requirements: str | None
min_delivery_days: int | None
max_delivery_days: int | None
created_at: datetime | None
outlet_name: str | None
website_url: str | None
city: str | None
state: str | None
country: str | None
channels: list[OutletChannelSummary]
tags: list[Tag]
prices: list[Price]
class pypresscart.models.outlets.StatesResponse(*, states=[], **extra_data)[source]

Bases: PresscartModel

Parameters:
states: list[str]