sanmar_sdk.promostandards

SanMar’s PromoStandards web services.

Each is reached through sanmar.promostandards, such as sanmar.promostandards.inventory. They take the SanMar.com login but not the customer number, and identify a style as a product and one style, color and size as a part, whose id is SanMar’s unique key.

Submodules

• sanmar_sdk.promostandards.client
• sanmar_sdk.promostandards.inventory
• sanmar_sdk.promostandards.invoices
• sanmar_sdk.promostandards.media_content
• sanmar_sdk.promostandards.order_status
• sanmar_sdk.promostandards.pricing
• sanmar_sdk.promostandards.product_data
• sanmar_sdk.promostandards.purchase_orders
• sanmar_sdk.promostandards.shipment_notification

Classes

PromoStandards	SanMar's PromoStandards services, which take only the SanMar.com login.
FutureStock	Stock a warehouse expects to receive.
InventoryService	SanMar's PromoStandards Inventory service.
LocationStock	One part's stock at one warehouse.
PartStock	One part's stock across SanMar's warehouses.
AccountInfo	The account and address an invoice is billed or sold to.
Invoice	An invoice or credit memo.
InvoiceLine	One line of an invoice.
InvoiceService	SanMar's PromoStandards Invoice service.
Tax	A tax charged on an invoice.
ClassType	The image classes SanMar's guide lists. PromoStandards defines more.
MediaClass	A classification of a piece of media, such as Front or Swatch.
MediaContentService	SanMar's PromoStandards Media Content service.
MediaItem	One image or document.
MediaType	The kinds of media SanMar serves.
Contact	Someone at SanMar to ask about an order, such as its account executive.
ContactDetails	A contact's name and address.
Issue	A hold on an order, such as generalHold or backOrderHold.
IssueDetail	Which issues to include in an order status.
OrderStatus	Where one purchase order stands, sales order by sales order.
OrderStatusService	SanMar's PromoStandards Order Status service.
SalesOrderStatus	Where one of SanMar's sales orders stands.
Status	Where an order or line stands.
StatusLine	Where one line of a sales order stands.
PartPrice	The prices of one part.
PriceBreak	The price per unit from a minimum quantity up.
PriceType	Which price to ask for.
PricingService	SanMar's PromoStandards Pricing and Configuration service.
ApparelSize	A part's size.
Category	A category a product is listed under.
Color	One of a part's colors.
Dimension	A part's measurements.
FobPoint	A place SanMar ships from: one of its warehouses.
MarketingPoint	A selling point from a product's description.
Packaging	A way a part is packed: how many to a box, and how big and heavy the box is.
PartReference	A product, or one part of it, in a list of changed, closed-out or sellable items.
PriceGroup	A named set of price breaks, such as MSRP.
Product	A style, and every color and size of it.
ProductDataService	SanMar's PromoStandards Product Data service.
ProductPart	One color and size of a style.
ProductPrice	One price break.
RelatedProduct	Another product SanMar relates to this one.
Specification	A measurement of a part, such as its chest or inseam.
PromoStandardsOrder	A purchase order for SanMar's PromoStandards purchase order service.
PromoStandardsOrderLine	One part on a PromoStandards purchase order.
PurchaseOrderService	SanMar's PromoStandards Purchase Order service.
SalesOrderShipment	What shipped against one of SanMar's sales orders.
ShipmentAddress	Where a shipment left from or went to.
ShipmentLocation	Everything that shipped from one warehouse to one address.
ShipmentNotification	What shipped against one purchase order.
ShipmentNotificationService	SanMar's PromoStandards Order Shipment Notification service.
ShipmentPackage	One box, and its tracking number.
ShippedItem	What went into a package.

Package Contents

class sanmar_sdk.promostandards.PromoStandards(soap: sanmar_sdk._soap.SoapClient, credentials: sanmar_sdk._soap.Credentials)

SanMar’s PromoStandards services, which take only the SanMar.com login.

product_data

Product Data 2.0.0.

media_content

Media Content 1.1.0.

inventory

Inventory 2.0.0.

pricing

Pricing and Configuration 1.0.0.

order_status

Order Status 2.0.0.

shipment_notifications

Order Shipment Notification 1.0.0.

invoices

Invoice 1.0.0.

purchase_orders

Purchase Order 1.0.0.

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

Bases: sanmar_sdk.base.Record

Stock a warehouse expects to receive.

quantity: int = None

available_on: datetime.datetime = None

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Inventory service.

endpoint

version = '2.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

get(product_id: str, *, part_ids: collections.abc.Sequence[str] = (), sizes: collections.abc.Sequence[str] = (), catalog_colors: collections.abc.Sequence[str] = ()) → list[PartStock]

Report stock for a style, or for a set of parts.

With no filter, every part of the style is reported. sizes and catalog_colors narrow the style down. part_ids asks for up to 200 parts from any styles instead; SanMar still needs a valid style in product_id, but does not require the parts to belong to it.

Raises:

• TypeError – If a filter is a single string rather than a list of them.

• ValueError – If part_ids is combined with sizes or catalog_colors, or lists more than 200 parts.

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

Bases: sanmar_sdk.base.Record

One part’s stock at one warehouse.

warehouse: sanmar_sdk.common.WarehouseNumber = None

quantity: int = None

Pieces available, up to SanMar’s cap of 3,000.

name: str | None = None

postal_code: str | None = None

country: str | None = None

future: list[FutureStock] = None

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

Bases: sanmar_sdk.base.Record

One part’s stock across SanMar’s warehouses.

part_id: str = None

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

catalog_color: str | None = None

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

size: str | None = None

description: str | None = None

quantity: int = None

Pieces available across every warehouse.

main_part: bool = None

manufactured_item: bool = None

buy_to_order: bool = None

replenishment_lead_time: int | None = None

locations: list[LocationStock] = None

last_modified: datetime.datetime | None = None

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

Bases: sanmar_sdk.base.Record

The account and address an invoice is billed or sold to.

account_name: str | None = None

account_number: str | None = None

attention_to: str | None = None

address1: str | None = None

address2: str | None = None

address3: str | None = None

city: str | None = None

region: str | None = None

The state.

postal_code: str | None = None

country: str | None = None

email: str | None = None

phone: str | None = None

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

Bases: sanmar_sdk.base.Record

An invoice or credit memo.

invoice_number: str = None

invoice_type: str = None

Whether this is an invoice or a credit memo, as SanMar spells it.

invoice_date: datetime.date = None

payment_due_date: datetime.date = None

currency: str

sales_amount: decimal.Decimal = None

shipping_amount: decimal.Decimal = None

handling_amount: decimal.Decimal = None

tax_amount: decimal.Decimal = None

invoice_amount: decimal.Decimal = None

advance_payment_amount: decimal.Decimal = None

amount_due: decimal.Decimal = None

po_number: str | None = None

po_version: str | None = None

bill_to: AccountInfo | None = None

sold_to: AccountInfo | None = None

comments: str | None = None

payment_terms: str | None = None

fob: str | None = None

document_url: str | None = None

payment_url: str | None = None

lines: list[InvoiceLine] = None

sales_order_numbers: list[str] = None

taxes: list[Tax] = None

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

Bases: sanmar_sdk.base.Record

One line of an invoice.

invoice_quantity: decimal.Decimal = None

uom: str = None

description: str = None

unit_price: decimal.Decimal = None

extended_price: decimal.Decimal = None

line_number: decimal.Decimal | None = None

product_id: str | None = None

The style.

part_id: str | None = None

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

charge_id: str | None = None

po_line_number: decimal.Decimal | None = None

ordered_quantity: decimal.Decimal | None = None

back_ordered_quantity: decimal.Decimal | None = None

discount_amount: decimal.Decimal | None = None

distributor_product_id: str | None = None

distributor_part_id: str | None = None

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Invoice service.

endpoint

version = '1.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

by_purchase_order(po_number: str) → list[Invoice]

Find the invoices for a purchase order.

get(invoice_number: str) → Invoice

Find one invoice by its number.

Raises:

NotFoundError – If SanMar has no such invoice.

by_date(invoice_date: datetime.date) → list[Invoice]

Find every invoice dated a given day.

available_since(since: datetime.datetime) → list[Invoice]

Find every invoice issued after a point in time.

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

Bases: sanmar_sdk.base.Record

A tax charged on an invoice.

tax_type: str = None

jurisdiction: str = None

amount: decimal.Decimal = None

class sanmar_sdk.promostandards.ClassType

Bases: enum.IntEnum

The image classes SanMar’s guide lists. PromoStandards defines more.

SWATCH = 1004

PRIMARY = 1006

FRONT = 1007

REAR = 1008

HIGH_RESOLUTION = 2001

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

Bases: sanmar_sdk.base.Record

A classification of a piece of media, such as Front or Swatch.

id: int = None

name: str = None

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Media Content service.

endpoint

version = '1.1.0'

The PromoStandards version SanMar implements, sent as wsVersion.

get(product_id: str, *, media_type: MediaType = MediaType.IMAGE, part_id: str | None = None, class_type: ClassType | int | None = None) → list[MediaItem]

List a style’s images or documents, optionally for one part or one class.

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

Bases: sanmar_sdk.base.Record

One image or document.

product_id: str = None

part_id: str | None = None

url: str

media_type: str = None

classes: list[MediaClass] = None

color: str | None = None

The color shown, as SanMar names it on the image.

description: str | None = None

single_part: bool = None

Whether the media shows exactly the one part it is listed under.

file_size: decimal.Decimal | None = None

width: decimal.Decimal | None = None

height: decimal.Decimal | None = None

dpi: int | None = None

changed: datetime.datetime | None = None

class sanmar_sdk.promostandards.MediaType

Bases: enum.StrEnum

The kinds of media SanMar serves.

IMAGE = 'Image'

DOCUMENT = 'Document'

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

Bases: sanmar_sdk.base.Record

Someone at SanMar to ask about an order, such as its account executive.

contact_type: str = None

details: ContactDetails = None

account_name: str | None = None

account_number: str | None = None

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

Bases: sanmar_sdk.base.Record

A contact’s name and address.

attention_to: str | None = None

company_name: str | None = None

address1: str | None = None

address2: str | None = None

address3: str | None = None

city: str | None = None

region: str | None = None

postal_code: str | None = None

country: str | None = None

email: str | None = None

phone: str | None = None

comments: str | None = None

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

Bases: sanmar_sdk.base.Record

A hold on an order, such as generalHold or backOrderHold.

status: str = None

Open, Pending or Closed.

category: str = None

urgent_response_required: bool = None

id: str | None = None

name: str | None = None

description: str | None = None

response_required_by: datetime.datetime | None = None

resolution_url: str | None = None

product_id: str | None = None

part_id: str | None = None

class sanmar_sdk.promostandards.IssueDetail

Bases: enum.StrEnum

Which issues to include in an order status.

NONE = 'noIssues'

OPEN = 'openIssues'

Issues that are open or pending.

ALL = 'allIssues'

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

Bases: sanmar_sdk.base.Record

Where one purchase order stands, sales order by sales order.

po_number: str = None

sales_orders: list[SalesOrderStatus] = None

audit_url: str | None = None

property finished: bool

Whether every sales order is complete or canceled, so SanMar will report nothing more.

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Order Status service.

endpoint

version = '2.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

by_purchase_order(po_number: str, *, issues: IssueDetail = IssueDetail.OPEN, lines: bool = True) → list[OrderStatus]

Report where a purchase order stands.

issues picks which holds to include, and lines whether to include each line.

by_sales_order(sales_order_number: str, *, issues: IssueDetail = IssueDetail.OPEN, lines: bool = True) → list[OrderStatus]

Report where one of SanMar’s sales orders stands.

updated_since(since: datetime.datetime, *, issues: IssueDetail = IssueDetail.OPEN, lines: bool = True) → list[OrderStatus]

Report every order whose status changed after a point in time, at most 30 days ago.

SanMar suggests narrowing to seven days if the call times out.

Raises:

ValueError – If since has no time zone, or is more than 30 days ago.

open_orders(*, issues: IssueDetail = IssueDetail.OPEN, lines: bool = True) → list[OrderStatus]

Report every order that is not yet complete or canceled.

open_issues(*, issues: IssueDetail = IssueDetail.OPEN, lines: bool = True) → list[OrderStatus]

Report every open order with an open or pending issue.

service_methods() → list[str]

List the Order Status operations SanMar implements.

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

Bases: sanmar_sdk.base.Record

Where one of SanMar’s sales orders stands.

sales_order_number: str = None

status: StatusValue

valid_timestamp: datetime.datetime = None

When SanMar last confirmed this status.

issue_category: str | None = None

generalHold when the order is on hold, backOrderHold when it is backordered.

expected_ship_date: datetime.date | None = None

expected_delivery_date: datetime.date | None = None

additional_explanation: str | None = None

contacts: list[Contact] = None

lines: list[StatusLine] = None

The lines, when they were asked for.

issues: list[Issue] = None

class sanmar_sdk.promostandards.Status

Bases: enum.StrEnum

Where an order or line stands.

RECEIVED = 'received'

SanMar has the order, including when it is on hold or backordered.

CONFIRMED = 'confirmed'

PREPRODUCTION = 'preproduction'

IN_PRODUCTION = 'inProduction'

IN_STORAGE = 'inStorage'

PARTIALLY_SHIPPED = 'partiallyShipped'

SHIPPED = 'shipped'

COMPLETE = 'complete'

Shipped in full and invoiced. SanMar reports nothing further.

CANCELED = 'canceled'

SanMar reports nothing further.

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

Bases: sanmar_sdk.base.Record

Where one line of a sales order stands.

product_id: str = None

The style.

sales_order_line_number: str = None

status: StatusValue

part_id: str | None = None

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

po_line_number: str | None = None

quantity_ordered: decimal.Decimal = None

quantity_shipped: decimal.Decimal = None

issue_category: str | None = None

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

Bases: sanmar_sdk.base.Record

The prices of one part.

part_id: str = None

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

description: str | None = None

prices: list[PriceBreak] = None

default_part: bool = None

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

Bases: sanmar_sdk.base.Record

The price per unit from a minimum quantity up.

min_quantity: int = None

price: decimal.Decimal

uom: str = None

The unit the price is per, EA for each piece or CA for each piece by the case.

effective_date: datetime.datetime | None = None

expiry_date: datetime.datetime | None = None

discount_code: str | None = None

class sanmar_sdk.promostandards.PriceType

Bases: enum.StrEnum

Which price to ask for.

NET = 'Net'

This account’s cost.

LIST = 'List'

SanMar’s suggested retail price (MSRP).

CUSTOMER = 'Customer'

This account’s special pricing, where SanMar has set some up.

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Pricing and Configuration service.

endpoint

version = '1.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

get(product_id: str, *, part_id: str | None = None, price_type: PriceType = PriceType.NET, warehouse: sanmar_sdk.common.Warehouse = Warehouse.SEATTLE) → list[PartPrice]

Price every part of a style, or one part.

SanMar’s prices do not vary by warehouse, but the service requires one, so any warehouse will do.

fob_points(product_id: str) → list[sanmar_sdk.promostandards.product_data.FobPoint]

List SanMar’s warehouses. The list is the same for every product.

SanMar asks that this be called at most once a week.

class sanmar_sdk.promostandards.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.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.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.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.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.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.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.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.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: 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.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.

class sanmar_sdk.promostandards.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.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.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.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.PromoStandardsOrder(/, **data: Any)

Bases: sanmar_sdk.base.Model

A purchase order for SanMar’s PromoStandards purchase order service.

po_number: sanmar_sdk.orders.PONumber

ship_to: sanmar_sdk.common.ShipTo

ship_method: sanmar_sdk.common.ShipMethod

lines: Annotated[collections.abc.Sequence[PromoStandardsOrderLine], Field(min_length=1), sanmar_sdk.base.FROZEN]

order_date: datetime.datetime | None = None

When the order was placed. Defaults to the time it is sent.

ship_references: Annotated[collections.abc.Sequence[Annotated[str, Field(min_length=1, max_length=64), sanmar_sdk.base.ORDER_TEXT]], Field(max_length=2), sanmar_sdk.base.FROZEN] = ()

Up to two references for the shipping process. Defaults to the PO number.

merged_lines() → list[PromoStandardsOrderLine]

Return the lines with duplicates combined, keeping the order each first appeared in.

SanMar checks inventory line by line, so two lines for the same part and warehouse can each pass on their own while their total is short.

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

Bases: sanmar_sdk.base.Model

One part on a PromoStandards purchase order.

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

SanMar’s unique key for the style, color and size (UNIQUE_KEY in its files).

quantity: int = None

warehouse: sanmar_sdk.common.Warehouse | None = None

The warehouse to ship this line from.

Leave it unset unless SanMar has set your account up for warehouse selection; otherwise SanMar picks warehouses according to the shipping option on your account.

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Purchase Order service.

endpoint

version = '1.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

send(order: PromoStandardsOrder) → str

Place an order. Returns SanMar’s transaction id, which starts with the PO number.

supported_order_types() → list[str]

List the order types SanMar accepts. SanMar sells blank goods only: Blank.

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

Bases: sanmar_sdk.base.Record

What shipped against one of SanMar’s sales orders.

sales_order_number: str = None

complete: bool

locations: list[ShipmentLocation] = None

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

Bases: sanmar_sdk.base.Record

Where a shipment left from or went to.

address1: str | None = None

address2: str | None = None

address3: str | None = None

address4: str | None = None

city: str | None = None

region: str | None = None

The state.

postal_code: str | None = None

country: str | None = None

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

Bases: sanmar_sdk.base.Record

Everything that shipped from one warehouse to one address.

complete: bool

ship_from: ShipmentAddress = None

ship_to: ShipmentAddress = None

id: int | None = None

destination_type: str | None = None

Commercial or Residential.

packages: list[ShipmentPackage] = None

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

Bases: sanmar_sdk.base.Record

What shipped against one purchase order.

po_number: str = None

complete: bool

Whether the whole purchase order has shipped.

sales_orders: list[SalesOrderShipment] = None

property tracking_numbers: list[str]

Every package’s tracking number, in the order SanMar listed them.

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Order Shipment Notification service.

endpoint

version = '1.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

by_purchase_order(po_number: str) → list[ShipmentNotification]

Report what has shipped against a purchase order.

by_sales_order(sales_order_number: str) → list[ShipmentNotification]

Report what has shipped against one of SanMar’s sales orders.

since(since: datetime.datetime) → list[ShipmentNotification]

Report everything shipped after a point in time, at most seven days ago.

Raises:

ValueError – If since has no time zone, or is more than seven days ago.

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

Bases: sanmar_sdk.base.Record

One box, and its tracking number.

tracking_number: str = None

shipment_date: datetime.datetime = None

id: int | None = None

carrier: str | None = None

shipment_method: str | None = None

The carrier’s service, such as Ground.

dimension_uom: str | None = None

length: decimal.Decimal | None = None

width: decimal.Decimal | None = None

height: decimal.Decimal | None = None

weight_uom: str | None = None

weight: decimal.Decimal | None = None

shipping_account: str | None = None

shipment_terms: str | None = None

items: list[ShippedItem] = None

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

Bases: sanmar_sdk.base.Record

What went into a package.

product_id: str | None = None

The style.

part_id: str | None = None

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

quantity: decimal.Decimal | None = None

po_line_number: str | None = None

distributor_product_id: str | None = None

distributor_part_id: str | None = None