pypresscart.resources.profiles

Profiles resource: team profiles and per-profile listings.

Classes

ProfilesResource(client)

Profile-scoped endpoints.
class pypresscart.resources.profiles.ProfilesResource(client)[source]

Bases: ResourceBase

Profile-scoped endpoints.

Parameters:

client (PresscartClient)

list_team_profiles(team_id, *, limit=25, page=1, as_json=None)[source]

List all profiles for a team. Required scope: profiles.lists.

Parameters:
Return type:

Paginated[Profile] | dict[str, Any]

list_orders(profile_id, *, start_date=None, end_date=None, paid_orders_only=None, limit=25, page=1, as_json=None)[source]

List orders for a single profile. Required scope: orders.lists.

Parameters:

  • profile_id (str)

  • start_date (str | None)

  • end_date (str | None)

  • paid_orders_only (bool | None)

  • limit (int)

  • page (int)

  • as_json (bool | None)

Return type:

Paginated[Order] | dict[str, Any]

list_order_items(profile_id, *, type=None, is_add_on=None, search=None, aggregate_add_ons=None, as_json=None)[source]

List order items for a profile. Required scope: orders.lists.

Note: returns a bare JSON array, not the standard paginated envelope.

Parameters:

  • profile_id (str)

  • type (str | None)

  • is_add_on (bool | None)

  • search (str | None)

  • aggregate_add_ons (bool | None)

  • as_json (bool | None)

Return type:

list[ProfileOrderItem] | list[dict[str, Any]]

list_campaigns(profile_id, *, limit=25, page=1, as_json=None)[source]

List campaigns for a profile. Required scope: campaigns.lists.

Parameters:
Return type:

Paginated[Campaign] | dict[str, Any]