| advertising_source |
str |
advertising_source |
[optional] |
| affiliate_id |
str |
Affiliate Id |
[optional] |
| affiliate_sub_id |
str |
Affiliate Sub Id |
[optional] |
| arbitrary_shipping_handling_total |
float |
Arbitrary shipping handling total |
[optional] |
| arbitrary_tax |
float |
Arbitrary tax for overriding calculated taxes |
[optional] |
| arbitrary_tax_rate |
float |
Arbitrary tax rate |
[optional] |
| arbitrary_taxable_subtotal |
float |
Arbitrary taxable subtotal |
[optional] |
| associate_with_customer_profile_if_present |
bool |
If true any matching customer profile based on email is associated with this order |
[optional] |
| auto_approve_purchase_order |
bool |
If true any purchase orders are automatically approved |
[optional] |
| billto_address1 |
str |
Billing Address line 1 |
[optional] |
| billto_address2 |
str |
Billing Address line 2 |
[optional] |
| billto_city |
str |
Billing City |
[optional] |
| billto_company |
str |
Billing Company |
[optional] |
| billto_country_code |
str |
Billing ISO-3166 two letter country code |
[optional] |
| billto_day_phone |
str |
Billing Day phone |
[optional] |
| billto_evening_phone |
str |
Billing Evening phone |
[optional] |
| billto_first_name |
str |
Billing First name |
[optional] |
| billto_last_name |
str |
Billing Last name |
[optional] |
| billto_postal_code |
str |
Billing Postal code |
[optional] |
| billto_state_region |
str |
Billing State for United States otherwise region or province for other countries |
[optional] |
| billto_title |
str |
Billing Title |
[optional] |
| cc_email |
str |
CC email. |
[optional] |
| channel_partner_order_id |
str |
The id for this order within the channel partner system. |
[optional] |
| consider_recurring |
bool |
If true this order is marked as an auto order (recurring) |
[optional] |
| coupons |
list[str] |
Array of coupon codes |
[optional] |
| credit_card_authorization_amount |
float |
The amount authorized externally |
[optional] |
| credit_card_authorization_dts |
str |
Date/Time of credit card authorization in ISO8601 format |
[optional] |
| credit_card_authorization_number |
str |
The reference number provided by an externally processed transaction |
[optional] |
| credit_card_expiration_month |
int |
Credit card expiration month |
[optional] |
| credit_card_expiration_year |
int |
Credit card expiration year |
[optional] |
| credit_card_type |
str |
Credit card type |
[optional] |
| custom_field1 |
str |
Custom field 1 |
[optional] |
| custom_field2 |
str |
Custom field 2 |
[optional] |
| custom_field3 |
str |
Custom field 3 |
[optional] |
| custom_field4 |
str |
Custom field 4 |
[optional] |
| custom_field5 |
str |
Custom field 5 |
[optional] |
| custom_field6 |
str |
Custom field 6 |
[optional] |
| custom_field7 |
str |
Custom field 7 |
[optional] |
| delivery_date |
str |
Date the customer is requesting delivery on. Typically used for perishable product delivery. |
[optional] |
| echeck_bank_aba_code |
str |
eCheck bank ABA code |
[optional] |
| echeck_bank_account_name |
str |
eCheck bank account name |
[optional] |
| echeck_bank_account_number |
str |
eCheck bank account number |
[optional] |
| echeck_bank_account_type |
str |
eCheck bank account type |
[optional] |
| echeck_bank_name |
str |
eCheck bank name |
[optional] |
| echeck_bank_owner_type |
str |
eCheck bank owner type |
[optional] |
| echeck_customer_tax_id |
str |
eCheck customer tax id |
[optional] |
| echeck_drivers_license_dob |
str |
eCheck drivers license dob |
[optional] |
| echeck_drivers_license_number |
str |
eCheck drivers license number |
[optional] |
| echeck_drivers_license_state |
str |
eCheck drivers license state |
[optional] |
| email |
str |
Email |
[optional] |
| gift |
bool |
True if this order is a gift |
[optional] |
| gift_email |
str |
Email address of the gift recipient |
[optional] |
| gift_message |
str |
Message to the gift recipient |
[optional] |
| hosted_fields_card_token |
str |
The token provided by UltraCart hosted fields when a credit card number is uploaded into the system. This is the only way to provide a credit card number. |
[optional] |
| hosted_fields_cvv_token |
str |
The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system. This is the only way to provide a cvv number. |
[optional] |
| insurance_application_id |
str |
Insurance application id |
[optional] |
| insurance_claim_id |
str |
Insurance claim id |
[optional] |
| ip_address |
str |
IP Address of the customer |
[optional] |
| items |
list[ChannelPartnerOrderItem] |
Items |
[optional] |
| least_cost_route |
bool |
If true the least expensive shipping method is automatically chosen during the order import |
[optional] |
| least_cost_route_shipping_methods |
list[str] |
An optional array of shipping methods to restict choices if least_cost_route is true |
[optional] |
| mailing_list_opt_in |
bool |
If true the customer is subscribed to any configured mailing lists |
[optional] |
| no_realtime_payment_processing |
bool |
If true no payment processing is done and the order is placed into Accounts Receivable |
[optional] |
| payment_method |
str |
Payment method |
[optional] |
| purchase_order_number |
str |
Purchase order number |
[optional] |
| rotating_transaction_gateway_code |
str |
The rotating transaction gateway code for the gateway used to charge this order |
[optional] |
| sales_rep_code |
str |
Sales rep code |
[optional] |
| screen_branding_theme_code |
str |
Screen branding theme code |
[optional] |
| ship_on_date |
str |
Date the customer is requesting that the order ship on. Typically used for perishable product delivery. |
[optional] |
| ship_to_residential |
bool |
True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method. |
[optional] |
| shipping_method |
str |
Shipping method |
[optional] |
| shipto_address1 |
str |
Shipping Address line 1 |
[optional] |
| shipto_address2 |
str |
Shipping Address line 2 |
[optional] |
| shipto_city |
str |
Shipping City |
[optional] |
| shipto_company |
str |
Shipping Company |
[optional] |
| shipto_country_code |
str |
Shipping ISO-3166 two letter country code |
[optional] |
| shipto_day_phone |
str |
Shipping Day phone |
[optional] |
| shipto_evening_phone |
str |
Shipping Evening phone |
[optional] |
| shipto_first_name |
str |
Shipping First name |
[optional] |
| shipto_last_name |
str |
Shipping Last name |
[optional] |
| shipto_postal_code |
str |
Shipping Postal code |
[optional] |
| shipto_state_region |
str |
Shipping State for United States otherwise region or province for other countries |
[optional] |
| shipto_title |
str |
Shipping Title |
[optional] |
| skip_payment_processing |
bool |
If true the order is placed directly into the shipping department |
[optional] |
| special_instructions |
str |
Special instructions from the customer regarding shipping |
[optional] |
| store_completed |
bool |
If true the order bypasses shipping and is marked completed |
[optional] |
| store_if_payment_declines |
bool |
If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine |
[optional] |
| tax_county |
str |
The optional shipping county used to determine exact taxes |
[optional] |
| tax_exempt |
bool |
If true this order is marked as being tax exempt |
[optional] |
| transaction |
ChannelPartnerOrderTransaction |
|
[optional] |
| treat_warnings_as_errors |
bool |
If true all warnings are considered errors, this is true by default |
[optional] |