katana_public_api_client.models.sales_order_row

katana_public_api_client.models.sales_order_row

Classes

SalesOrderRow

Individual line item within a sales order representing a specific product variant, quantity, pricing, and delivery details

Example:
    {'id': 2501, 'quantity': 2, 'variant_id': 2101, 'tax_rate_id': 301, 'location_id': 1, 'product_availability':
        'IN_STOCK', 'product_expected_date': None, 'price_per_unit': '599.9900000000',
        'price_per_unit_in_base_currency': 599.99, 'total': 1199.98, 'total_in_base_currency': 1199.98, 'cogs_value':
        '400.0000000000', 'attributes': [{'key': 'engrave_text', 'value': "Johnson's Kitchen"}, {'key': 'gift_wrap',
        'value': 'true'}], 'batch_transactions': [{'batch_id': 1801, 'quantity': 2.0}], 'serial_numbers': [10001,
        10002], 'linked_manufacturing_order_id': None, 'conversion_rate': 1.0, 'conversion_date':
        '2024-01-15T10:00:00Z', 'created_at': '2024-01-15T10:00:00Z', 'updated_at': '2024-01-15T10:00:00Z'}

Attributes:
    id (int): Unique identifier for the sales order row
    quantity (float): Ordered quantity of the product variant
    variant_id (int): ID of the product variant being ordered
    created_at (datetime.datetime | Unset): Timestamp when the entity was first created
    updated_at (datetime.datetime | Unset): Timestamp when the entity was last updated
    deleted_at (datetime.datetime | None | Unset): Nullable deletion timestamp
    sales_order_id (int | Unset): ID of the sales order this row belongs to
    tax_rate_id (int | None | Unset): ID of the tax rate applied to this line item
    tax_rate (float | None | Unset): Tax rate percentage applied to this line item
    location_id (int | None | Unset): Location where the product should be picked from
    product_availability (None | ProductAvailability | Unset): Current availability status of the product for this
        order row
    product_expected_date (datetime.datetime | None | Unset): Expected date when the product will be available if
        not currently in stock
    price_per_unit (str | Unset): Selling price per unit in the order currency
    price_per_unit_in_base_currency (float | Unset): Selling price per unit converted to the base company currency
    total (float | Unset): Total line amount (quantity * price_per_unit) in order currency
    total_in_base_currency (float | Unset): Total line amount converted to the base company currency
    total_discount (None | str | Unset): Discount amount applied to this line item
    cogs_value (None | str | Unset): Cost of goods sold value for this line item, null when not yet computed
    attributes (list[SalesOrderRowAttributesItem] | Unset): Custom attributes associated with this sales order row
    batch_transactions (list[SalesOrderRowBatchTransactionsItem] | Unset): Batch allocations for this order row when
        using batch tracking
    serial_numbers (list[int] | Unset): Serial numbers allocated to this order row for serialized products
    serial_number_transactions (list[SalesOrderRowSerialNumberTransactionsItem] | Unset): Audit trail of serial-
        number actions on this row. Each entry records
        whether a serial number was added (``quantity: 1``) or removed
        (``quantity: 0``). Use this for incremental updates; ``serial_numbers``
        reflects the resulting current state.
    linked_manufacturing_order_id (int | None | Unset): ID of the manufacturing order linked to this sales order row
        for make-to-order items
    conversion_rate (float | None | Unset): Currency conversion rate used for this row
    conversion_date (datetime.datetime | None | Unset): Date when the currency conversion rate was applied
    custom_fields (None | SalesOrderRowCustomFieldsType0 | Unset): Row-level custom field values, keyed by the
        definition ``id`` (UUID) — the ``id`` returned by
        ``GET /custom_field_definitions``, not the field label.
        Each value matches the definition's ``field_type``: string
        for ``shortText`` / ``url``, number for ``number``, boolean
        for ``boolean``, a ``YYYY-MM-DD`` string for ``date``, or
        the integer choice ``id`` for ``singleSelect``. ``null``
        when no values are set on the row. Values for soft-deleted
        definitions are stripped from read responses. Keys are
        tenant-specific, so the schema declares
        ``additionalProperties: true`` rather than enumerating
        them.