# This file was auto-generated by Fern from our API Definition.

import typing

import typing_extensions
from .update_transfer_order_line_data import UpdateTransferOrderLineDataParams


class UpdateTransferOrderDataParams(typing_extensions.TypedDict):
    """
    Data model for updating a transfer order. All fields are optional.
    """

    source_location_id: typing_extensions.NotRequired[typing.Optional[str]]
    """
    The source [Location](entity:Location) that will send the items. Must be an active location
    in your Square account with sufficient inventory of the requested items.
    """

    destination_location_id: typing_extensions.NotRequired[typing.Optional[str]]
    """
    The destination [Location](entity:Location) that will receive the items. Must be an active location
    in your Square account.
    """

    expected_at: typing_extensions.NotRequired[typing.Optional[str]]
    """
    Expected transfer date in RFC 3339 format (e.g. "2023-10-01T12:00:00Z").
    """

    notes: typing_extensions.NotRequired[typing.Optional[str]]
    """
    Optional notes about the transfer
    """

    tracking_number: typing_extensions.NotRequired[typing.Optional[str]]
    """
    Shipment tracking number
    """

    line_items: typing_extensions.NotRequired[typing.Optional[typing.Sequence[UpdateTransferOrderLineDataParams]]]
    """
    List of items being transferred
    """
