ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/price_schedule.py

@@ -0,0 +1,76 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud PriceMarkupType, PriceBreak, PriceSchedule models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+
+__all__ = ["PriceMarkupType", "PriceBreak", "PriceSchedule"]
+
+
+class PriceMarkupType(OrderCloudEnum):
+    """"""
+
+    NoMarkup = "NoMarkup"
+    AmountPerQuantity = "AmountPerQuantity"
+    AmountTotal = "AmountTotal"
+    Percentage = "Percentage"
+
+
+class PriceBreak(OrderCloudModel):
+    """An OrderCloud PriceBreak.
+
+    Attributes:
+        quantity: Most commonly 1, except when offering tiered/bulk pricing.
+        price: Price per unit.
+        sale_price: Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used.
+        subscription_price: Subscription Price per unit. If set, this price is used when a subscription order is created.
+        bundle_price: Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle.
+    """
+
+    quantity: Optional[int] = Field(None, alias="Quantity")
+    price: Optional[float] = Field(None, alias="Price")
+    sale_price: Optional[float] = Field(None, alias="SalePrice")
+    subscription_price: Optional[float] = Field(None, alias="SubscriptionPrice")
+    bundle_price: Optional[float] = Field(None, alias="BundlePrice")
+
+
+class PriceSchedule(OrderCloudModel, Generic[XP]):
+    """An OrderCloud PriceSchedule.
+
+    Attributes:
+        price_breaks:
+        owner_id: ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create.
+        id:
+        name:
+        apply_tax: For reference only for calculating tax, does not influence any OrderCloud behavior.
+        apply_shipping: For reference only for calculating shipping cost, does not influence any OrderCloud behavior.
+        min_quantity: The minimum line item Quantity when UseCumulativeQuantity is false.
+        max_quantity: The maximum line item Quantity when UseCumulativeQuantity is false.
+        use_cumulative_quantity: If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately.
+        restricted_quantity: If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule.
+        currency: We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.
+        sale_start: Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.
+        sale_end: Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.
+        is_on_sale: True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date. (read-only)
+        xp:
+    """
+
+    price_breaks: Optional[list[PriceBreak]] = Field(None, alias="PriceBreaks")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    apply_tax: Optional[bool] = Field(None, alias="ApplyTax")
+    apply_shipping: Optional[bool] = Field(None, alias="ApplyShipping")
+    min_quantity: int = Field(1, alias="MinQuantity")
+    max_quantity: Optional[int] = Field(None, alias="MaxQuantity")
+    use_cumulative_quantity: Optional[bool] = Field(None, alias="UseCumulativeQuantity")
+    restricted_quantity: Optional[bool] = Field(None, alias="RestrictedQuantity")
+    currency: Optional[str] = Field(None, alias="Currency")
+    sale_start: Optional[str] = Field(None, alias="SaleStart")
+    sale_end: Optional[str] = Field(None, alias="SaleEnd")
+    is_on_sale: Optional[bool] = Field(None, alias="IsOnSale")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/product.py

@@ -0,0 +1,227 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Inventory and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .price_schedule import PriceMarkupType
+
+__all__ = [
+    "Inventory",
+    "VariantInventory",
+    "VariantSpec",
+    "VariantOverrides",
+    "Variant",
+    "AdHocProduct",
+    "ProductSupplier",
+    "Product",
+]
+_PriceMarkupType = PriceMarkupType
+
+
+class Inventory(OrderCloudModel):
+    """An OrderCloud Inventory.
+
+    Attributes:
+        enabled: If true, inventory will be tracked and enforced.
+        notification_point:
+        variant_level_tracking: If true, QuantityAvailable will be determined at the variant level.
+        order_can_exceed: If true, a user can create line items and place orders for the product even if there is insufficient QuantityAvailable.
+        quantity_available: Automatically decrements on order submit. If you utilize inventory records either at the product or variant level, this property becomes readonly, and is derived from the sum of all QuantityAvailable of each InventoryRecord. If VariantLevelTracking is enabled, this is the sum of all variant quantities.
+        last_updated:  (read-only)
+    """
+
+    enabled: Optional[bool] = Field(None, alias="Enabled")
+    notification_point: Optional[int] = Field(None, alias="NotificationPoint")
+    variant_level_tracking: Optional[bool] = Field(None, alias="VariantLevelTracking")
+    order_can_exceed: Optional[bool] = Field(None, alias="OrderCanExceed")
+    quantity_available: Optional[int] = Field(None, alias="QuantityAvailable")
+    last_updated: Optional[str] = Field(None, alias="LastUpdated")
+
+
+class VariantInventory(OrderCloudModel):
+    """An OrderCloud VariantInventory.
+
+    Attributes:
+        quantity_available:
+        notification_point:
+        last_updated:  (read-only)
+    """
+
+    quantity_available: Optional[int] = Field(None, alias="QuantityAvailable")
+    notification_point: Optional[int] = Field(None, alias="NotificationPoint")
+    last_updated: Optional[str] = Field(None, alias="LastUpdated")
+
+
+class VariantSpec(OrderCloudModel):
+    """An OrderCloud VariantSpec.
+
+    Attributes:
+        spec_id:
+        name:  (read-only)
+        option_id:
+        value:
+        price_markup_type:
+        price_markup:
+    """
+
+    spec_id: Optional[str] = Field(None, alias="SpecID")
+    name: Optional[str] = Field(None, alias="Name")
+    option_id: Optional[str] = Field(None, alias="OptionID")
+    value: Optional[str] = Field(None, alias="Value")
+    price_markup_type: Optional[_PriceMarkupType] = Field(None, alias="PriceMarkupType")
+    price_markup: Optional[float] = Field(None, alias="PriceMarkup")
+
+
+class VariantOverrides(OrderCloudModel):
+    """An OrderCloud VariantOverrides.
+
+    Attributes:
+        active: Overrides the Active value inherited from the product when generating variants.
+    """
+
+    active: bool = Field(True, alias="Active")
+
+
+class Variant(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Variant.
+
+    Attributes:
+        id:
+        name:
+        description:
+        active: If false, variant is not visible or purchasable from a buyer's perspective.
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        inventory:
+        specs:  (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    active: Optional[bool] = Field(None, alias="Active")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    inventory: Optional[VariantInventory] = Field(None, alias="Inventory")
+    specs: Optional[list[VariantSpec]] = Field(None, alias="Specs")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class AdHocProduct(OrderCloudModel, Generic[XP]):
+    """An OrderCloud AdHocProduct.
+
+    Attributes:
+        id:
+        name:
+        description:
+        quantity_multiplier: Informational only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        default_supplier_id: Used for forwarding orders to suppliers.
+        returnable:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    quantity_multiplier: int = Field(1, alias="QuantityMultiplier")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
+    returnable: Optional[bool] = Field(None, alias="Returnable")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ProductSupplier(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductSupplier.
+
+    Attributes:
+        default_price_schedule_id:
+        id:
+        name:
+        active: If false, all user authentication is blocked.
+        date_created:  (read-only)
+        all_buyers_can_order: If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to.
+        xp:
+    """
+
+    default_price_schedule_id: Optional[str] = Field(None, alias="DefaultPriceScheduleID")
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    active: Optional[bool] = Field(None, alias="Active")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    all_buyers_can_order: Optional[bool] = Field(None, alias="AllBuyersCanOrder")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class Product(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Product.
+
+    Attributes:
+        owner_id: ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create.
+        default_price_schedule_id: When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided.
+        auto_forward: If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID.
+        id:
+        parent_id: ID of the parent product. If not null, IsParent should be false
+        is_parent: If true, ParentID must be null, as a parent product cannot have a parent itself.
+        is_bundle: If true, IsParent must be false, as a parent product cannot be a bundle. (read-only)
+        name:
+        description:
+        quantity_multiplier: For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        active: If false, product is not visible or purchasable from a buyer's perspective.
+        spec_count: Count of specs assigned to the product. (read-only)
+        variant_count: Count of variants generated from the product/spec combinations. (read-only)
+        ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
+        inventory:
+        default_supplier_id: Used for forwarding orders to suppliers.
+        all_suppliers_can_sell: If true, all suppliers are eligible to opt into selling this product.
+        returnable:
+        date_created:  (read-only)
+        xp:
+    """
+
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    default_price_schedule_id: Optional[str] = Field(None, alias="DefaultPriceScheduleID")
+    auto_forward: Optional[bool] = Field(None, alias="AutoForward")
+    id: Optional[str] = Field(None, alias="ID")
+    parent_id: Optional[str] = Field(None, alias="ParentID")
+    is_parent: Optional[bool] = Field(None, alias="IsParent")
+    is_bundle: Optional[bool] = Field(None, alias="IsBundle")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    quantity_multiplier: int = Field(1, alias="QuantityMultiplier")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    active: Optional[bool] = Field(None, alias="Active")
+    spec_count: int = Field(0, alias="SpecCount")
+    variant_count: int = Field(0, alias="VariantCount")
+    ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
+    inventory: Optional[_Inventory] = Field(None, alias="Inventory")
+    default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
+    all_suppliers_can_sell: Optional[bool] = Field(None, alias="AllSuppliersCanSell")
+    returnable: Optional[bool] = Field(None, alias="Returnable")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+_Inventory = Inventory

ordercloud/models/product_collection.py

@@ -0,0 +1,186 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ProductCollectionEntry and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .buyer import BuyerPriceSchedule
+from .misc import AccessLevel
+from .product import Inventory
+
+__all__ = [
+    "ProductCollectionEntry",
+    "ProductCollectionProduct",
+    "ProductCollectionBuyerProduct",
+    "ProductCollectionInvitation",
+    "ProductCollection",
+]
+_Inventory = Inventory
+_AccessLevel = AccessLevel
+
+
+class ProductCollectionEntry(OrderCloudModel):
+    """An OrderCloud ProductCollectionEntry.
+
+    Attributes:
+        product_id:
+        list_order:
+    """
+
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+
+
+class ProductCollectionProduct(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductCollectionProduct.
+
+    Attributes:
+        list_order:
+        date_added:
+        owner_id: ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create.
+        default_price_schedule_id: When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided.
+        auto_forward: If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID.
+        id:
+        parent_id: ID of the parent product. If not null, IsParent should be false
+        is_parent: If true, ParentID must be null, as a parent product cannot have a parent itself.
+        is_bundle: If true, IsParent must be false, as a parent product cannot be a bundle. (read-only)
+        name:
+        description:
+        quantity_multiplier: For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        active: If false, product is not visible or purchasable from a buyer's perspective.
+        spec_count: Count of specs assigned to the product. (read-only)
+        variant_count: Count of variants generated from the product/spec combinations. (read-only)
+        ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
+        inventory:
+        default_supplier_id: Used for forwarding orders to suppliers.
+        all_suppliers_can_sell: If true, all suppliers are eligible to opt into selling this product.
+        returnable:
+        date_created:  (read-only)
+        xp:
+    """
+
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+    date_added: Optional[str] = Field(None, alias="DateAdded")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    default_price_schedule_id: Optional[str] = Field(None, alias="DefaultPriceScheduleID")
+    auto_forward: Optional[bool] = Field(None, alias="AutoForward")
+    id: Optional[str] = Field(None, alias="ID")
+    parent_id: Optional[str] = Field(None, alias="ParentID")
+    is_parent: Optional[bool] = Field(None, alias="IsParent")
+    is_bundle: Optional[bool] = Field(None, alias="IsBundle")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    quantity_multiplier: int = Field(1, alias="QuantityMultiplier")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    active: Optional[bool] = Field(None, alias="Active")
+    spec_count: int = Field(0, alias="SpecCount")
+    variant_count: int = Field(0, alias="VariantCount")
+    ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
+    inventory: Optional[_Inventory] = Field(None, alias="Inventory")
+    default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
+    all_suppliers_can_sell: Optional[bool] = Field(None, alias="AllSuppliersCanSell")
+    returnable: Optional[bool] = Field(None, alias="Returnable")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ProductCollectionBuyerProduct(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductCollectionBuyerProduct.
+
+    Attributes:
+        list_order:
+        date_added:
+        price_schedule:  (read-only)
+        id:
+        parent_id: ID of the parent product. If not null, IsParent should be false
+        is_parent: If true, ParentID must be null, as a parent product cannot have a parent itself.
+        is_bundle: If true, IsParent must be false, as a parent product cannot be a bundle. (read-only)
+        name:
+        description:
+        quantity_multiplier: For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        active: If false, product is not visible or purchasable from a buyer's perspective.
+        spec_count: Count of specs assigned to the product. (read-only)
+        variant_count: Count of variants generated from the product/spec combinations. (read-only)
+        ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
+        inventory:
+        default_supplier_id: Used for forwarding orders to suppliers.
+        all_suppliers_can_sell: If true, all suppliers are eligible to opt into selling this product.
+        returnable:
+        date_created:  (read-only)
+        xp:
+    """
+
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+    date_added: Optional[str] = Field(None, alias="DateAdded")
+    price_schedule: Optional[BuyerPriceSchedule] = Field(None, alias="PriceSchedule")
+    id: Optional[str] = Field(None, alias="ID")
+    parent_id: Optional[str] = Field(None, alias="ParentID")
+    is_parent: Optional[bool] = Field(None, alias="IsParent")
+    is_bundle: Optional[bool] = Field(None, alias="IsBundle")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    quantity_multiplier: int = Field(1, alias="QuantityMultiplier")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    active: Optional[bool] = Field(None, alias="Active")
+    spec_count: int = Field(0, alias="SpecCount")
+    variant_count: int = Field(0, alias="VariantCount")
+    ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
+    inventory: Optional[_Inventory] = Field(None, alias="Inventory")
+    default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
+    all_suppliers_can_sell: Optional[bool] = Field(None, alias="AllSuppliersCanSell")
+    returnable: Optional[bool] = Field(None, alias="Returnable")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ProductCollectionInvitation(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductCollectionInvitation.
+
+    Attributes:
+        id:  (read-only)
+        name:
+        admin:
+        accepted: Updated when accepted. (read-only)
+        expiration_date: ExpirationDate defaults to 30 days from create, maximum 1 year.
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    admin: bool = Field(False, alias="Admin")
+    accepted: bool = Field(False, alias="Accepted")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ProductCollection(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductCollection.
+
+    Attributes:
+        id:
+        name:
+        xp:
+        access_level:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    xp: Optional[XP] = Field(None, alias="xp")
+    access_level: Optional[_AccessLevel] = Field(None, alias="AccessLevel")