sanmar_sdk.promostandards.product_data

SanMar’s PromoStandards Product Data service, version 2.0.0.

Describes a style and every color and size of it, and lists which parts are closed out, changed or sellable. In PromoStandards terms a product is a SanMar style (K500) and a part is one style, color and size, identified by SanMar’s unique key.

Attributes

COUNTRY
LANGUAGE

Classes

Color	One of a part's colors.
ApparelSize	A part's size.
Dimension	A part's measurements.
Packaging	A way a part is packed: how many to a box, and how big and heavy the box is.
Specification	A measurement of a part, such as its chest or inseam.
ProductPart	One color and size of a style.
MarketingPoint	A selling point from a product's description.
Category	A category a product is listed under.
RelatedProduct	Another product SanMar relates to this one.
ProductPrice	One price break.
PriceGroup	A named set of price breaks, such as MSRP.
FobPoint	A place SanMar ships from: one of its warehouses.
Product	A style, and every color and size of it.
PartReference	A product, or one part of it, in a list of changed, closed-out or sellable items.
ProductDataService	SanMar's PromoStandards Product Data service.

Module Contents

sanmar_sdk.promostandards.product_data.COUNTRY = 'US'

sanmar_sdk.promostandards.product_data.LANGUAGE = 'en'

class sanmar_sdk.promostandards.product_data.Color(/, **data: Any)

Bases: sanmar_sdk.base.Record

One of a part’s colors.

catalog_color: str = None

The catalog (mainframe) color, which web services and orders expect.

color_name: str | None = None

The full color name, for display only.

hex: str | None = None

approximate_pms: str | None = None

The nearest Pantone color, such as BLACK C.

class sanmar_sdk.promostandards.product_data.ApparelSize(/, **data: Any)

Bases: sanmar_sdk.base.Record

A part’s size.

apparel_style: str = None

Unisex, Mens, Womens, Youth, MensTall and so on.

label_size: str = None

XS through 6XL, OSFA, or CUSTOM when custom_size holds it.

custom_size: str | None = None

The size when it is not a standard label size, such as a pant size (2732).

property size: str

The size as SanMar prints it, which is the custom size where there is one.

class sanmar_sdk.promostandards.product_data.Dimension(/, **data: Any)

Bases: sanmar_sdk.base.Record

A part’s measurements.

dimension_uom: str = None

depth: decimal.Decimal

height: decimal.Decimal

width: decimal.Decimal

weight_uom: str = None

weight: decimal.Decimal

class sanmar_sdk.promostandards.product_data.Packaging(/, **data: Any)

Bases: sanmar_sdk.base.Record

A way a part is packed: how many to a box, and how big and heavy the box is.

package_type: str = None

quantity: decimal.Decimal

description: str | None = None

default: bool = False

dimension_uom: str | None = None

depth: decimal.Decimal | None = None

height: decimal.Decimal | None = None

width: decimal.Decimal | None = None

weight_uom: str | None = None

weight: decimal.Decimal | None = None

class sanmar_sdk.promostandards.product_data.Specification(/, **data: Any)

Bases: sanmar_sdk.base.Record

A measurement of a part, such as its chest or inseam.

specification_type: str = None

uom: str = None

value: str = None

class sanmar_sdk.promostandards.product_data.ProductPart(/, **data: Any)

Bases: sanmar_sdk.base.Record

One color and size of a style.

part_id: str = None

SanMar’s unique key for this style, color and size.

primary_color: Color | None = None

colors: list[Color] = None

descriptions: list[str] = None

apparel_size: ApparelSize | None = None

country_of_origin: str | None = None

primary_material: str | None = None

specifications: list[Specification] = None

dimension: Dimension | None = None

lead_time: int | None = None

gtin: str | None = None

rush_service: bool = None

packaging: list[Packaging] = None

shipping_packages: list[Packaging] = None

How the part ships, as the case it comes in and how many pieces are in it.

effective_date: datetime.datetime | None = None

end_date: datetime.datetime | None = None

closeout: bool = None

caution: bool = None

caution_comment: str | None = None

on_demand: bool = None

hazmat: bool = None

property catalog_color: str | None

The part’s catalog (mainframe) color, which web services and orders expect.

class sanmar_sdk.promostandards.product_data.MarketingPoint(/, **data: Any)

Bases: sanmar_sdk.base.Record

A selling point from a product’s description.

text: str = None

point_type: str | None = None

class sanmar_sdk.promostandards.product_data.Category(/, **data: Any)

Bases: sanmar_sdk.base.Record

A category a product is listed under.

category: str

subcategory: str | None = None

class sanmar_sdk.promostandards.product_data.RelatedProduct(/, **data: Any)

Bases: sanmar_sdk.base.Record

Another product SanMar relates to this one.

relation_type: str = None

Companion Sell, Substitute or Common Grouping.

product_id: str = None

part_id: str | None = None

class sanmar_sdk.promostandards.product_data.ProductPrice(/, **data: Any)

Bases: sanmar_sdk.base.Record

One price break.

quantity_min: int = None

quantity_max: int | None = None

price: decimal.Decimal

discount_code: str | None = None

class sanmar_sdk.promostandards.product_data.PriceGroup(/, **data: Any)

Bases: sanmar_sdk.base.Record

A named set of price breaks, such as MSRP.

name: str = None

currency: str

description: str | None = None

prices: list[ProductPrice] = None

class sanmar_sdk.promostandards.product_data.FobPoint(/, **data: Any)

Bases: sanmar_sdk.base.Record

A place SanMar ships from: one of its warehouses.

warehouse: sanmar_sdk.common.WarehouseNumber = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

country: str | None = None

currencies: Annotated[list[str], pluck('currency')] = None

The currencies SanMar prices in from here. Only the pricing service reports them.

class sanmar_sdk.promostandards.product_data.Product(/, **data: Any)

Bases: sanmar_sdk.base.Record

A style, and every color and size of it.

product_id: str = None

The style number, such as K500.

name: str = None

descriptions: list[str] = None

The description, one paragraph or bullet point to an entry.

brand: str | None = None

line_name: str | None = None

marketing_points: list[MarketingPoint] = None

keywords: Annotated[list[str], pluck('keyword')] = None

categories: list[Category] = None

related_products: list[RelatedProduct] = None

primary_image_url: str | None = None

price_groups: list[PriceGroup] = None

price_expires_date: datetime.datetime | None = None

parts: list[ProductPart] = None

fob_points: list[FobPoint] = None

export: bool | None = None

compliance_info_available: bool | None = None

unspsc_commodity_code: int | None = None

last_change_date: datetime.datetime | None = None

creation_date: datetime.datetime | None = None

effective_date: datetime.datetime | None = None

end_date: datetime.datetime | None = None

closeout: bool = None

caution: bool = None

caution_comment: str | None = None

class sanmar_sdk.promostandards.product_data.PartReference(/, **data: Any)

Bases: sanmar_sdk.base.Record

A product, or one part of it, in a list of changed, closed-out or sellable items.

product_id: str = None

part_id: str | None = None

class sanmar_sdk.promostandards.product_data.ProductDataService(soap: SoapClient, credentials: Credentials)

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Product Data service.

endpoint

version = '2.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

get(product_id: str, *, part_id: str | None = None, catalog_color: str | None = None) → Product

Describe a style, optionally narrowed to one part or one catalog color.

SanMar recommends asking for whole styles rather than one part at a time.

closeouts() → list[PartReference]

List every part SanMar has discontinued.

modified_since(since: datetime.datetime) → list[PartReference]

List every part that changed after a point in time.

sellable(product_id: str | None = None, *, part_id: str | None = None, is_sellable: bool = True) → list[PartReference]

List the parts SanMar sells, across the catalog or within one style.

With is_sellable=False, list the parts SanMar no longer sells instead.