shipstation_sdk
===============

.. py:module:: shipstation_sdk

.. autoapi-nested-parse::

   ShipStation API SDK.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/shipstation_sdk/client/index
   /autoapi/shipstation_sdk/models/index


Classes
-------

.. autoapisummary::

   shipstation_sdk.ShipStationClient


Package Contents
----------------

.. py:class:: ShipStationClient(base_url: str, client_id: str, client_secret: str, timeout: float)

   A class wrapping ShipStation interaction.


   .. py:attribute:: client


   .. py:method:: make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) -> httpx.Response

      Make a request to ShipStation.



   .. py:method:: get_shipments(ship_date_start: datetime.date | None = None, ship_date_end: datetime.date | None = None) -> shipstation_sdk.models.ShipmentsList

      Get a list of shipments.



   .. py:method:: get_orders(create_date_start: datetime.date | None = None, create_date_end: datetime.date | None = None, store_id: int | None = None) -> shipstation_sdk.models.OrdersList

      Get a list of orders.