shipstation_sdk.models

ShipStation API models.

Attributes

LA_TIMEZONE

Classes

Address	Model for an address.
Weight	Model for the weight of the shipment.
Dimensions	Model for the dimensions of the shipment.
InsuranceOptions	Model for insurance options.
AdvancedOptions	Model for advanced options.
Shipment	Model for a shipment.
ShipmentsList	Response model for Shipments API.
Option	Model for an order item option.
Item	Model for an order item.
CustomsItem	Model for customs item.
InternationalOptions	Model for international shipping options.
Order	Model for an order.
OrdersList	Model for a list of orders.

Module Contents

shipstation_sdk.models.LA_TIMEZONE

class shipstation_sdk.models.Address(/, **data: Any)

Bases: pydantic.BaseModel

Model for an address.

name: str | None

company: str | None

street1: str | None

street2: str | None

street3: str | None

city: str | None

state: str | None

postal_code: str | None = None

country: str | None

phone: str | None

residential: bool | None

address_verified: str | None = None

class shipstation_sdk.models.Weight(/, **data: Any)

Bases: pydantic.BaseModel

Model for the weight of the shipment.

value: float

units: str

weight_units: int = None

class shipstation_sdk.models.Dimensions(/, **data: Any)

Bases: pydantic.BaseModel

Model for the dimensions of the shipment.

units: str

length: float

width: float

height: float

class shipstation_sdk.models.InsuranceOptions(/, **data: Any)

Bases: pydantic.BaseModel

Model for insurance options.

provider: str | None

insure_shipment: bool = None

insured_value: float = None

class shipstation_sdk.models.AdvancedOptions(/, **data: Any)

Bases: pydantic.BaseModel

Model for advanced options.

bill_to_party: str | None = None

bill_to_account: str | None = None

bill_to_postal_code: str | None = None

bill_to_country_code: str | None = None

store_id: int = None

class shipstation_sdk.models.Shipment(/, **data: Any)

Bases: pydantic.BaseModel

Model for a shipment.

shipment_id: int = None

order_id: int = None

order_key: str = None

user_id: str = None

customer_email: str | None = None

order_number: str = None

create_date: datetime.datetime = None

ship_date: datetime.date = None

shipment_cost: float = None

insurance_cost: float = None

tracking_number: str = None

is_return_label: bool = None

batch_number: int | None = None

carrier_code: str = None

service_code: str = None

package_code: str | None = None

confirmation: bool | None

warehouse_id: int = None

voided: bool

void_date: str | None = None

marketplace_notified: bool = None

notify_error_message: str | None = None

ship_to: Address = None

weight: Weight

dimensions: Dimensions | None

insurance_options: InsuranceOptions = None

advanced_options: AdvancedOptions = None

shipment_items: None = None

label_data: None = None

form_data: None = None

classmethod add_timezones(value: datetime.datetime) → datetime.datetime

Add timezone information to datetime fields.

class shipstation_sdk.models.ShipmentsList(/, **data: Any)

Bases: pydantic.BaseModel

Response model for Shipments API.

shipments: list[Shipment]

total: int

page: int

pages: int

class shipstation_sdk.models.Option(/, **data: Any)

Bases: pydantic.BaseModel

Model for an order item option.

name: str

value: str

class shipstation_sdk.models.Item(/, **data: Any)

Bases: pydantic.BaseModel

Model for an order item.

order_item_id: int = None

line_item_key: str | None = None

sku: str

name: str

image_url: str | None = None

weight: Weight | None

quantity: int

unit_price: float = None

tax_amount: float | None = None

shipping_amount: float | None = None

warehouse_location: str | None = None

options: list[Option]

product_id: int | None = None

fulfillment_sku: str | None = None

adjustment: bool

upc: str | None

create_date: str = None

modify_date: str = None

class shipstation_sdk.models.CustomsItem(/, **data: Any)

Bases: pydantic.BaseModel

Model for customs item.

customs_item_id: int = None

description: str

quantity: int

value: float

harmonized_tariff_code: str | None = None

country_of_origin: str = None

class shipstation_sdk.models.InternationalOptions(/, **data: Any)

Bases: pydantic.BaseModel

Model for international shipping options.

contents: str | None

customs_items: list[CustomsItem] | None = None

non_delivery: str | None = None

class shipstation_sdk.models.Order(/, **data: Any)

Bases: pydantic.BaseModel

Model for an order.

order_id: int = None

order_number: str = None

order_key: str = None

order_date: datetime.datetime = None

create_date: datetime.datetime = None

modify_date: datetime.datetime = None

payment_date: datetime.datetime | None = None

ship_by_date: datetime.datetime | None = None

order_status: str | None = None

customer_id: int | None = None

customer_username: str | None = None

customer_email: str | None = None

bill_to: Address = None

ship_to: Address = None

items: list[Item] | None

order_total: float | None = None

amount_paid: float | None = None

tax_amount: float | None = None

shipping_amount: float | None = None

customer_notes: str | None = None

internal_notes: str | None = None

gift: bool

gift_message: str | None = None

payment_method: str | None = None

requested_shipping_service: str | None = None

carrier_code: str | None = None

service_code: str | None = None

package_code: str | None = None

confirmation: str

ship_date: datetime.date | None = None

hold_until_date: datetime.date | None = None

weight: Weight

dimensions: Dimensions | None

insurance_options: InsuranceOptions = None

international_options: InternationalOptions = None

advanced_options: AdvancedOptions = None

tag_ids: list[int] | None = None

user_id: list[str] | None = None

externally_fulfilled: bool = None

externally_fulfilled_by: str | None = None

externally_fulfilled_by_id: int | None = None

externally_fulfilled_by_name: str | None = None

classmethod add_timezones(value: datetime.datetime | None) → datetime.datetime | None

Add timezone information to datetime fields.

class shipstation_sdk.models.OrdersList(/, **data: Any)

Bases: pydantic.BaseModel

Model for a list of orders.

orders: list[Order]

total: int

page: int

pages: int