My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
API  
Basic documentation of API functions
Featured
Updated Jul 24, 2007 by rowan.h...@gmail.com

Introduction Draft

Basic summary of REST actions, used by Flex interface but could be used by anything that consumes XML. Note this is obviously not the final API, just a work in progress draft.

Order API

Method URL Description
GET /orders Lists orders (summary fields: id, created_at, purchase_order_nume, customer_name, country_name, order_status_name, order_status_id, total_amount_payable, price_type_symbol, price_type_dollar_sign
GET /orders/[:id] Shows Order (all fields)
GET /orders/new;select_customer Returns customers (id, name, country_name ). Need to get the customer id to create an order
GET /orders/new?customer_id=[:customer_id] Returns a starting point of an order xml fragment. For the given customer id will prefill the address fields in the order (to be moved to sperate address objects
PUT /orders/[:id] Update the order object and save order
PUT /orders/[:id|;recalculate_only Recalculates the order given passed order lines, but doesn't save the order, returns updated order without comitting changes
PUT /orders/[:id];payment_selection Set the payment type for the order
PUT /orders/[:id];update_status Change the status for the order

Products API

Method URL Description
GET /products Get unfiltered list of all products

Customers API

Method URL Description
GET /customers Get list of all customers (unfiltered)
GET /customer/[:id] Gets all details for this customer
POST /customers/ Create a new customer with given xml fragment.

Security API

Method URL Description


Sign in to add a comment
Powered by Google Project Hosting