manageorders_sdk.models

Models.

Attributes

Date

Classes

Customer	Customer model.
LocationDetail	LocationDetail model.
Location	Location model.
Design	Design model.
LinesOEItem	LinesOEItem model.
Note	Note model.
Payment	Payment model.
ShippingAddress	ShippingAddress model.
Attachment	Attachment model.
Order	Order model.
Tracking	Tracking model.
TrackingContainer	TrackingContainer model.

Module Contents

manageorders_sdk.models.Date

class manageorders_sdk.models.Customer(/, **data: Any)

Bases: pydantic.BaseModel

Customer model.

company_name: str = None

customer_source: str | None = None

customer_type: str | None = None

invoice_notes: str | None = None

main_email: str | None = None

sales_group: str | None = None

tax_exempt: Literal[0, 1] | None = None

tax_exempt_number: str | None = None

website: str | None = None

custom_date_field_1: Date | None = None

custom_date_field_2: Date | None = None

custom_date_field_3: Date | None = None

custom_date_field_4: Date | None = None

custom_field_1: str | None = None

custom_field_2: str | None = None

custom_field_3: str | None = None

custom_field_4: str | None = None

custom_field_5: str | None = None

custom_field_6: str | None = None

customer_reminder_invoice_notes: str | None = None

billing_company: str | None = None

billing_address01: str | None = None

billing_address02: str | None = None

billing_city: str | None = None

billing_state: str | None = None

billing_zip: str | None = None

billing_country: str | None = None

class manageorders_sdk.models.LocationDetail(/, **data: Any)

Bases: pydantic.BaseModel

LocationDetail model.

color: str | None = None

parameter_label: str | None = None

parameter_value: str | None = None

text: str | None = None

custom_field_1: str | None = None

custom_field_2: str | None = None

custom_field_3: str | None = None

custom_field_4: str | None = None

custom_field_5: str | None = None

class manageorders_sdk.models.Location(/, **data: Any)

Bases: pydantic.BaseModel

Location model.

location: str | None = None

total_colors: str | None = None

total_flashes: str | None = None

total_stitches: str | None = None

design_code: str | None = None

custom_field_1: str | None = None

custom_field_2: str | None = None

custom_field_3: str | None = None

custom_field_4: str | None = None

custom_field_5: str | None = None

image_url: str | None = None

notes: str | None = None

location_details: list[LocationDetail] | None = None

class manageorders_sdk.models.Design(/, **data: Any)

Bases: pydantic.BaseModel

Design model.

design_name: str | None = None

external_design_id: str | None = None

design_id: int | None = None

design_type_id: int | None = None

artist_id: int | None = None

for_product_color: str | None = None

thread_break: str | None = None

vendor_design_id: str | None = None

custom_field_1: str | None = None

custom_field_2: str | None = None

custom_field_3: str | None = None

custom_field_4: str | None = None

custom_field_5: str | None = None

locations: list[Location] | None = None

class manageorders_sdk.models.LinesOEItem(/, **data: Any)

Bases: pydantic.BaseModel

LinesOEItem model.

part_number: str | None = None

color: str | None = None

description: str | None = None

size: str | None = None

quantity: int | None = None

price: float | None = None

product_class_id: int | None = None

custom_field_1: str | None = None

custom_field_2: str | None = None

custom_field_3: str | None = None

custom_field_4: str | None = None

custom_field_5: str | None = None

name_first: str | None = None

name_last: str | None = None

line_item_notes: str | None = None

work_order_notes: str | None = None

design_id_block: str | None = None

external_design_id_block: str | None = None

external_ship_id: str | None = None

class manageorders_sdk.models.Note(/, **data: Any)

Bases: pydantic.BaseModel

Note model.

note: str = None

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 = None

class manageorders_sdk.models.Payment(/, **data: Any)

Bases: pydantic.BaseModel

Payment model.

date_payment: str = None

account_number: str | None = None

amount: int = None

auth_code: str | None = None

credit_card_company: str | None = None

gateway: str | None = None

response_code: str | None = None

response_reason_code: str | None = None

response_reason_text: str | None = None

status: Literal['success'] = None

class manageorders_sdk.models.ShippingAddress(/, **data: Any)

Bases: pydantic.BaseModel

ShippingAddress model.

external_shipment_id: str | None = None

shipping_method: str | None = None

company: str | None = None

address1: str | None = None

address2: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

country: str | None = None

class manageorders_sdk.models.Attachment(/, **data: Any)

Bases: pydantic.BaseModel

Attachment model.

medial_url: str | None = None

media_name: str | None = None

link_url: str | None = None

link_note: str | None = None

link: Literal[0, 1] | None = None

class manageorders_sdk.models.Order(/, **data: Any)

Bases: pydantic.BaseModel

Order model.

api_source: str | None = None

external_order_id: str = None

external_source: str = None

external_customer_id: str | None = None

external_customer_pref: str | None = None

date_order_placed: Date | None = None

date_order_requested_to_ship: Date | None = None

date_order_drop_dead: Date | None = None

order_type_id: int | None = None

sales_status_id: int | None = None

employee_created_by: int | None = None

customer_id: int | None = None

contact_email: str | None = None

contact_name_first: str | None = None

contact_name_last: str | None = None

contact_phone: str | None = None

customer_purchase_order: str | None = None

customer_service_rep: str | None = None

on_hold: Literal[0, 1] | None = None

terms: str | None = None

discount_part_number: str | None = None

discount_part_description: str | None = None

cur_shipping: int | None = None

tax_total: int | None = None

total_discounts: int | None = None

customer: Customer | None = None

designs: list[Design] | None = None

line_items: list[LinesOEItem] | None = None

notes: list[Note] | None = None

payments: list[Payment] | None = None

addresses: list[ShippingAddress] | None = None

attachments: list[Attachment] | None = None

class manageorders_sdk.models.Tracking(/, **data: Any)

Bases: pydantic.BaseModel

Tracking model.

tracking: str = None

date_shipped: datetime.date = None

company: str = None

name: str = None

address1: str = None

address2: str = None

city: str = None

state: str = None

postal_code: str = None

country: str = None

cost: float = None

weight: float = None

serialize_date_shipped(date_: datetime.date, _info: pydantic.FieldSerializationInfo) → str

Serialize date_shipped to string.

class manageorders_sdk.models.TrackingContainer(/, **data: Any)

Bases: pydantic.BaseModel

TrackingContainer model.

api_source: str | None = None

external_order_id: str = None

tracking: Tracking = None