shipstation_sdk.parameters

Parameters for ShipStation API requests.

Attributes

ShipmentStatus
ShipmentSortKey
SortDirection

Classes

ShipmentListParameters

Parameters for listing shipments.

Module Contents

type shipstation_sdk.parameters.ShipmentStatus = Literal['pending', 'processing', 'label_purchased', 'cancelled']

type shipstation_sdk.parameters.ShipmentSortKey = Literal['modified_at', 'created_at']

type shipstation_sdk.parameters.SortDirection = Literal['asc', 'desc']

class shipstation_sdk.parameters.ShipmentListParameters(/, **data: Any)

Bases: pydantic.BaseModel

Parameters for listing shipments.

shipment_status: ShipmentStatus | None = None

store_id: str | None = None

batch_id: str | None = None

tag: str | None = None

sales_order_id: str | None = None

shipment_number: str | None = None

external_shipment_id: str | None = None

item_keyword: str | None = None

ship_to_name: str | None = None

created_at_start: datetime.datetime | None = None

created_at_end: datetime.datetime | None = None

modified_at_start: datetime.datetime | None = None

modified_at_end: datetime.datetime | None = None

payment_date_start: datetime.datetime | None = None

payment_date_end: datetime.datetime | None = None

sort_by: ShipmentSortKey | None = None

sort_dir: SortDirection | None = None

page: int | None = None

page_size: int | None = None