ssactivewear_sdk ================ .. py:module:: ssactivewear_sdk .. autoapi-nested-parse:: A wrapper for S&S' API. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/ssactivewear_sdk/client/index /autoapi/ssactivewear_sdk/exceptions/index /autoapi/ssactivewear_sdk/models/index Exceptions ---------- .. autoapisummary:: ssactivewear_sdk.SSActivewearBadRequestError ssactivewear_sdk.SSActivewearError Classes ------- .. autoapisummary:: ssactivewear_sdk.SSActivewear ssactivewear_sdk.OrderRequest ssactivewear_sdk.OrderRequestOrderLine ssactivewear_sdk.OrderRequestPaymentProfile ssactivewear_sdk.OrderRequestShippingAddress ssactivewear_sdk.OrderResponse ssactivewear_sdk.OrderResponseLine ssactivewear_sdk.OrderResponseShippingAddress ssactivewear_sdk.Product ssactivewear_sdk.Warehouse Package Contents ---------------- .. py:class:: SSActivewear(account_number: str, token: str, base_url: str = 'https://api.ssactivewear.com/v2') A class wrapping S&S' API. .. py:attribute:: http_client .. py:method:: _make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None, timeout: float | None = None) -> dict[str, Any] Make a request to SSActivewear. .. py:method:: products() -> list[ssactivewear_sdk.models.Product] Get all products. .. py:method:: submit_order(order_request: ssactivewear_sdk.models.OrderRequest) -> ssactivewear_sdk.models.OrderResponseContainer Submit an order to S&S Activewear. .. py:exception:: SSActivewearBadRequestError(message: str, response: ssactivewear_sdk.models.ErrorResponse) Bases: :py:obj:`SSActivewearError` Exception raised for bad requests to SSActivewear API. .. py:attribute:: response .. py:exception:: SSActivewearError Bases: :py:obj:`Exception` Base exception for SSActivewear SDK errors. .. py:class:: OrderRequest(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Order creation request. .. py:attribute:: shipping_address :type: OrderRequestShippingAddress :value: None .. py:attribute:: lines :type: list[OrderRequestOrderLine] :value: None .. py:attribute:: shipping_method :type: Literal['1', '2', '3', '6', '8', '14', '16', '17', '19', '20', '21', '22', '26', '27', '40', '48', '54'] :value: None .. py:attribute:: ship_blind :type: bool | None :value: None .. py:attribute:: po_number :type: str :value: None .. py:attribute:: email_confirmation :type: str :value: None .. py:attribute:: test_order :type: bool :value: None .. py:attribute:: autoselect_warehouse :type: bool :value: None .. py:attribute:: promotion_code :type: str | None :value: None .. py:attribute:: autoselect_warehouse_warehouses :type: str | None :value: None .. py:attribute:: autoselect_warehouse_preference :type: Literal['fewest', 'fastest'] :value: None .. py:attribute:: autoselect_warehouse_fewest_max_dit :type: int :value: None .. py:attribute:: reject_line_errors :type: bool :value: None .. py:attribute:: reject_line_errors_email :type: bool :value: None .. py:attribute:: payment_profile :type: OrderRequestPaymentProfile | None :value: None .. py:class:: OrderRequestOrderLine(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Order line item. .. py:attribute:: identifier :type: str :value: None .. py:attribute:: quantity :type: int :value: None .. py:attribute:: warehouse_abbreviation :type: str | None :value: None .. py:class:: OrderRequestPaymentProfile(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Payment profile information. This is used of you would like to pay via a saved credit card or bank account on your www.ssactivewear.com website account. .. py:attribute:: email :type: pydantic.EmailStr :value: None .. py:attribute:: profile_id :type: int :value: None .. py:class:: OrderRequestShippingAddress(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Shipping address for an order. .. py:attribute:: customer :type: str :value: None .. py:attribute:: attention_to :type: str :value: None .. py:attribute:: address :type: str :value: None .. py:attribute:: city :type: str :value: None .. py:attribute:: state :type: str :value: None .. py:attribute:: postal_code :type: str :value: None .. py:attribute:: residential :type: bool :value: None .. py:class:: OrderResponse(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Order response. .. py:attribute:: guid :type: uuid.UUID :value: None .. py:attribute:: company_name :type: str :value: None .. py:attribute:: warehouse_abbr :type: str :value: None .. py:attribute:: order_number :type: str :value: None .. py:attribute:: invoice_number :type: str :value: None .. py:attribute:: po_number :type: str :value: None .. py:attribute:: customer_number :type: str :value: None .. py:attribute:: order_date :type: datetime.datetime :value: None .. py:attribute:: expected_delivery_date :type: datetime.date :value: None .. py:attribute:: order_type :type: str :value: None .. py:attribute:: terms :type: str :value: None .. py:attribute:: order_status :type: str :value: None .. py:attribute:: dropship :type: bool :value: None .. py:attribute:: shipping_carrier :type: str :value: None .. py:attribute:: shipping_method :type: str :value: None .. py:attribute:: ship_blind :type: bool :value: None .. py:attribute:: shipping_collect_number :type: str :value: None .. py:attribute:: shipping_address :type: OrderResponseShippingAddress :value: None .. py:attribute:: subtotal :type: float :value: None .. py:attribute:: shipping :type: float :value: None .. py:attribute:: cod :type: float :value: None .. py:attribute:: tax :type: float :value: None .. py:attribute:: small_order_fee :type: float :value: None .. py:attribute:: cupon_discount :type: float :value: None .. py:attribute:: sample_discount :type: float :value: None .. py:attribute:: set_up_fee :type: float :value: None .. py:attribute:: restock_fee :type: float :value: None .. py:attribute:: debit_credit :type: float :value: None .. py:attribute:: total :type: float :value: None .. py:attribute:: total_pieces :type: int :value: None .. py:attribute:: total_lines :type: int :value: None .. py:attribute:: total_weight :type: float :value: None .. py:attribute:: total_boxes :type: int :value: None .. py:attribute:: delivery_status :type: str :value: None .. py:attribute:: conveyor_lane :type: str :value: None .. py:attribute:: lines :type: list[OrderResponseLine] :value: None .. py:attribute:: shipping_saved :type: float :value: None .. py:class:: OrderResponseLine(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Order line item in response. .. py:attribute:: line_number :type: int :value: None .. py:attribute:: type :type: str :value: None .. py:attribute:: sku_id :type: int :value: None .. py:attribute:: sku :type: str :value: None .. py:attribute:: gtin :type: str :value: None .. py:attribute:: your_sku :type: str :value: None .. py:attribute:: qty_ordered :type: int :value: None .. py:attribute:: price :type: float :value: None .. py:attribute:: brand_name :type: str :value: None .. py:attribute:: style_name :type: str :value: None .. py:attribute:: title :type: str :value: None .. py:attribute:: color_name :type: str :value: None .. py:attribute:: size_name :type: str :value: None .. py:attribute:: returnable :type: bool :value: None .. py:class:: OrderResponseShippingAddress(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Shipping address in order response. .. py:attribute:: customer :type: str :value: None .. py:attribute:: attn :type: str :value: None .. py:attribute:: address :type: str :value: None .. py:attribute:: city :type: str :value: None .. py:attribute:: state :type: str :value: None .. py:attribute:: zip :type: str :value: None .. py:class:: Product(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Product. .. py:attribute:: sku_id_master :type: int :value: None .. py:attribute:: sku :type: str :value: None .. py:attribute:: gtin :type: str :value: None .. py:attribute:: your_sku :type: str :value: None .. py:attribute:: base_category_id :type: str :value: None .. py:attribute:: brand_id :type: str :value: None .. py:attribute:: brand_name :type: str :value: None .. py:attribute:: style_id :type: int :value: None .. py:attribute:: style_name :type: str :value: None .. py:attribute:: color_name :type: str :value: None .. py:attribute:: color_code :type: str :value: None .. py:attribute:: color_price_code_name :type: str :value: None .. py:attribute:: color_group :type: str :value: None .. py:attribute:: color_group_name :type: str :value: None .. py:attribute:: color_family_id :type: str :value: None .. py:attribute:: color_family :type: str :value: None .. py:attribute:: color_swatch_image :type: str :value: None .. py:attribute:: color_swatch_text_color :type: str :value: None .. py:attribute:: color_front_image :type: str :value: None .. py:attribute:: color_side_image :type: str :value: None .. py:attribute:: color_back_image :type: str :value: None .. py:attribute:: color_direct_side_image :type: str :value: None .. py:attribute:: color_on_model_front_image :type: str :value: None .. py:attribute:: color_on_model_side_image :type: str :value: None .. py:attribute:: color_on_model_back_image :type: str :value: None .. py:attribute:: color1 :type: str :value: None .. py:attribute:: color2 :type: str :value: None .. py:attribute:: size_name :type: str :value: None .. py:attribute:: size_code :type: str :value: None .. py:attribute:: size_order :type: str :value: None .. py:attribute:: size_price_code_name :type: str :value: None .. py:attribute:: case_qty :type: int :value: None .. py:attribute:: unit_weight :type: float :value: None .. py:attribute:: map_price :type: float :value: None .. py:attribute:: piece_price :type: float :value: None .. py:attribute:: dozen_price :type: float :value: None .. py:attribute:: case_price :type: float :value: None .. py:attribute:: sale_price :type: float :value: None .. py:attribute:: customer_price :type: float :value: None .. py:attribute:: no_eretailing :type: bool :value: None .. py:attribute:: case_weight :type: float :value: None .. py:attribute:: case_width :type: float :value: None .. py:attribute:: case_length :type: float :value: None .. py:attribute:: case_height :type: float :value: None .. py:attribute:: poly_pack_quantity :type: int :value: None .. py:attribute:: quantity :type: int :value: None .. py:attribute:: country_of_origin :type: str :value: None .. py:attribute:: warehouses :type: list[Warehouse] :value: None .. py:attribute:: sale_expiration :type: datetime.datetime | None :value: None .. py:class:: Warehouse(/, **data: Any) Bases: :py:obj:`ssactivewear_sdk.models._base.SSActivewearBaseModel` Warehouse. .. py:attribute:: warehouse_abbr :type: str :value: None .. py:attribute:: sku_id :type: int :value: None .. py:attribute:: qty :type: int :value: None .. py:attribute:: closeout :type: bool :value: None .. py:attribute:: dropship :type: bool :value: None .. py:attribute:: exclude_free_freight :type: bool :value: None .. py:attribute:: full_case_only :type: bool :value: None .. py:attribute:: returnable :type: bool :value: None .. py:attribute:: expected_inventory :type: str | None :value: None