onsite_edp_sdk

ShopWorks OnSite EDP generation.

Submodules

• onsite_edp_sdk.models

Classes

Contact	Contact Block.
Customer	Customer Block.
Design	Design Block.
DesignLocation	Design Location Block.
EDPDocument	EDP Document.
Order	Order Block.
Payment	Payment Block.
Product	Product Block.

Package Contents

class onsite_edp_sdk.Contact(/, **data: Any)

Bases: BaseModel

Contact Block.

first_name: str | None = None

last_name: str | None = None

department: str | None = None

title: str | None = None

phone: str | None = None

fax: str | None = None

email: str | None = None

status_enable_bulk_email: IntBool | None = None

status_contact_add: IntBool | None = None

class onsite_edp_sdk.Customer(/, **data: Any)

Bases: BaseModel

Customer Block.

external_customer_id: str | None = None

customer_id: int | None = None

company: str | None = None

company_location_id: int | None = None

terms: str | None = None

website_url: str | None = None

email_main: str | None = None

address_description: str | None = None

address_company: str | None = None

address1: str | None = None

address2: str | None = None

address_city: str | None = None

address_state: str | None = None

address_zip: str | None = None

address_country: str | None = None

sts_apply_sales_tax_1: IntBool | None = None

sts_apply_sales_tax_2: IntBool | None = None

sts_apply_sales_tax_3: IntBool | None = None

sts_apply_sales_tax_4: IntBool | None = None

coa_account_sale_tax_1: str | None = None

coa_account_sale_tax_2: str | None = None

coa_account_sale_tax_3: str | None = None

coa_account_sale_tax_4: str | None = None

tax_exempt_number: str | None = None

discount_level_id: int | None = None

default_calculator_1_id: str | None = None

default_calculator_2_id: str | None = None

customer_server_rep: str | None = None

customer_type: str | None = None

customer_source: str | None = None

reference_from: str | None = None

sic_code: str | None = None

sic_description: str | None = None

employee_count: 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

custom_field_6: str | None = None

custom_field_7: Date | None = None

custom_field_8: Date | None = None

custom_field_9: Date | None = None

custom_field_10: Date | None = None

class onsite_edp_sdk.Design(/, **data: Any)

Bases: BaseModel

Design Block.

external_design_id: str | None = None

design_id: int | None = None

design_type_id: int | None = None

design_name: str | None = None

class onsite_edp_sdk.DesignLocation(/, **data: Any)

Bases: BaseModel

Design Location Block.

location: str = None

total_colors: int | None = None

total_flashes: int | None = None

total_stitches: int | None = None

design_code: str | None = None

color: str | None = None

map: str | None = None

class onsite_edp_sdk.EDPDocument(/, **data: Any)

Bases: BaseModel

EDP Document.

order: Order

customer: Customer

contact: Contact | None = None

designs: list[tuple[Design, list[DesignLocation]]] | None = None

products: list[Product] | None = None

payment: Payment | None = None

to_edp(tag_bracket: str = '----', data_separator: str = ': ', carriage_return: str = '<cr>') → str

Serialize to EDP format.

class onsite_edp_sdk.Order(/, **data: Any)

Bases: BaseModel

Order Block.

external_order_id: str = None

external_source: str | None = None

date_external: Date | None = None

order_type_id: float = None

customer_purchase_order: str | None = None

terms_name: str | None = None

customer_service_rep: str | None = None

customer_type: str | None = None

company_location_id: int | None = None

sales_status_id: int | None = None

status_allow_commission: IntBool | None = None

on_hold: YesNoBool | None = None

date_order_placed: Date = None

date_order_requested_to_ship: Date | None = None

date_order_drop_dead: Date | None = None

status_order_sales_tax_override: IntBool | None = None

status_apply_sales_tax_1: IntBool | None = None

status_apply_sales_tax_2: IntBool | None = None

status_apply_sales_tax_3: IntBool | None = None

status_apply_sales_tax_4: IntBool | None = None

coa_account_sales_tax_1: IntBool | None = None

coa_account_sales_tax_2: IntBool | None = None

coa_account_sales_tax_3: IntBool | None = None

coa_account_sales_tax_4: IntBool | None = None

status_shipping_taxable: IntBool | None = None

address_description: str | None = None

address_company: str | None = None

address1: str | None = None

address2: str | None = None

address_city: str | None = None

address_state: str | None = None

address_zip: str | None = None

address_country: str | None = None

ship_method: str | None = None

status_shipping_taxable_field: IntBool | None = None

cur_shipping: float | None = None

status_order_shipping_address_add: IntBool | None = None

notes_to_art: str | None = None

notes_to_production: str | None = None

notes_to_receiving: str | None = None

notes_to_purchasing: str | None = None

notes_to_shipping: str | None = None

notes_to_accounting: str | None = None

notes_to_purchasing_sub: str | None = None

class onsite_edp_sdk.Payment(/, **data: Any)

Bases: BaseModel

Payment Block.

date_payment: Date = None

cur_payment: float | None = None

payment_type: str | None = None

payment_number: str | None = None

card_name_first: str | None = None

card_name_last: str | None = None

card_expiration_date: str | None = None

notes: str | None = None

class onsite_edp_sdk.Product(/, **data: Any)

Bases: BaseModel

Product Block.

part_number: str = None

part_color_range: str | None = None

part_color: str | None = None

part_description: str | None = None

cur_unit_price_user_entered: float | None = None

order_instructions: str | None = None

size1_required: int | None = None

size2_required: int | None = None

size3_required: int | None = None

size4_required: int | None = None

size5_required: int | None = None

size6_required: int | None = None

status_production_product_override: IntBool | None = None

cur_unit_cost: float | None = None

status_enable_commission: IntBool | None = None

product_class_id: int | None = None

status_production_sales_tax_override: IntBool | None = None

status_enable_tax_1: IntBool | None = None

status_enable_tax_2: IntBool | None = None

status_enable_tax_3: IntBool | None = None

status_enable_tax_4: IntBool | None = None

status_production_secondary_units_override: IntBool | None = None

status_use_secondary_units: IntBool | None = None

units_quantity: int | None = None

units_type: Literal['Linear Feet', 'Linear Inches', 'Linear Centimeters', 'Linear Meters', 'Linear Yards', 'Square Feet', 'Square Inches', 'Square Yards', 'Square Meters', 'Square Centimeters', 'Units', 'Pieces', 'Count'] | None = None

units_area1: int | None = None

units_area2: int | None = None

status_units_pricing: IntBool | None = None

status_units_purchasing: IntBool | None = None

status_units_purchasing_extra_percent: float | None = None

status_units_purchasing_extra_round: Literal[1] | None = None

status_production_behavior_override: IntBool | None = None

status_product_source_supplied: IntBool | None = None

status_product_source_purchase: IntBool | None = None

status_product_source_inventory: IntBool | None = None

status_production_designs: IntBool | None = None

status_production_subcontract: IntBool | None = None

status_production_components: IntBool | None = None

status_storage_ship: IntBool | None = None

status_storage_inventory: IntBool | None = None

status_invoicing_invoice: IntBool | None = None