`darbia.sns`#

A wrapper for S&S’ API.

Submodules#

Package Contents#

Classes#

`Product`	Product.
`Warehouse`	Warehouse.
`SandSServices`	A class wrapping S&S' API.

class darbia.sns.Product[source]#

Product.

sku: str[source]#: Our sku number

gtin: str[source]#: Our sku number

skuID_Master: int[source]#: NO EXPLANATION

yourSku: str[source]#: YourSku has been set up using the CrossRef API.

styleID: int[source]#: Unique ID for this style (Will never change)

brandName: str[source]#: The brand that makes this style.

styleName: str[source]#: The style’s name. Style names are unique within a brand.

colorName: str[source]#: The style’s name. Style names are unique within a brand.

colorCode: str[source]#: Two digit color code part of the InventoryKey.

colorPriceCodeName: str[source]#: The pricing category of this color.

colorGroup: str[source]#: Colors with a similar color group are considered to be a similar color.

colorGroupName: str[source]#: Colors with a similar color group are considered to be a similar color.

colorFamilyID: str[source]#: Base color the color falls under.

colorFamily: str[source]#: Base color the color falls under.

colorSwatchImage: str[source]#: URL to the medium swatch image for this color

colorSwatchTextColor: str[source]#: Html color code that is visible on top of the color swatch

colorFrontImage: str[source]#: URL to the medium front image for this color

colorSideImage: str[source]#: URL to the medium side image for this color

colorBackImage: str[source]#: URL to the medium back image for this color

colorDirectSideImage: str[source]#: URL to the medium direct side image for this color

colorOnModelFrontImage: str[source]#: URL to the medium direct side image for this color

colorOnModelSideImage: str[source]#: URL to the medium direct side image for this color

colorOnModelBackImage: str[source]#: URL to the medium on model back image for this color

color1: str[source]#: HTML Code for the primary color.

color2: str[source]#: HTML Code for the secondary color.

sizeName: str[source]#: Size Name that the spec belongs to.

sizeCode: str[source]#: One digit size code part of the InventoryKey.

sizeOrder: str[source]#: Sort order for the size compared to other sizes in the style.

sizePriceCodeName: str[source]#: The pricing category of this size.

caseQty: int[source]#: Number of units in a full case from the mill.

unitWeight: float[source]#: Weight of a single unit.

mapPrice: float[source]#: Minimum Advertised Price price

piecePrice: float[source]#: Piece price level price

dozenPrice: float[source]#: Dozen price level price

casePrice: float[source]#: Case price level price

salePrice: float[source]#: Sale price level price

customerPrice: float[source]#: Your price

noeRetailing: bool[source]#: When true, mill prohibits the selling of products on popular eRetailing platforms such as Amazon, Walmart, EBay.

caseWeight: int[source]#: Weight of full case in pounds

caseWidth: int[source]#: Width of case in inches

caseLength: float[source]#: Width of case in inches

caseHeight: float[source]#: Height of case in inches

polyPackQty: str[source]#: Number of pieces in a poly pack

qty: int[source]#: Combined Inventory in all of our warehouses

countryOfOrigin: str[source]#: Country of manufacture for product. Provided by mills.

warehouses: list[Warehouse][source]#: List of Object

saleExpiration: str | None[source]#: Your price

classmethod from_api_data(data: dict) → Self[source]#: Build an instance from an API response.

class darbia.sns.Warehouse[source]#

Warehouse.

warehouseAbbr: str[source]#: Code identifying the Warehouse.

skuID: int[source]#: skuID identifying the Sku and Warehouse.

qty: int[source]#: Quantity available for sale.

closeout: bool[source]#: Skus that are discontinued and will not be replenished.

dropship: bool[source]#: This product does not ship from our warehouse.

excludeFreeFreight: bool[source]#: This product does not qualify for free freight.

fullCaseOnly: bool[source]#: This product must be ordered in full case quantities.

returnable: bool[source]#: This product is eligible for return.

expectedInventory: str | None[source]#: Current enroute quantities with expected dates of receipt and current quantity on order with the mill. If no dates are available, None will be returned.

classmethod from_api_data(data: dict) → Self[source]#: Build an instance from an API response.

class darbia.sns.SandSServices(base_url: str, account_number: str, token: str)[source]#

A class wrapping S&S’ API.

make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None, timeout: int | None = None) → dict[source]#: Make a request to S&S’ API.

get_products() → list[darbia.sns.models.Product][source]#: Get all products.