UltraCart Order Management Web Service Developers Guide

...

Method Signature boolean cancelAutoOrderAsCustomerByOrderId(Credentials ccredentials, String orderId);
Description
This method will cancel the auto order associated with the item ID as if the customer had filled out the cancellation form on your website.
Parameters Credentials c credentials – The credentials of the API user that is making the call. String orderId – The order ID to cancel the associated auto order on.
Result boolean – returns true if the auto order was successfully cancelled.

...

Method Signature boolean cancelAutoOrdersAsCustomerByEmail(Credentials ccredentials, String email);
Description
Cancels all auto orders associated with the email address provided as if the customer filled out the cancellation form on your website.
Parameters Credentials c credentials – The credentials of the API user that is making the call. String email – the email address to cancel auto orders on.
Result boolean – returns true if any auto order is canceled.

...

Method Signature boolean cancelOrder(Credentials ccredentials, String orderId);
Description
Attempts to cancel the order before shipment and void/refund the customer's transaction if necessary. This method will only work with distribution centers that use transmission schedules.
Parameters Credentials c credentials – The credentials of the API user that is making the call.String orderId – the order ID to cancel.
Result boolean – returns true if the cancellation was successful

...

Method Signature boolean doesOrderContainItem(Credentials ccredentials, String orderId, String itemId);
Description
Checks to see if the specified order contains the given item Id.
Parameters Credentials c credentials – The credentials of the API user that is making the call.String order Id – the order ID to checkString itemId – the item ID to look for on the order.
Result boolean – returns true if the order contains the specified item.

...

Method Signature byte[] exportOrder(Credentials ccredentials, String exportName, String orderId);
Description Export an order using a pre-defined export mapping configured under Main Menu -> Configuration -> Export Orders.
Parameters Credentials c credentials - The credentials of the API user that is making the call. String order Id - the order ID to export.
Result byte[] - the bytes of the exported document. Format will depend upon the configuration of the export mapping.

...

Method Signature String exportOrder2(Credentials ccredentials, String exportName, String orderId);
Description Export an order using a pre-defined export mapping configured under Main Menu -> Configuration -> Export Orders.
Parameters Credentials c credentials - The credentials of the API user that is making the call. String order Id - the order ID to export.
Result String - base 64 encoded version the exported document. Format will depend upon the configuration of the export mapping. Use this method if you SOAP client does not understand the byte[] returned from exportOrder.

...

Method Signature String[] getActiveAutoOrderItem(Credentials ccredentials, String email);
Description
This method will determine all the item ids that are on active auto order for a given email address..
Parameters Credentials c credentials – The credentials of the API user that is making the call. String email – the email to check auto orders for.
Result String[] – a unique list of item ids that have active auto orders on.

...

Method Signature String[] getActiveAutoOrderOrderIds(Credentials ccredentials, String email);
Description
This method will determine all the order Ids that are on active auto order for a given email address..
Parameters Credentials c credentials – The credentials of the API user that is making the call.String email – the email address to search for auto orders on.
Result String[] – a list of all the order Ids that have active auto orders associated with them.

...

Method Signature String[] getActiveAutoOrderOrderIds(Credentials ccredentials, String email, String itemId);
Description 
This method will return all the order ids that are associated with the supplied email filtered for the item id supplied
Parameters Credentials c credentials – The credentials of the API user that is making the call.String email – the email address to search for auto orders on.
Result String[] – a list of all the order Ids that have active auto orders associated with them.

...

Method Signature String[] getActiveAutoOrderOrderIds(Credentials ccredentials, String email, String[ ] itemIds);
Description 
This method will return all the order ids that are associated with the supplied email filtered for the item ids supplied
Parameters Credentials c credentials – The credentials of the API user that is making the call.String email – the email address to search for auto orders on.
Result String[] – a list of all the order Ids that have active auto orders associated with them.

...

Method Signature AutoOrder getAutoOrder(Credentials ccredentials, String referenceOrderId);
Description
This method loads the auto order object associated with the original reference order id.
Parameters Credentials c credentials – The credentials of the API user that is making the call.  String referenceOrderId – the original order id.
Result AutoOrder - a record describing everything about the auto order.

...

Method Signature String[] getOrderCustomFields(Credentials ccredentials, String orderId);
Description
This method returns the seven custom fields on an order.
Parameters Credentials c credentials – The credentials of the API user that is making the call.  String orderId – the order id to return custom fields for.
Result String[] - an array with seven entries corresponding to custom fields 1 - 7 on the order.

...

Method Signature ShipmentStatus getShipmentStatus(Credentials ccredentials, String orderId);
Description
Obtain the details of the shipment including date, shipping method, tracking numbers and tracking URL
Parameters Credentials c credentials - The credentials of hte API user that is making the call. String orderId - the order id to query shipment information on.
Result ShipmentStatus - an object containing all the details of the order's shipping.

...

Method Signature boolean hasCustomerPaidFor(Credentials ccredentials, String email, String itemId);
Description
This method will determine if a customer has paid for a particular item.
Parameters Credentials c credentials – The credentials of the API user that is making the call.String email – the email address to search for auto orders on.String itemId – Item ID that the customer purchased
Result boolean – returns true if the customer has paid for a particular item on an order associated with their email address.

...

Method Signature boolean isActiveAutoOrder(Credentials ccredentials, String email);
Description
Checks to see if there is an active auto order associated with this email address.
Parameters Credentials c credentials – The credentials of the API user that is making the call. String email – the email address to search for an active auto order on.
Result boolean – returns true if there is an active auto order for this email address.

...

Method Signature PlaceSingleSignonOrderResult placeSingleSignonOrder(Credentials ccredentials, String cpSsoOid, String cpccSsoOid, String[] itemIds, int[] quantities, String screenBrandingThemeCode);
Description
This order uses the customer profile information stored with single signon credentials to place a new order.
Parameters Credentials c credentials – The credentials of the API user that is making the call.String cpSsoOid – the Single Signon Oid for the customer profile to associate this order with.String cpccSsoOid – The Single SIgnon Oid associated with the stored credit card to use on this new order.String[] itemIds – the item ids to add to this new orders.int[] quantities – The quantities associated with each item on the new order.String screenBrandingThemeCode – the screen branding theme code to associate with the new order.
Result PlaceSingleSignonOrderResult – All the result information associated with the call including over success, receipt text, order id and any errors when unsuccessful.

...

Method Signature void resendReceipt(Credentials ccredentials, String orderId);
Description
Triggers the receipt to be resent for the specified order id.
Parameters Credentials c credentials – The credentials of the API user that is making the call. String orderId – the order ID to resend the receipt for.
Result None

...

Method Signature void resendShipmentConfirmation(Credentials ccredentials, String orderId);
Description
Triggers the shipment confirmation to be resent for the specifid order id.
Parameters Credentials c credentials – The credentials of the API user that is making the call. String orderId – the order ID to resend the shipment confirmation for.
Result None

...

Method Signature boolean updateAutoOrder(Credentials ccredentials, AutoOrder autoOrder);
Description
This method updates the settings for an auto order.  The auto order object should come from a call to getAutoOrder.  Only those fields that are not read-only can be updated.  You can not add/remove items from the object.  They will be ignored if you try to modify the items array.
Parameters Credentials c credentials – The credentials of the API user that is making the call.  AutoOrder autoOrder - the auto order record to update.
Result boolean - true if the update was successful.

...

Method Signature void updateOrderCustomFields(Credentials ccredentials, String orderId, String[] customFields);
Description
This method updates the custom fields associated with an order.
Parameters Credentials c credentials – The credentials of the API user that is making the call.  String orderId - the order ID to update the custom fields on.  String[] customFields - array of up to 7 strings for the custom fields.  The first entry in the array corresponds to custom field 1, etc.
Result boolean - true if the update was successful.

...