pypresscart.resources.orders

Orders resource: /orders endpoints.

Classes

OrdersResource(client)

Order endpoints (list, get, create checkout).
class pypresscart.resources.orders.OrdersResource(client)[source]

Bases: ResourceBase

Order endpoints (list, get, create checkout).

Parameters:

client (PresscartClient)

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

List orders for the team. Required scope: orders.lists.

Parameters:

  • limit (int)

  • page (int)

  • sort_by (str | None)

  • order_by (str | None)

  • as_json (bool | None)

Return type:

Paginated[Order] | dict[str, Any]

get(order_id, *, include_outlets_data=None, as_json=None)[source]

Get a single order by id. Required scope: orders.read.

Parameters:

  • order_id (str)

  • include_outlets_data (bool | None)

  • as_json (bool | None)

Return type:

Order | dict[str, Any]

create_checkout(body, *, as_json=None)[source]

Create a checkout order. Required scope: orders.create.

Parameters:
Return type:

Order | dict[str, Any]