sanmar_sdk.promostandards.order_status

SanMar’s PromoStandards Order Status service, version 2.0.0.

Reports where orders stand, line by line, with any holds. SanMar asks that it be called no more than three times a day, starting two hours after an order is placed, and that an order not be checked again once it is Status.COMPLETE or Status.CANCELED. SanMar does not implement getIssue or the transactionId query.

Attributes

MAX_AGE
StatusValue	A Status, or the text SanMar sent if it is none of them.

Classes

Status	Where an order or line stands.
IssueDetail	Which issues to include in an order status.
ContactDetails	A contact's name and address.
Contact	Someone at SanMar to ask about an order, such as its account executive.
StatusLine	Where one line of a sales order stands.
Issue	A hold on an order, such as generalHold or backOrderHold.
SalesOrderStatus	Where one of SanMar's sales orders stands.
OrderStatus	Where one purchase order stands, sales order by sales order.
OrderStatusService	SanMar's PromoStandards Order Status service.

Module Contents

sanmar_sdk.promostandards.order_status.MAX_AGE

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

type sanmar_sdk.promostandards.order_status.StatusValue = Annotated[Status | str, Field(union_mode='left_to_right'), BeforeValidator(_status)]

A Status, or the text SanMar sent if it is none of them.

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