ssactivewear_sdk

A wrapper for S&S’ API.

Submodules

• ssactivewear_sdk.client
• ssactivewear_sdk.exceptions
• ssactivewear_sdk.models

Exceptions

SSActivewearBadRequestError	Exception raised for bad requests to SSActivewear API.
SSActivewearError	Base exception for SSActivewear SDK errors.

Classes

SSActivewear	A class wrapping S&S' API.
OrderRequest	Order creation request.
OrderRequestOrderLine	Order line item.
OrderRequestPaymentProfile	Payment profile information.
OrderRequestShippingAddress	Shipping address for an order.
OrderResponse	Order response.
OrderResponseLine	Order line item in response.
OrderResponseShippingAddress	Shipping address in order response.
Product	Product.
Warehouse	Warehouse.

Package Contents

class ssactivewear_sdk.SSActivewear(account_number: str, token: str, base_url: str = 'https://api.ssactivewear.com/v2')

A class wrapping S&S’ API.

http_client

_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.

products() → list[ssactivewear_sdk.models.Product]

Get all products.

submit_order(order_request: ssactivewear_sdk.models.OrderRequest) → ssactivewear_sdk.models.OrderResponseContainer

Submit an order to S&S Activewear.

exception ssactivewear_sdk.SSActivewearBadRequestError(message: str, response: ssactivewear_sdk.models.ErrorResponse)

Bases: SSActivewearError

Exception raised for bad requests to SSActivewear API.

response

exception ssactivewear_sdk.SSActivewearError

Bases: Exception

Base exception for SSActivewear SDK errors.

class ssactivewear_sdk.OrderRequest(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Order creation request.

shipping_address: OrderRequestShippingAddress = None

lines: list[OrderRequestOrderLine] = None

shipping_method: Literal['1', '2', '3', '6', '8', '14', '16', '17', '19', '20', '21', '22', '26', '27', '40', '48', '54'] = None

ship_blind: bool | None = None

po_number: str = None

email_confirmation: str = None

test_order: bool = None

autoselect_warehouse: bool = None

promotion_code: str | None = None

autoselect_warehouse_warehouses: str | None = None

autoselect_warehouse_preference: Literal['fewest', 'fastest'] = None

autoselect_warehouse_fewest_max_dit: int = None

reject_line_errors: bool = None

reject_line_errors_email: bool = None

payment_profile: OrderRequestPaymentProfile | None = None

class ssactivewear_sdk.OrderRequestOrderLine(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Order line item.

identifier: str = None

quantity: int = None

warehouse_abbreviation: str | None = None

class ssactivewear_sdk.OrderRequestPaymentProfile(/, **data: Any)

Bases: 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.

email: pydantic.EmailStr = None

profile_id: int = None

class ssactivewear_sdk.OrderRequestShippingAddress(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Shipping address for an order.

customer: str = None

attention_to: str = None

address: str = None

city: str = None

state: str = None

postal_code: str = None

residential: bool = None

class ssactivewear_sdk.OrderResponse(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Order response.

guid: uuid.UUID = None

company_name: str = None

warehouse_abbr: str = None

order_number: str = None

invoice_number: str = None

po_number: str = None

customer_number: str = None

order_date: datetime.datetime = None

expected_delivery_date: datetime.date = None

order_type: str = None

terms: str = None

order_status: str = None

dropship: bool = None

shipping_carrier: str = None

shipping_method: str = None

ship_blind: bool = None

shipping_collect_number: str = None

shipping_address: OrderResponseShippingAddress = None

subtotal: float = None

shipping: float = None

cod: float = None

tax: float = None

small_order_fee: float = None

cupon_discount: float = None

sample_discount: float = None

set_up_fee: float = None

restock_fee: float = None

debit_credit: float = None

total: float = None

total_pieces: int = None

total_lines: int = None

total_weight: float = None

total_boxes: int = None

delivery_status: str = None

conveyor_lane: str = None

lines: list[OrderResponseLine] = None

shipping_saved: float = None

class ssactivewear_sdk.OrderResponseLine(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Order line item in response.

line_number: int = None

type: str = None

sku_id: int = None

sku: str = None

gtin: str = None

your_sku: str = None

qty_ordered: int = None

price: float = None

brand_name: str = None

style_name: str = None

title: str = None

color_name: str = None

size_name: str = None

returnable: bool = None

class ssactivewear_sdk.OrderResponseShippingAddress(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Shipping address in order response.

customer: str = None

attn: str = None

address: str = None

city: str = None

state: str = None

zip: str = None

class ssactivewear_sdk.Product(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Product.

sku_id_master: int = None

sku: str = None

gtin: str = None

your_sku: str = None

base_category_id: str = None

brand_id: str = None

brand_name: str = None

style_id: int = None

style_name: str = None

color_name: str = None

color_code: str = None

color_price_code_name: str = None

color_group: str = None

color_group_name: str = None

color_family_id: str = None

color_family: str = None

color_swatch_image: str = None

color_swatch_text_color: str = None

color_front_image: str = None

color_side_image: str = None

color_back_image: str = None

color_direct_side_image: str = None

color_on_model_front_image: str = None

color_on_model_side_image: str = None

color_on_model_back_image: str = None

color1: str = None

color2: str = None

size_name: str = None

size_code: str = None

size_order: str = None

size_price_code_name: str = None

case_qty: int = None

unit_weight: float = None

map_price: float = None

piece_price: float = None

dozen_price: float = None

case_price: float = None

sale_price: float = None

customer_price: float = None

no_eretailing: bool = None

case_weight: float = None

case_width: float = None

case_length: float = None

case_height: float = None

poly_pack_quantity: int = None

quantity: int = None

country_of_origin: str = None

warehouses: list[Warehouse] = None

sale_expiration: datetime.datetime | None = None

class ssactivewear_sdk.Warehouse(/, **data: Any)

Bases: ssactivewear_sdk.models._base.SSActivewearBaseModel

Warehouse.

warehouse_abbr: str = None

sku_id: int = None

qty: int = None

closeout: bool = None

dropship: bool = None

exclude_free_freight: bool = None

full_case_only: bool = None

returnable: bool = None

expected_inventory: str | None = None