...
Tip |
---|
This is a checklist of commonly need information for call centers who are implementing this API to take orders for a merchant. If you are the developer in charge of the integration, you should contact the merchant and request the following information. The merchant can (and should) provide all of this to you.
Summary: Merchant ID, Item IDs, Shipping Methods, Advertising Sources, Coupon Codes |
...
URL
The URL for the API is:
...
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. Allowed values are:
| 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.
|
| ||||
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 | Custom value up to 50 characters. | |||||
order.customField3 | String | Custom value up to 50 characters. | |||||
order.customField4 | String | Custom value up to 50 characters. | |||||
order.customField5 | String | Custom value up to 50 characters. | |||||
order.customField6 | String | Custom value up to 50 characters. |
| ||||
order.customField7 | String | Custom value up to 50 characters. | |||||
order.taxCounty | String | Tax county name if the state the order is going to charges tax at the county level. | |||||
order.affiliateId | String | The affiliate ID to associate the order with. |
| ||||
order.gift | Boolean | True/False if the order is a gift (defaults to false) |
| ||||
order.giftEmail | String | Email to send the gift receipt to. |
| ||||
order.leastCostRoute | Boolean | Either this needs to be True or the name of a shipping method must be specified in *order.shippingMethod* | Maybe | ||||
order.leastCostRouteShippingMethods[#] | String | Restrict the least cost routing to these shipping methods. |
| ||||
order.coupons[#] | String | Coupons to apply to the order. | |||||
order.items[#].itemId | String | Item ID of the item | Y | ||||
order.items[#].quantity | Integer | Quantity to purchase | Y | ||||
order.items[#].arbitraryUnitCost | Number | Specific price for the item. If not specified, the unit cost will be whatever value is currently configured on the item within UltraCart. Only use this field if the integration allow for price overrides. | |||||
order.items[#].autoOrderSchedule | Boolean | Auto order schedule if the item is a customer selectable auto order. | |||||
order.items[#].upsell | Boolean | Flag indicating the item was an upsell (default to false) |
| ||||
order.items[#].autoOrderLastRebillDate | String | The last time the order was rebilled. This will determine when the next shipment occurs. This is used for importing historical auto orders from another system. The format for the date is MM/DD/YYYY. | Y - if importing historical orders for items that have auto order schedules. | ||||
order.items[#].options[#].name | String | Name of the option | Y - if the item has options | ||||
order.items[#].options[#].value | String | Value of the option | Y - if the item has options |
...
The table below shows all the possible parameters for the HTTPS POST.
Parameter Name | Format | Description | Required |
---|---|---|---|
method | String | This should be the value cancelOrderByUltraCartOrderId 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 |
orderId | String | The UltraCart Order ID returned from importOrder to cancel. | Y |
...
The table below shows all the possible parameters for the HTTPS POST.
Parameter Name | Format | Description | Required |
---|---|---|---|
method | String | This should be the value cancelOrderByChannelPartnerOrderId 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 |
channelPartnerOrderId | String | The channel partner's order ID passed into the original importOrder call. | Y |
...