sanmar_sdk

A typed Python SDK for SanMar’s web services and SFTP data files.

Submodules

• sanmar_sdk.base
• sanmar_sdk.client
• sanmar_sdk.common
• sanmar_sdk.exceptions
• sanmar_sdk.ftp
• sanmar_sdk.orders
• sanmar_sdk.promostandards
• sanmar_sdk.sources
• sanmar_sdk.standard

Attributes

WarehouseNumber

A warehouse number as SanMar reports it.

Exceptions

AuthenticationError	SanMar rejected the credentials.
AuthorizationError	The account is not authorized to use this service (PromoStandards code 104).
FileFormatError	A SanMar data file did not have the layout the SDK expects.
NotFoundError	SanMar has no record matching the request.
RequestError	SanMar rejected the request as malformed or out of range.
ResponseError	SanMar's response could not be parsed, or did not match its own WSDL.
SanMarConnectionError	SanMar could not be reached, or answered with an HTTP error status.
SanMarError	Base class for every error the SDK raises.
ServiceError	SanMar reported an error for the request.
SoapFaultError	SanMar answered with a SOAP fault.

Classes

SanMar	A client for SanMar's web services, both SanMar's own and PromoStandards.
Environment	Which of SanMar's two web service environments to call.
ShipMethod	How SanMar ships an order.
ShipTo	Where an order ships.
SkuKey	SanMar's own key for one style, color and size.
StyleColorSize	One style, color and size, named the way SanMar's order services expect.
StyleQuery	A style to look up, optionally narrowed to one catalog color, one size, or both.
Warehouse	A SanMar warehouse, numbered as SanMar numbers them.
WillCall	Pick an order up from a warehouse instead of having it shipped.

Package Contents

class sanmar_sdk.SanMar(customer_number: int, username: str, password: str, *, environment: sanmar_sdk.common.Environment = Environment.PRODUCTION, timeout: float = 30.0, transport: zeep.Transport | None = None)

A client for SanMar’s web services, both SanMar’s own and PromoStandards.

Parameters:

• customer_number – The SanMar customer number. SanMar’s own services require it; PromoStandards services do not use it.

• username – A SanMar.com login. Create one at https://www.sanmar.com/signup/webuser, then ask sanmarintegrations@sanmar.com to enable web service access. EDEV logins are separate from production ones, and neither works on SanMar’s SFTP server.

• password – A SanMar.com login. Create one at https://www.sanmar.com/signup/webuser, then ask sanmarintegrations@sanmar.com to enable web service access. EDEV logins are separate from production ones, and neither works on SanMar’s SFTP server.

• environment – Production, or SanMar’s EDEV test environment.

• timeout – Seconds to wait for a WSDL to load or a call to finish.

• transport – A zeep Transport to use instead of the default one, for example to cache WSDLs or go through a proxy. It is used as-is, so timeout does not apply.

products

SanMar’s own product information service.

inventory

SanMar’s own inventory service.

pricing

SanMar’s own pricing service, including this account’s prices.

invoices

SanMar’s own invoicing service.

purchase_orders

SanMar’s own purchase order service.

packing_slips

The packing slip service, which looks boxes up by license plate number.

promostandards

SanMar’s PromoStandards services.

property environment: sanmar_sdk.common.Environment

The environment this client calls.

class sanmar_sdk.Environment

Bases: enum.StrEnum

Which of SanMar’s two web service environments to call.

PRODUCTION = 'https://ws.sanmar.com:8080'

EDEV = 'https://edev-ws.sanmar.com:8080'

SanMar’s test environment. It needs its own credentials, requested from sanmarintegrations@sanmar.com, and its products, prices and inventory may not match production.

class sanmar_sdk.ShipMethod

Bases: enum.StrEnum

How SanMar ships an order.

The value is the ship method as SanMar’s own order services and order files spell it. PromoStandards orders split it into a carrier and a service; see promostandards_freight().

UPS_GROUND = 'UPS'

UPS_2ND_DAY = 'UPS 2ND DAY'

UPS_2ND_DAY_AM = 'UPS 2ND DAY AM'

UPS_3RD_DAY = 'UPS 3RD DAY'

UPS_NEXT_DAY = 'UPS NEXT DAY'

UPS_NEXT_DAY_EARLY_AM = 'UPS NEXT DAY EA'

UPS_NEXT_DAY_SAVER = 'UPS NEXT DAY SV'

UPS_SATURDAY = 'UPS SATURDAY'

USPS_GROUND_ADVANTAGE = 'USPS PP'

USPS_PRIORITY_MAIL = 'USPS APP'

PSST = 'PSST'

SanMar’s Pack Separately, Ship Together program. The ship-to must exactly match the address SanMar has on file.

TRUCK = 'TRUCK'

Truck freight, for orders over 500 pounds. Not available through PromoStandards.

promostandards_freight() → tuple[str, str]

Return the PromoStandards (carrier, service) pair for this ship method.

Raises:

ValueError – If SanMar does not offer the ship method through PromoStandards.

class sanmar_sdk.ShipTo(/, **data: Any)

Bases: sanmar_sdk.base.Model

Where an order ships.

Field lengths are the tightest limits across SanMar’s order services and order files.

address1: Annotated[str, Field(min_length=1, max_length=35), sanmar_sdk.base.ORDER_TEXT]

The street address. SanMar asks for the abbreviations ST, AVE, RD, DR and BLVD.

city: Annotated[str, Field(min_length=1, max_length=28), sanmar_sdk.base.ORDER_TEXT]

state: str = None

The two-letter state abbreviation.

zip_code: str = None

A five-digit ZIP code, or ZIP+4 with or without the dash.

company: Annotated[str, Field(min_length=1, max_length=28), sanmar_sdk.base.ORDER_TEXT] | None = None

attention: Annotated[str, Field(min_length=1, max_length=35), sanmar_sdk.base.ORDER_TEXT] | None = None

The receiver’s name, or the PO number.

address2: Annotated[str, Field(min_length=1, max_length=35), sanmar_sdk.base.ORDER_TEXT] | None = None

The suite or apartment number.

email: Annotated[str, Field(min_length=3, max_length=105), sanmar_sdk.base.ORDER_TEXT] | None = None

Where SanMar sends the order confirmation and shipping notification.

When omitted, SanMar uses the default email on the account.

phone: Annotated[str, Field(min_length=1, max_length=32), sanmar_sdk.base.ORDER_TEXT] | None = None

The receiver’s phone number. Only PromoStandards orders carry it.

residential: bool = False

country: str = None

class sanmar_sdk.SkuKey(/, **data: Any)

Bases: sanmar_sdk.base.Model

SanMar’s own key for one style, color and size.

INVENTORY_KEY and SIZE_INDEX are in every SanMar product file. The inventory key is not the style number. SanMar recommends ordering by key rather than by style, color and size, because it cannot be misspelled.

inventory_key: int = None

size_index: int = None

class sanmar_sdk.StyleColorSize(/, **data: Any)

Bases: sanmar_sdk.base.Model

One style, color and size, named the way SanMar’s order services expect.

style: str = None

The style number, as printed in SanMar’s catalog (K500).

catalog_color: str = None

The catalog (mainframe) color, not the display color name.

size: str = None

class sanmar_sdk.StyleQuery(/, **data: Any)

Bases: sanmar_sdk.base.Model

A style to look up, optionally narrowed to one catalog color, one size, or both.

style: str = None

The style number, as printed in SanMar’s catalog (K500).

catalog_color: Annotated[str, Field(min_length=1, max_length=50)] | None = None

The catalog (mainframe) color, not the display color name.

size: Annotated[str, Field(min_length=1, max_length=50)] | None = None

class sanmar_sdk.Warehouse

Bases: enum.IntEnum

A SanMar warehouse, numbered as SanMar numbers them.

The number is also the warehouse’s PromoStandards FOB id.

SEATTLE = 1

CINCINNATI = 2

DALLAS = 3

RENO = 4

ROBBINSVILLE = 5

JACKSONVILLE = 6

MINNEAPOLIS = 7

PHOENIX = 12

RICHMOND = 31

property code: str

The warehouse’s will-call code, which goes in the ship method field.

property city: str

The city the warehouse is in.

property state: str

The two-letter state the warehouse is in.

sanmar_sdk.WarehouseNumber

A warehouse number as SanMar reports it.

A known warehouse parses to Warehouse. A number SanMar has added since this SDK was released stays a plain int rather than failing the whole response.

class sanmar_sdk.WillCall(/, **data: Any)

Bases: sanmar_sdk.base.Model

Pick an order up from a warehouse instead of having it shipped.

Only SanMar’s own order services and order files support will call, and only for accounts SanMar has set up for warehouse selection.

warehouse: Warehouse

property ship_method: str

The value SanMar expects in the ship method field.

exception sanmar_sdk.AuthenticationError(message: str, code: int | None = None)

Bases: ServiceError

SanMar rejected the credentials.

Web services use a SanMar.com username and password (plus the customer number for SanMar’s own services). EDEV has separate credentials from production, and the SFTP server has its own password.

exception sanmar_sdk.AuthorizationError(message: str, code: int | None = None)

Bases: ServiceError

The account is not authorized to use this service (PromoStandards code 104).

exception sanmar_sdk.FileFormatError(message: str, line_number: int | None = None)

Bases: SanMarError

A SanMar data file did not have the layout the SDK expects.

message

line_number = None

exception sanmar_sdk.NotFoundError(message: str, code: int | None = None)

Bases: ServiceError

SanMar has no record matching the request.

exception sanmar_sdk.RequestError(message: str, code: int | None = None)

Bases: ServiceError

SanMar rejected the request as malformed or out of range.

exception sanmar_sdk.ResponseError

Bases: SanMarError

SanMar’s response could not be parsed, or did not match its own WSDL.

exception sanmar_sdk.SanMarConnectionError

Bases: SanMarError

SanMar could not be reached, or answered with an HTTP error status.

SanMar’s web services listen on port 8080, which some networks block outright.

exception sanmar_sdk.SanMarError

Bases: Exception

Base class for every error the SDK raises.

exception sanmar_sdk.ServiceError(message: str, code: int | None = None)

Bases: SanMarError

SanMar reported an error for the request.

code is the PromoStandards error code. SanMar’s own services report a message without a code, so it is None for them.

message

code = None

exception sanmar_sdk.SoapFaultError(message: str, code: str | None = None)

Bases: SanMarError

SanMar answered with a SOAP fault.

message

code = None