Page Comparison

...

Parameter Name

Format

Description

Required

method

String

This should be the value importOrder to trigger this particular API.

Y

credentials.merchantId

String

UltraCart merchant ID to import into.

Y

credentials.channelPartnerCode

String

Channel partner code to use.

Y

credentials.channelPartnerPassword

String

API password configured on the channel partner

Y

order.channelPartnerOrderId

String

A unique order ID from the external system.

Y

order.paymentMethod

String

The method of payment. Credit Card or Purchase OrderAllowed values are:

Amazon (order.skipPaymentProcessing must be passed as true)
Cash
Check
COD
Credit Card
eCheck
Money Order
PayPal (order.skipPaymentProcessing must be passed as true)
Purchase Order
Wire Transfer

Y

order.noRealtimePaymentProcessing

Boolean

Leaves the order in Accounts Receivable instead of processing the card in real-time.

order.skipPaymentProcessing

Boolean

Skip over the payment processing and move the order on to shipping.

order.considerRecurring

Boolean

If the order is a recurring one generated by an outside system and you set this field to true, we will indicate the recurring flag to gateways that support it (Authorize.Net and PayPal Web Payments Pro)

order.autoApprovePurchaseOrder

Boolean

Automatically approve the purchase order.

order.storeIfPaymentDeclines

Boolean

Store the order in Accounts Receivable if the credit card declines

Recommend - Y

order.treatWarningsAsErrors

Boolean

Consider all warnings (such as a pre-order warning) as errors that prevent the order from importing.

Defaults to Y

order.storeCompleted

Boolean

Store the order in the completed orders stage. This is useful for importing historical orders from another system.

order.creditCardAuthorizationReferenceNumber

String

If you authorized the order outside of UltraCart, this is the transaction identifier that UltraCart will use to capture the order.

Note
Review your payment gateway's integration guide to make sure you pass the correct value. For example, Authorize.Net gateways need to pass the transaction ID in this field and not the six character authorization ticket number.

order.creditCardAuthorizationAmount

Number

If you authorized the order outside of UltraCart, this is the amount of the authorization.

order.creditCardAuthorizationDts

Timestamp

If you authorized the order outside of UltraCart, this is the timestamp of the authorization in the format MM/DD/YYYY HH:MM:SS

order.creditCardType

String

Visa, MasterCard, AMEX, or Discover

Y - CC Orders

order.creditCardNumber

String

15 or 16 digit credit card number (spaces or dashes OK)

Y - CC Orders

order.creditCardToken

String

Token of the credit card (Stripe.com or other tokenizing gateway supported by UltraCart).

order.creditCardExpirationMonth

Number

Month 1 through 12 (January = 1, December = 12)

Y - CC Orders

order.creditCardExpirationYear

Number

Four Digit Year

Y - CC Orders

order.creditCardExpirationMonthYear

String

The format MM/YY or MM/YYYY

order.creditCardVerificationNumber

Number

order.rotatingTransactionGatewayCode

String

The rotating transaction gateway code to use for this order.

order.purchaseOrderNumber

String

The purchase order number.

Y- Purchase Order

order.billToFirstName

String

Y

order.billToLastName

String

Y

order.billToTitle

String

order.billToCompany

String

order.billToAddress1

String

Y

order.billToAddress2

String

order.billToCity

String

Y

order.billToState

String

Y

order.billToPostalCode

String

Y

order.billToCountry

String

Use the full spelling that UltraCart uses or provide the ISO-3166 two letter country code.

Y

order.billToDayPhone

String

order.billToEveningPhone

String

order.email

String

order.ccEmail

String

order.associatedWithCustomerProfileIfPresent

String

If this is yes, the order will be associated with the customer profile that has the same email (if it exists) and they will receive their discounted pricing.

order.shipToFirstName

String

Y - physical goods

order.shipToLastName

String

Y - physical goods

order.shipToTitle

String

order.shipToCompany

String

order.shipToAddress1

String

Y - physical goods

order.shipToAddress2

String

order.shipToCity

String

Y - physical goods

order.shipToState

String

Y - physical goods

order.shipToPostalCode

String

Y - physical goods

order.shipToCountry

String

Use the full spelling that UltraCart uses or provide the ISO-3166 two letter country code.

Y - physical goods

order.shipToPhone

String

Y - physical goods

order.shipToEveningPhone

String

order.shippingMethod

String

If the order requires shipping then you either need to specify the name of the method in this field, or pass order.leastCostRoute = true and let UltraCart pick the method of shipment

Maybe

order.arbitraryTax

Number

The tax charged by the external system

order.arbitraryTaxableSubtotal

Number

The taxable subtotal the tax was based upon by the external system

order.arbitraryTaxRate

Number

The tax rate used by the external system

order.arbitraryShippingHandlingTotal

Number

The shipping/handling cost charged by the external system

order.taxExempt

Boolean

order.giftMessage

String

order.deliveryDate

Date

If specified, use the format MM/DD/YYYY

order.shipOnDate

Date

order.ipAddress

String

The IP address of the remote customer (pass 127.0.0.1) if not available

Y

order.shipToResidential

Boolean

Will default to a business if not specified

Recommended

order.mailingListOptIn

Boolean

Will default to opted out if not specified

Recommended

order.specialInstructions

String

Special instructions from the customer about shipment

order.screenBrandingThemeCode

String

The screen branding theme code to associate the order with.

Y

order.advertisingSource

String

order.customField1

String

Custom value such as the DNIS of the caller up to 50 characters.

order.customField2

String