shipstation_sdk.models ====================== .. py:module:: shipstation_sdk.models .. autoapi-nested-parse:: ShipStation API models. Attributes ---------- .. autoapisummary:: shipstation_sdk.models.LA_TIMEZONE Classes ------- .. autoapisummary:: shipstation_sdk.models.Address shipstation_sdk.models.Weight shipstation_sdk.models.Dimensions shipstation_sdk.models.InsuranceOptions shipstation_sdk.models.AdvancedOptions shipstation_sdk.models.Shipment shipstation_sdk.models.ShipmentsList shipstation_sdk.models.Option shipstation_sdk.models.Item shipstation_sdk.models.CustomsItem shipstation_sdk.models.InternationalOptions shipstation_sdk.models.Order shipstation_sdk.models.OrdersList Module Contents --------------- .. py:data:: LA_TIMEZONE .. py:class:: Address(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for an address. .. py:attribute:: name :type: str | None .. py:attribute:: company :type: str | None .. py:attribute:: street1 :type: str | None .. py:attribute:: street2 :type: str | None .. py:attribute:: street3 :type: str | None .. py:attribute:: city :type: str | None .. py:attribute:: state :type: str | None .. py:attribute:: postal_code :type: str | None :value: None .. py:attribute:: country :type: str | None .. py:attribute:: phone :type: str | None .. py:attribute:: residential :type: bool | None .. py:attribute:: address_verified :type: str | None :value: None .. py:class:: Weight(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for the weight of the shipment. .. py:attribute:: value :type: float .. py:attribute:: units :type: str .. py:attribute:: weight_units :type: int :value: None .. py:class:: Dimensions(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for the dimensions of the shipment. .. py:attribute:: units :type: str .. py:attribute:: length :type: float .. py:attribute:: width :type: float .. py:attribute:: height :type: float .. py:class:: InsuranceOptions(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for insurance options. .. py:attribute:: provider :type: str | None .. py:attribute:: insure_shipment :type: bool :value: None .. py:attribute:: insured_value :type: float :value: None .. py:class:: AdvancedOptions(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for advanced options. .. py:attribute:: bill_to_party :type: str | None :value: None .. py:attribute:: bill_to_account :type: str | None :value: None .. py:attribute:: bill_to_postal_code :type: str | None :value: None .. py:attribute:: bill_to_country_code :type: str | None :value: None .. py:attribute:: store_id :type: int :value: None .. py:class:: Shipment(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for a shipment. .. py:attribute:: shipment_id :type: int :value: None .. py:attribute:: order_id :type: int :value: None .. py:attribute:: order_key :type: str :value: None .. py:attribute:: user_id :type: str :value: None .. py:attribute:: customer_email :type: str | None :value: None .. py:attribute:: order_number :type: str :value: None .. py:attribute:: create_date :type: datetime.datetime :value: None .. py:attribute:: ship_date :type: datetime.date :value: None .. py:attribute:: shipment_cost :type: float :value: None .. py:attribute:: insurance_cost :type: float :value: None .. py:attribute:: tracking_number :type: str :value: None .. py:attribute:: is_return_label :type: bool :value: None .. py:attribute:: batch_number :type: int | None :value: None .. py:attribute:: carrier_code :type: str :value: None .. py:attribute:: service_code :type: str :value: None .. py:attribute:: package_code :type: str | None :value: None .. py:attribute:: confirmation :type: bool | None .. py:attribute:: warehouse_id :type: int :value: None .. py:attribute:: voided :type: bool .. py:attribute:: void_date :type: str | None :value: None .. py:attribute:: marketplace_notified :type: bool :value: None .. py:attribute:: notify_error_message :type: str | None :value: None .. py:attribute:: ship_to :type: Address :value: None .. py:attribute:: weight :type: Weight .. py:attribute:: dimensions :type: Dimensions | None .. py:attribute:: insurance_options :type: InsuranceOptions :value: None .. py:attribute:: advanced_options :type: AdvancedOptions :value: None .. py:attribute:: shipment_items :type: None :value: None .. py:attribute:: label_data :type: None :value: None .. py:attribute:: form_data :type: None :value: None .. py:method:: add_timezones(value: datetime.datetime) -> datetime.datetime :classmethod: Add timezone information to datetime fields. .. py:class:: ShipmentsList(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Response model for Shipments API. .. py:attribute:: shipments :type: list[Shipment] .. py:attribute:: total :type: int .. py:attribute:: page :type: int .. py:attribute:: pages :type: int .. py:class:: Option(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for an order item option. .. py:attribute:: name :type: str .. py:attribute:: value :type: str .. py:class:: Item(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for an order item. .. py:attribute:: order_item_id :type: int :value: None .. py:attribute:: line_item_key :type: str | None :value: None .. py:attribute:: sku :type: str .. py:attribute:: name :type: str .. py:attribute:: image_url :type: str | None :value: None .. py:attribute:: weight :type: Weight | None .. py:attribute:: quantity :type: int .. py:attribute:: unit_price :type: float :value: None .. py:attribute:: tax_amount :type: float | None :value: None .. py:attribute:: shipping_amount :type: float | None :value: None .. py:attribute:: warehouse_location :type: str | None :value: None .. py:attribute:: options :type: list[Option] .. py:attribute:: product_id :type: int | None :value: None .. py:attribute:: fulfillment_sku :type: str | None :value: None .. py:attribute:: adjustment :type: bool .. py:attribute:: upc :type: str | None .. py:attribute:: create_date :type: str :value: None .. py:attribute:: modify_date :type: str :value: None .. py:class:: CustomsItem(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for customs item. .. py:attribute:: customs_item_id :type: int :value: None .. py:attribute:: description :type: str .. py:attribute:: quantity :type: int .. py:attribute:: value :type: float .. py:attribute:: harmonized_tariff_code :type: str | None :value: None .. py:attribute:: country_of_origin :type: str :value: None .. py:class:: InternationalOptions(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for international shipping options. .. py:attribute:: contents :type: str | None .. py:attribute:: customs_items :type: list[CustomsItem] | None :value: None .. py:attribute:: non_delivery :type: str | None :value: None .. py:class:: Order(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for an order. .. py:attribute:: order_id :type: int :value: None .. py:attribute:: order_number :type: str :value: None .. py:attribute:: order_key :type: str :value: None .. py:attribute:: order_date :type: datetime.datetime :value: None .. py:attribute:: create_date :type: datetime.datetime :value: None .. py:attribute:: modify_date :type: datetime.datetime :value: None .. py:attribute:: payment_date :type: datetime.datetime | None :value: None .. py:attribute:: ship_by_date :type: datetime.datetime | None :value: None .. py:attribute:: order_status :type: str | None :value: None .. py:attribute:: customer_id :type: int | None :value: None .. py:attribute:: customer_username :type: str | None :value: None .. py:attribute:: customer_email :type: str | None :value: None .. py:attribute:: bill_to :type: Address :value: None .. py:attribute:: ship_to :type: Address :value: None .. py:attribute:: items :type: list[Item] | None .. py:attribute:: order_total :type: float | None :value: None .. py:attribute:: amount_paid :type: float | None :value: None .. py:attribute:: tax_amount :type: float | None :value: None .. py:attribute:: shipping_amount :type: float | None :value: None .. py:attribute:: customer_notes :type: str | None :value: None .. py:attribute:: internal_notes :type: str | None :value: None .. py:attribute:: gift :type: bool .. py:attribute:: gift_message :type: str | None :value: None .. py:attribute:: payment_method :type: str | None :value: None .. py:attribute:: requested_shipping_service :type: str | None :value: None .. py:attribute:: carrier_code :type: str | None :value: None .. py:attribute:: service_code :type: str | None :value: None .. py:attribute:: package_code :type: str | None :value: None .. py:attribute:: confirmation :type: str .. py:attribute:: ship_date :type: datetime.date | None :value: None .. py:attribute:: hold_until_date :type: datetime.date | None :value: None .. py:attribute:: weight :type: Weight .. py:attribute:: dimensions :type: Dimensions | None .. py:attribute:: insurance_options :type: InsuranceOptions :value: None .. py:attribute:: international_options :type: InternationalOptions :value: None .. py:attribute:: advanced_options :type: AdvancedOptions :value: None .. py:attribute:: tag_ids :type: list[int] | None :value: None .. py:attribute:: user_id :type: list[str] | None :value: None .. py:attribute:: externally_fulfilled :type: bool :value: None .. py:attribute:: externally_fulfilled_by :type: str | None :value: None .. py:attribute:: externally_fulfilled_by_id :type: int | None :value: None .. py:attribute:: externally_fulfilled_by_name :type: str | None :value: None .. py:method:: add_timezones(value: datetime.datetime | None) -> datetime.datetime | None :classmethod: Add timezone information to datetime fields. .. py:class:: OrdersList(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Model for a list of orders. .. py:attribute:: orders :type: list[Order] .. py:attribute:: total :type: int .. py:attribute:: page :type: int .. py:attribute:: pages :type: int