pypresscart.models.order_items

Order item models.

Classes

OrderItem(*, id[, referrer_id, ...])

Record returned by GET /order-items.

OrderItemArticle(*[, id, name, campaign, writer])

OrderItemCampaignRef(*[, id, name, profile_id])

OrderItemClient(*[, first_name, last_name])

OrderItemWriter(*[, id, first_name, last_name])

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

Item returned by GET /profiles/{profile_id}/order-items (non-paginated list).
class pypresscart.models.order_items.OrderItem(*, id, referrer_id=None, referrer_team_id=None, product_id=None, commission_amount=None, commission_date_paid=None, commission_status=None, is_accounting_completed=None, is_publisher_paid=None, is_reseller_paid=None, refund_required=None, is_refunded=None, refund_date=None, refund_method=None, refund_reference=None, vendor_invoice_id=None, vendor_cost=None, vendor_invoice_date=None, vendor_paid_date=None, vendor_invoice_url=None, accounting_completion_date=None, publisher_paid_date=None, reseller_paid_date=None, created_at=None, updated_at=None, deleted_at=None, order_id=None, client_id=None, date_paid=None, sale_price=None, product_name=None, product_price=None, product_type=None, article_id=None, article=None, internal_cost=None, reseller_price=None, client=None, outlet=None, **extra_data)[source]

Bases: PresscartModel

Record returned by GET /order-items.

Parameters:

  • id (str)

  • referrer_id (str | None)

  • referrer_team_id (str | None)

  • product_id (str | None)

  • commission_amount (float | None)

  • commission_date_paid (datetime | None)

  • commission_status (str | None)

  • is_accounting_completed (bool | None)

  • is_publisher_paid (bool | None)

  • is_reseller_paid (bool | None)

  • refund_required (bool | None)

  • is_refunded (bool | None)

  • refund_date (datetime | None)

  • refund_method (str | None)

  • refund_reference (str | None)

  • vendor_invoice_id (str | None)

  • vendor_cost (float | None)

  • vendor_invoice_date (datetime | None)

  • vendor_paid_date (datetime | None)

  • vendor_invoice_url (str | None)

  • accounting_completion_date (datetime | None)

  • publisher_paid_date (datetime | None)

  • reseller_paid_date (datetime | None)

  • created_at (datetime | None)

  • updated_at (datetime | None)

  • deleted_at (datetime | None)

  • order_id (str | None)

  • client_id (str | None)

  • date_paid (datetime | None)

  • sale_price (float | None)

  • product_name (str | None)

  • product_price (float | None)

  • product_type (str | None)

  • article_id (str | None)

  • article (OrderItemArticle | None)

  • internal_cost (float | None)

  • reseller_price (float | None)

  • client (OrderItemClient | None)

  • outlet (OutletRef | None)

  • extra_data (Any)

id: str
referrer_id: str | None
referrer_team_id: str | None
product_id: str | None
commission_amount: float | None
commission_date_paid: datetime | None
commission_status: str | None
is_accounting_completed: bool | None
is_publisher_paid: bool | None
is_reseller_paid: bool | None
refund_required: bool | None
is_refunded: bool | None
refund_date: datetime | None
refund_method: str | None
refund_reference: str | None
vendor_invoice_id: str | None
vendor_cost: float | None
vendor_invoice_date: datetime | None
vendor_paid_date: datetime | None
vendor_invoice_url: str | None
accounting_completion_date: datetime | None
publisher_paid_date: datetime | None
reseller_paid_date: datetime | None
created_at: datetime | None
updated_at: datetime | None
deleted_at: datetime | None
order_id: str | None
client_id: str | None
date_paid: datetime | None
sale_price: float | None
product_name: str | None
product_price: float | None
product_type: str | None
article_id: str | None
article: OrderItemArticle | None
internal_cost: float | None
reseller_price: float | None
client: OrderItemClient | None
outlet: OutletRef | None
class pypresscart.models.order_items.OrderItemArticle(*, id=None, name=None, campaign=None, writer=None, **extra_data)[source]

Bases: PresscartModel

Parameters:
id: str | None
name: str | None
campaign: OrderItemCampaignRef | None
writer: OrderItemWriter | None
class pypresscart.models.order_items.OrderItemCampaignRef(*, id=None, name=None, profile_id=None, **extra_data)[source]

Bases: PresscartModel

Parameters:

  • id (str | None)

  • name (str | None)

  • profile_id (str | None)

  • extra_data (Any)

id: str | None
name: str | None
profile_id: str | None
class pypresscart.models.order_items.OrderItemClient(*, first_name=None, last_name=None, **extra_data)[source]

Bases: PresscartModel

Parameters:

  • first_name (str | None)

  • last_name (str | None)

  • extra_data (Any)

first_name: str | None
last_name: str | None
class pypresscart.models.order_items.OrderItemWriter(*, id=None, first_name=None, last_name=None, **extra_data)[source]

Bases: PresscartModel

Parameters:

  • id (str | None)

  • first_name (str | None)

  • last_name (str | None)

  • extra_data (Any)

id: str | None
first_name: str | None
last_name: str | None
class pypresscart.models.order_items.ProfileOrderItem(*, id, name=None, description=None, is_add_on=None, profile_id=None, type=None, campaign_id=None, product_id=None, min_delivery_days=None, max_delivery_days=None, outlet=None, includes=[], **extra_data)[source]

Bases: PresscartModel

Item returned by GET /profiles/{profile_id}/order-items (non-paginated list).

Parameters:

  • id (str)

  • name (str | None)

  • description (str | None)

  • is_add_on (bool | None)

  • profile_id (str | None)

  • type (str | None)

  • campaign_id (str | None)

  • product_id (str | None)

  • min_delivery_days (int | None)

  • max_delivery_days (int | None)

  • outlet (OutletRef | None)

  • includes (list[IncludeItem])

  • extra_data (Any)

id: str
name: str | None
description: str | None
is_add_on: bool | None
profile_id: str | None
type: str | None
campaign_id: str | None
product_id: str | None
min_delivery_days: int | None
max_delivery_days: int | None
outlet: OutletRef | None
includes: list[IncludeItem]