get_api_index | List the Webservice resources this key may access, with the HTTP methods allowed on each. |
get_customer | Retrieve one customer by id. |
get_order | Retrieve one order by id, including its totals, state, addresses ids and order rows. |
get_product | Retrieve one product by id (prices, references, descriptions, categories, combinations). language: language id. |
get_stock | Get the available stock of a product: one row per combination (id_product_attribute 0 = the product itself), with quantity and out_of_stock behavior. |
list_addresses | List postal addresses, typically those of one customer (id_customer). display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_carts | List carts, typically those of one customer (id_customer), including their product rows. display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_categories | List product categories. Filters: name (contains), id_parent, active (boolean). language: language id for the names. display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_customers | List customers. Filters: email and lastname (contains, case-insensitive), active (boolean). display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_order_details | List the lines (products, quantities, unit and total prices) of an order. display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_order_states | List the order states configured in the store (id, name, flags such as paid, shipped, delivered). language: language id for the names. display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |
list_orders | List orders. Filters: current_state (order state id, see list_order_states), id_customer, reference, date_from/date_to (order creation date, “YYYY-MM-DD” or “YYYY-MM-DD HH:MM:SS”). display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. Example: sort “date_add_DESC” for the latest orders. |
list_products | List products. Filters: name (contains), reference (exact), active (boolean), id_category_default. language: language id for names and descriptions. display: “full” (default) or an array of field names to return only those; limit: 1-100 (default 20), offset: rows to skip; sort: “<field>_ASC” or “<field>_DESC”. |