manageorders_sdk.models ======================= .. py:module:: manageorders_sdk.models .. autoapi-nested-parse:: Models. Attributes ---------- .. autoapisummary:: manageorders_sdk.models.Date Classes ------- .. autoapisummary:: manageorders_sdk.models.Customer manageorders_sdk.models.LocationDetail manageorders_sdk.models.Location manageorders_sdk.models.Design manageorders_sdk.models.LinesOEItem manageorders_sdk.models.Note manageorders_sdk.models.Payment manageorders_sdk.models.ShippingAddress manageorders_sdk.models.Attachment manageorders_sdk.models.Order manageorders_sdk.models.Tracking manageorders_sdk.models.TrackingContainer Module Contents --------------- .. py:data:: Date .. py:class:: Customer(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Customer model. .. py:attribute:: company_name :type: str :value: None .. py:attribute:: customer_source :type: str | None :value: None .. py:attribute:: customer_type :type: str | None :value: None .. py:attribute:: invoice_notes :type: str | None :value: None .. py:attribute:: main_email :type: str | None :value: None .. py:attribute:: sales_group :type: str | None :value: None .. py:attribute:: tax_exempt :type: Literal[0, 1] | None :value: None .. py:attribute:: tax_exempt_number :type: str | None :value: None .. py:attribute:: website :type: str | None :value: None .. py:attribute:: custom_date_field_1 :type: Date | None :value: None .. py:attribute:: custom_date_field_2 :type: Date | None :value: None .. py:attribute:: custom_date_field_3 :type: Date | None :value: None .. py:attribute:: custom_date_field_4 :type: Date | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:attribute:: custom_field_6 :type: str | None :value: None .. py:attribute:: customer_reminder_invoice_notes :type: str | None :value: None .. py:attribute:: billing_company :type: str | None :value: None .. py:attribute:: billing_address01 :type: str | None :value: None .. py:attribute:: billing_address02 :type: str | None :value: None .. py:attribute:: billing_city :type: str | None :value: None .. py:attribute:: billing_state :type: str | None :value: None .. py:attribute:: billing_zip :type: str | None :value: None .. py:attribute:: billing_country :type: str | None :value: None .. py:class:: LocationDetail(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` LocationDetail model. .. py:attribute:: color :type: str | None :value: None .. py:attribute:: parameter_label :type: str | None :value: None .. py:attribute:: parameter_value :type: str | None :value: None .. py:attribute:: text :type: str | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:class:: Location(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Location model. .. py:attribute:: location :type: str | None :value: None .. py:attribute:: total_colors :type: str | None :value: None .. py:attribute:: total_flashes :type: str | None :value: None .. py:attribute:: total_stitches :type: str | None :value: None .. py:attribute:: design_code :type: str | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:attribute:: image_url :type: str | None :value: None .. py:attribute:: notes :type: str | None :value: None .. py:attribute:: location_details :type: list[LocationDetail] | None :value: None .. py:class:: Design(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Design model. .. py:attribute:: design_name :type: str | None :value: None .. py:attribute:: external_design_id :type: str | None :value: None .. py:attribute:: design_id :type: int | None :value: None .. py:attribute:: design_type_id :type: int | None :value: None .. py:attribute:: artist_id :type: int | None :value: None .. py:attribute:: for_product_color :type: str | None :value: None .. py:attribute:: thread_break :type: str | None :value: None .. py:attribute:: vendor_design_id :type: str | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:attribute:: locations :type: list[Location] | None :value: None .. py:class:: LinesOEItem(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` LinesOEItem model. .. py:attribute:: part_number :type: str | None :value: None .. py:attribute:: color :type: str | None :value: None .. py:attribute:: description :type: str | None :value: None .. py:attribute:: size :type: str | None :value: None .. py:attribute:: quantity :type: int | None :value: None .. py:attribute:: price :type: float | None :value: None .. py:attribute:: product_class_id :type: int | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:attribute:: name_first :type: str | None :value: None .. py:attribute:: name_last :type: str | None :value: None .. py:attribute:: line_item_notes :type: str | None :value: None .. py:attribute:: work_order_notes :type: str | None :value: None .. py:attribute:: design_id_block :type: str | None :value: None .. py:attribute:: external_design_id_block :type: str | None :value: None .. py:attribute:: external_ship_id :type: str | None :value: None .. py:class:: Note(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Note model. .. py:attribute:: note :type: str :value: None .. py:attribute:: type_ :type: Literal['Notes On Order', 'Notes To Art', 'Notes To Purchasing', 'Notes To Subcontract', 'Notes To Production', 'Notes To Receiving', 'Notes To Shipping', 'Notes To Accounting', 'Notes On Customer'] | None :value: None .. py:class:: Payment(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Payment model. .. py:attribute:: date_payment :type: str :value: None .. py:attribute:: account_number :type: str | None :value: None .. py:attribute:: amount :type: int :value: None .. py:attribute:: auth_code :type: str | None :value: None .. py:attribute:: credit_card_company :type: str | None :value: None .. py:attribute:: gateway :type: str | None :value: None .. py:attribute:: response_code :type: str | None :value: None .. py:attribute:: response_reason_code :type: str | None :value: None .. py:attribute:: response_reason_text :type: str | None :value: None .. py:attribute:: status :type: Literal['success'] :value: None .. py:class:: ShippingAddress(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` ShippingAddress model. .. py:attribute:: external_shipment_id :type: str | None :value: None .. py:attribute:: shipping_method :type: str | None :value: None .. py:attribute:: company :type: str | None :value: None .. py:attribute:: address1 :type: str | None :value: None .. py:attribute:: address2 :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:class:: Attachment(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Attachment model. .. py:attribute:: medial_url :type: str | None :value: None .. py:attribute:: media_name :type: str | None :value: None .. py:attribute:: link_url :type: str | None :value: None .. py:attribute:: link_note :type: str | None :value: None .. py:attribute:: link :type: Literal[0, 1] | None :value: None .. py:class:: Order(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Order model. .. py:attribute:: api_source :type: str | None :value: None .. py:attribute:: external_order_id :type: str :value: None .. py:attribute:: external_source :type: str :value: None .. py:attribute:: external_customer_id :type: str | None :value: None .. py:attribute:: external_customer_pref :type: str | None :value: None .. py:attribute:: date_order_placed :type: Date | None :value: None .. py:attribute:: date_order_requested_to_ship :type: Date | None :value: None .. py:attribute:: date_order_drop_dead :type: Date | None :value: None .. py:attribute:: order_type_id :type: int | None :value: None .. py:attribute:: sales_status_id :type: int | None :value: None .. py:attribute:: employee_created_by :type: int | None :value: None .. py:attribute:: customer_id :type: int | None :value: None .. py:attribute:: contact_email :type: str | None :value: None .. py:attribute:: contact_name_first :type: str | None :value: None .. py:attribute:: contact_name_last :type: str | None :value: None .. py:attribute:: contact_phone :type: str | None :value: None .. py:attribute:: customer_purchase_order :type: str | None :value: None .. py:attribute:: customer_service_rep :type: str | None :value: None .. py:attribute:: on_hold :type: Literal[0, 1] | None :value: None .. py:attribute:: terms :type: str | None :value: None .. py:attribute:: discount_part_number :type: str | None :value: None .. py:attribute:: discount_part_description :type: str | None :value: None .. py:attribute:: cur_shipping :type: int | None :value: None .. py:attribute:: tax_total :type: int | None :value: None .. py:attribute:: total_discounts :type: int | None :value: None .. py:attribute:: customer :type: Customer | None :value: None .. py:attribute:: designs :type: list[Design] | None :value: None .. py:attribute:: line_items :type: list[LinesOEItem] | None :value: None .. py:attribute:: notes :type: list[Note] | None :value: None .. py:attribute:: payments :type: list[Payment] | None :value: None .. py:attribute:: addresses :type: list[ShippingAddress] | None :value: None .. py:attribute:: attachments :type: list[Attachment] | None :value: None .. py:class:: Tracking(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Tracking model. .. py:attribute:: tracking :type: str :value: None .. py:attribute:: date_shipped :type: datetime.date :value: None .. py:attribute:: company :type: str :value: None .. py:attribute:: name :type: str :value: None .. py:attribute:: address1 :type: str :value: None .. py:attribute:: address2 :type: str :value: None .. py:attribute:: city :type: str :value: None .. py:attribute:: state :type: str :value: None .. py:attribute:: postal_code :type: str :value: None .. py:attribute:: country :type: str :value: None .. py:attribute:: cost :type: float :value: None .. py:attribute:: weight :type: float :value: None .. py:method:: serialize_date_shipped(date_: datetime.date, _info: pydantic.FieldSerializationInfo) -> str Serialize date_shipped to string. .. py:class:: TrackingContainer(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` TrackingContainer model. .. py:attribute:: api_source :type: str | None :value: None .. py:attribute:: external_order_id :type: str :value: None .. py:attribute:: tracking :type: Tracking :value: None