shipstation_sdk.parameters
==========================

.. py:module:: shipstation_sdk.parameters

.. autoapi-nested-parse::

   Parameters for ShipStation API requests.



Attributes
----------

.. autoapisummary::

   shipstation_sdk.parameters.OrderStatus
   shipstation_sdk.parameters.OrderSortKey
   shipstation_sdk.parameters.SortDirection


Classes
-------

.. autoapisummary::

   shipstation_sdk.parameters.OrderListParameters


Module Contents
---------------

.. py:type:: OrderStatus
   :canonical: Literal['awaiting_payment', 'awaiting_shipment', 'pending_fulfillment', 'shipped', 'on_hold', 'cancelled', 'rejected_fulfillment']


.. py:type:: OrderSortKey
   :canonical: Literal['OrderDate', 'ModifyDate', 'CreateDate']


.. py:type:: SortDirection
   :canonical: Literal['ASC', 'DESC']


.. py:class:: OrderListParameters(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Parameters for listing orders.


   .. py:attribute:: customer_name
      :type:  str | None
      :value: None



   .. py:attribute:: item_keyword
      :type:  str | None
      :value: None



   .. py:attribute:: create_date_start
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: create_date_end
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: modify_date_start
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: modify_date_end
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: order_date_start
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: order_date_end
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: order_number
      :type:  str | None
      :value: None



   .. py:attribute:: order_status
      :type:  OrderStatus | None
      :value: None



   .. py:attribute:: payment_date_start
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: payment_date_end
      :type:  datetime.date | None
      :value: None



   .. py:attribute:: store_id
      :type:  int | None
      :value: None



   .. py:attribute:: sort_by
      :type:  OrderSortKey | None
      :value: None



   .. py:attribute:: sort_dir
      :type:  SortDirection | None
      :value: None



   .. py:attribute:: page
      :type:  int | None
      :value: None



   .. py:attribute:: page_size
      :type:  int | None
      :value: None