Orders
Retrieve A/R Retry Configuration
Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
Update A/R Retry Configuration
Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
Retrieve A/R Retry Statistics
Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
Retrieve a value histogram for a given AR transaction-detail name
For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input.
Retrieve gateway / detail-name picker data for the AR filter modal
For the calling merchant's Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
Retrieve orders
Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
Insert an order
Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
Retrieve order batch
Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
Retrieve orders by query
Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
Retrieve an order using a token
Retrieves a single order using the specified order token.
Generate an order token for a given order id
Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
Delete an order
Delete an order on the UltraCart account.
Retrieve an order
Retrieves a single order using the specified order id.
Update an order
Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
Adjusts an order total
Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
Assigns an order to an affiliate
Assigns an order to an affiliate.
Cancel an order
Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
Retrieve customer activity for this order.
Retrieves the customer activity associated with the email address on this order. This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status. A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established. For the page views captured during the session that placed the order, see the page view history method instead.
Duplicate an order
Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
Retrieve EDI documents associated with this order.
Retrieve EDI documents associated with this order.
Retrieve email delivery information for this order.
Retrieves email delivery records associated with the specified order id.
Format order
Format the order for display at text or html
Add items and release a held order
This method adds items to an order in the hold stage and releases it
Release a held order
This method releases an order from the hold stage
Generate an invoice for this order.
The invoice PDF that is returned is base 64 encoded
Generate a packing slip for this order across all distribution centers.
The packing slip PDF that is returned is base 64 encoded
Generate a packing slip for this order for the given distribution center.
The packing slip PDF that is returned is base 64 encoded
Retrieve page view history for this order.
Retrieves the page views captured during the session that placed this order.
Process payment
Process payment on order
Refund an order
Perform a refund operation on an order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
Set a refund block on an order
Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
Remove a refund block on an order
Removes a refund block on an order to prevent a user from performing a refund.
Determine if an order can be refunded
Determine if an order can be refunded based upon payment method and age
Replaces an order item id
Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
Replacement order
Create a replacement order based upon a previous order
Resend receipt
Resend the receipt for an order on the UltraCart account.
Resend shipment confirmation
Resend shipment confirmation for an order on the UltraCart account.
Get Order Upsell Cart
Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
Validate
Validate the order for errors. Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped. Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues. So check the response object and trap any exceptions.
Webhooks
The following webhook events are available for this resource. See Webhooks for how delivery, retries, and versioning work.
| Event | Description | Reflow | Expandable |
|---|---|---|---|
order_abandon_recovery | Fired when a previously abandoned cart turns into an order | — | Yes |
order_create | Fired when an order is placed | — | Yes |
order_delete | Fired when an order is deleted | — | Yes |
order_payment_failed | Fired when a payment fails | — | Yes |
order_payment_process | Fired when a payment is processed | — | Yes |
order_refund | Fired when an order is refunded | — | Yes |
order_reject | Fired when an order is rejected | — | Yes |
order_s3_invoice | Fired when an invoice PDF is stored in S3 bucket | — | Yes |
order_s3_packing_slip | Fired when a packing slip PDF is stored in an S3 bucket | — | Yes |
order_ship | Fired when an order is shipped | — | Yes |
order_ship_delivered | Fired when an order has a shipment delivered | — | Yes |
order_ship_expected | Fired when an order has an expected delivery date | — | Yes |
order_ship_out_for_delivery | Fired when an order has a shipment out for delivery | — | Yes |
order_stage_change | Fired when an order stage changes | — | Yes |
order_update | Fired when an order is edited | Yes | Yes |