Order Update API
Your account may be configured so that you can submit order queries or alerts to the CCNow order receiver URL (https://www.ccnow.com/cgi-local/oapi_receive.cgi) rather than manually logging into your backroom GUI for these operations. For example you can set up an automated system whereby a process on your hosted web site sends "order has shipped" alerts to the CCNow order system. Currently the CCNow order receive API supports these operations:
- Request a list of orders that are currently "pending" (i.e. those that are awaiting your processing and marking as shipped).
- Request the status for a particular order.
- Send an alert to mark a pending order as shipped or canceled.
- Upload shipment tracking information and/or order discount amount for orders in "pending" state.
You may also want to utilize the Server Notification API to have the CCNow order system send alerts to remote URL (e.g. on your hosted web server) to receive alerts for various events in the life cycle of your orders.top menu ↑
Order Status Codes
When requesting a status for an order the following table lists possible states in the order lifecycle:
|received||New order placed by consumer.|
|paypal_hold||Awaiting consumer completing payment at the PayPal server.|
|processing||Order undergoing screening, fraud review, and payment processing.|
|vacation_hold||Order being held until you mark "return to office" in your backroom.|
|preorder_hold||Order being held until a product pre-order date has been reached.|
|getman_hold||Order being held until consumer provides proof of credit card ownership.|
|pending||Order has been approved and is now ready for client to process and indicate shipped.|
|canceled||Order has been canceled.|
|mark_canceled||Order in queue to be canceled.|
|declined||Payment for order has been declined.|
|rejected||Order has been rejected due to not meeting CCNow product guidelines, missing order information, or consumer fraud.|
|mark_shipped||Order in queue to be marked completed.|
|completed||Order processed and marked shipped in CCNow system.|
|test||Completed test order.|
|refunded||Order partially or fully refunded.|
|chargeback||Chargeback issued on order.|
Order API Fields
This table includes the fields to include in your post to CCNow order receive URL:
|Field||Required?||Description and Notes|
|x_clientid||Yes||Account login ID.|
|x_storeid||No||Account login ID.|
You only need to provide this alternate account ID if you are using linked CCNow accounts. In this case x_storeid is account which is associated with web store and x_clientid is account where payment is made.
|x_password||Yes||Password to access your account via order receiver API. Note that this is not the password you use to log into your backroom. You will be given this password when your account is activated to use this API.|
|x_orderid_N||No||When querying status or sending order status change for a particular order, this field is the nine digit CCNow order number. You can specify either with or without hyphens. Note that "N" is an arbitrary integer; if you are sending multiple orders in a batch request, then just create a sequence from 1 to NMAX.|
|x_action_N||No||This specifies the "action" associated with order number tied to sequence number "N". Available options:|
|x_notes_N||No||Reason message if x_action_N = "adjust" or "cancel". Shipment tracking notes if x_action_N = "track". In all cases these notes should be appropriate to be made available to the consumer in their order correspondence.|
|x_amount_N||No||Order discount adjustment (always in USD) if x_action_N = "adjust".|
|x_trackname_N||No||Tracking service (Fedex, DHL, etc) if x_action_N = "track".|
|x_tracknumber_N||No||Tracking number if x_action_N = "track".|
Below are a few examples.
|Example Description||Data POSTed to CCNow API URL||Output Returned|
|Get list of pending orders.||x_clientid=amylove|
|Get list of pending orders.|
No current pending orders in account.
|Get list of pending orders.|
CCNow receiver currently offline.
|error_message system down for maintenance|
|Get status of an order||x_clientid=amylove|
|Mark an order canceled and an order shipped.||x_clientid=amylove|
|Mark an order shipped;|
also apply a discount and include tracking information.
x_notes_2=Package should arrive in a week. Thankyou for your order.