sanmar_sdk.promostandards.shipment_notification

SanMar’s PromoStandards Order Shipment Notification service, version 1.0.0.

Reports what shipped, from where, and under which tracking numbers, by purchase order, by SanMar sales order, or for everything shipped since a point in the last seven days. SanMar recommends its daily status file on the SFTP server instead, and asks that this service be called no more than three times a day.

Attributes

MAX_AGE

Classes

ShipmentAddress	Where a shipment left from or went to.
ShippedItem	What went into a package.
ShipmentPackage	One box, and its tracking number.
ShipmentLocation	Everything that shipped from one warehouse to one address.
SalesOrderShipment	What shipped against one of SanMar's sales orders.
ShipmentNotification	What shipped against one purchase order.
ShipmentNotificationService	SanMar's PromoStandards Order Shipment Notification service.

Module Contents

sanmar_sdk.promostandards.shipment_notification.MAX_AGE

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

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