pypresscart.resources.outlets

Outlet resource: /outlets + related location / tag / disclaimer endpoints.

Classes

OutletsResource(client)

Endpoints for browsing outlets and their metadata.
class pypresscart.resources.outlets.OutletsResource(client)[source]

Bases: ResourceBase

Endpoints for browsing outlets and their metadata.

Parameters:

client (PresscartClient)

list(*, limit=25, page=1, sort_by=None, order_by=None, filters=None, as_json=None)[source]

List outlets. Required scope: outlets.lists.

Parameters:
Return type:

Paginated[OutletListing] | dict[str, Any]

get(outlet_id, *, as_json=None)[source]

Get a single outlet by id. Required scope: outlets.read.

Parameters:

  • outlet_id (str)

  • as_json (bool | None)

Return type:

Outlet | dict[str, Any]

list_products(outlet_id, *, limit=25, page=1, sort_by=None, order_by=None, filters=None, as_json=None)[source]

List products for one outlet. Required scope: outlets.read.

Parameters:
Return type:

Paginated[OutletListing] | dict[str, Any]

list_countries(*, country=None, as_json=None)[source]

List available outlet countries. Required scope: outlets.read.

Parameters:

  • country (str | None)

  • as_json (bool | None)

Return type:

CountriesResponse | dict[str, Any]

list_states(*, country=None, as_json=None)[source]

List available outlet states (optionally filtered by country). Scope: outlets.read.

Parameters:

  • country (str | None)

  • as_json (bool | None)

Return type:

StatesResponse | dict[str, Any]

list_cities(*, country=None, state=None, as_json=None)[source]

List available outlet cities. Required scope: outlets.read.

Parameters:

  • country (str | None)

  • state (str | None)

  • as_json (bool | None)

Return type:

CitiesResponse | dict[str, Any]

list_tags(*, limit=25, page=1, filters=None, as_json=None)[source]

List available tags. Required scope: tags.lists.

Parameters:
Return type:

Paginated[Tag] | dict[str, Any]

list_disclaimers(*, limit=25, page=1, filters=None, as_json=None)[source]

List outlet disclaimers. Required scope: outlet_disclaimers.lists.

Parameters:
Return type:

Paginated[DisclaimerRecord] | dict[str, Any]