shipstation_sdk.parameters¶

Parameters for ShipStation API requests.

Attributes¶

`OrderStatus`
`OrderSortKey`
`SortDirection`

Classes¶

OrderListParameters

Parameters for listing orders.

Module Contents¶

type shipstation_sdk.parameters.OrderStatus = Literal['awaiting_payment', 'awaiting_shipment', 'pending_fulfillment', 'shipped', 'on_hold', 'cancelled', 'rejected_fulfillment'][source]¶

type shipstation_sdk.parameters.OrderSortKey = Literal['OrderDate', 'ModifyDate', 'CreateDate'][source]¶

type shipstation_sdk.parameters.SortDirection = Literal['ASC', 'DESC'][source]¶

class shipstation_sdk.parameters.OrderListParameters(/, **data: Any)[source]¶

Bases: pydantic.BaseModel

Parameters for listing orders.

customer_name: str | None = None[source]¶

item_keyword: str | None = None[source]¶

create_date_start: datetime.date | None = None[source]¶

create_date_end: datetime.date | None = None[source]¶

modify_date_start: datetime.date | None = None[source]¶

modify_date_end: datetime.date | None = None[source]¶

order_date_start: datetime.date | None = None[source]¶

order_date_end: datetime.date | None = None[source]¶

order_number: str | None = None[source]¶

order_status: OrderStatus | None = None[source]¶

payment_date_start: datetime.date | None = None[source]¶

payment_date_end: datetime.date | None = None[source]¶

store_id: int | None = None[source]¶

sort_by: OrderSortKey | None = None[source]¶

sort_dir: SortDirection | None = None[source]¶

page: int | None = None[source]¶

page_size: int | None = None[source]¶