sanmar_sdk.standard.packing_slips
=================================

.. py:module:: sanmar_sdk.standard.packing_slips

.. autoapi-nested-parse::

   SanMar's packing slip (license plate number) service.

   Every box SanMar ships has a license plate number barcode at the bottom of its shipping
   label. Scanning it and looking it up here says what is in the box, and which order it
   belongs to. A decorator receiving boxes for someone else can look them up with its own
   login as long as the box was shipped to the decorator's own address.



Attributes
----------

.. autoapisummary::

   sanmar_sdk.standard.packing_slips.WS_VERSION


Classes
-------

.. autoapisummary::

   sanmar_sdk.standard.packing_slips.PackingSlipAddress
   sanmar_sdk.standard.packing_slips.PackingSlipParty
   sanmar_sdk.standard.packing_slips.PackingSlipItem
   sanmar_sdk.standard.packing_slips.PackingSlip
   sanmar_sdk.standard.packing_slips.PackingSlipService


Module Contents
---------------

.. py:data:: WS_VERSION
   :value: '1.0.0'


.. py:class:: PackingSlipAddress(/, **data: Any)

   Bases: :py:obj:`sanmar_sdk.base.Record`


   A postal address on a packing slip.


   .. py:attribute:: line1
      :type:  str | None
      :value: None



   .. py:attribute:: line2
      :type:  str | None
      :value: None



   .. py:attribute:: line3
      :type:  str | None
      :value: None



   .. py:attribute:: city
      :type:  str | None
      :value: None



   .. py:attribute:: state
      :type:  str | None
      :value: None



   .. py:attribute:: postal_code
      :type:  str | None
      :value: None



   .. py:attribute:: country
      :type:  str | None
      :value: None



   .. py:attribute:: residential
      :type:  bool | None
      :value: None



.. py:class:: PackingSlipParty(/, **data: Any)

   Bases: :py:obj:`sanmar_sdk.base.Record`


   Who a box ships from, ships to, or is billed to.


   .. py:attribute:: name
      :type:  str | None
      :value: None



   .. py:attribute:: address
      :type:  PackingSlipAddress
      :value: None



   .. py:attribute:: contact_name
      :type:  str | None
      :value: None



.. py:class:: PackingSlipItem(/, **data: Any)

   Bases: :py:obj:`sanmar_sdk.base.Record`


   One item in a box.


   .. py:attribute:: unique_key
      :type:  str | None
      :value: None


      SanMar's identifier for this style, color and size.


   .. py:attribute:: style
      :type:  str | None
      :value: None



   .. py:attribute:: catalog_color
      :type:  str | None
      :value: None


      The color as SanMar's warehouse records it, which is the catalog (mainframe) color.


   .. py:attribute:: size
      :type:  str | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



   .. py:attribute:: quantity
      :type:  int
      :value: None



   .. py:attribute:: gtin
      :type:  str | None
      :value: None



.. py:class:: PackingSlip(/, **data: Any)

   Bases: :py:obj:`sanmar_sdk.base.Record`


   What is in one box SanMar shipped.


   .. py:attribute:: license_plate
      :type:  str
      :value: None



   .. py:attribute:: ship_date
      :type:  sanmar_sdk.base.SanMarDate | None
      :value: None



   .. py:attribute:: box_number
      :type:  int | None
      :value: None


      Which box of the shipment this is.


   .. py:attribute:: box_count
      :type:  int | None
      :value: None


      How many boxes the shipment has.


   .. py:attribute:: order_date
      :type:  sanmar_sdk.base.SanMarDate | None
      :value: None



   .. py:attribute:: order_number
      :type:  int | None
      :value: None


      SanMar's sales order number.


   .. py:attribute:: invoice_number
      :type:  int | None
      :value: None



   .. py:attribute:: po_number
      :type:  str | None
      :value: None



   .. py:attribute:: ship_from
      :type:  PackingSlipParty | None
      :value: None



   .. py:attribute:: ship_to
      :type:  PackingSlipParty | None
      :value: None



   .. py:attribute:: bill_to
      :type:  PackingSlipParty | None
      :value: None



   .. py:attribute:: weight
      :type:  float | None
      :value: None



   .. py:attribute:: weight_unit
      :type:  str | None
      :value: None



   .. py:attribute:: carrier
      :type:  str | None
      :value: None



   .. py:attribute:: shipping_method
      :type:  str | None
      :value: None



   .. py:attribute:: tracking_number
      :type:  str | None
      :value: None



   .. py:attribute:: items
      :type:  sanmar_sdk.base.OneOrMany[PackingSlipItem]
      :value: None



.. py:class:: PackingSlipService(soap: SoapClient, credentials: Credentials)

   Bases: :py:obj:`sanmar_sdk._soap.Service`


   SanMar's packing slip service.


   .. py:method:: get(license_plate: str) -> PackingSlip

      Look up what is in the box with the given license plate number.

      License plate numbers start with LP, L, S or R, such as ``LP000123456789``.

      :raises ~sanmar_sdk.exceptions.NotFoundError: If SanMar has no box with that number, or the box was shipped to someone else.