support

• Search & Topics
• User Forum
• Infrastructure
• Frequently Asked Questions

documentation

• Getting Started
• Search Engine Optimization

store administration

• General
• Navigation
• Pages
• Payment
• Shipping
• Templates

custom templates

• Introduction
• Enstore Designer
• Template Language
• Template Pages
• Contexts

javascript api beta

• Cart

rest api beta

• Introduction
• Constants

resources

• Settings

sales resources

• Products
• Orders
• Customers
• Payment Methods
• Shipping Methods

webstore resources

• Menus
• Templates
• Pages

Orders Resource

URL Endpoints

Endpoint	Supported Metods	Description
/[store-handle]/api/v2/sales/orders.json	GET	Collection of orders.
/[store-handle]/api/v2/sales/orders/[order-uuid].json	GET, PUT, DELETE	A single customer. Does not take parameters.
/[store-handle]/api/v2/sales/orders/count.json	GET	Total result counter for a query. Returns as integer.

URL Parameters

Parameter	Type	Example	Description
size	integer	/[store-handle]/api/v2/webstore/orders.json?size=40	Results per page. Limited to 20, 40 or 80. Default is 40.
page	integer	/[store-handle]/api/v2/webstore/orders.json?page=5	Result page for query. Starts at and defaults to 0.
startDate	timestamp	/[store-handle]/api/v2/webstore/orders.json?startDate=1265627628	Orders since this date (utc timestamp).
endDate	timestamp	/[store-handle]/api/v2/webstore/orders.json?endDate=1265627628	Orders until this date (utc timestamp).
query	string	/[store-handle]/api/v2/webstore/orders.json?query=test	Fulltext search by query.
since	timestamp	/[store-handle]/api/v2/webstore/orders.json?since=1253783215	Results newer then revision.

Data Structure

Orders are documents that connect ordered goods to customers.

Name	Path	Type	Description	Example
type	type	string (readonly)	Resource type. Must match the resource type used in the endpoint.	"orders", "products", "customers"
uuid	uuid	uuid	Resource identifier. Must be a valid hex representation.	"06429e75a8ea11de80c09314b8ee4e52"
revision	revision	timestamp (readonly)	Resource version. Uses the timestamp format, precision up to seconds.	1253783394
date	date	timestamp (readonly)	Date created.	1253783215
number	number	string	Order number.	"2010-374"
reference	reference	string	Order reference for customer.	"lpsvp9"
status	status	enum	Order status. Can be "pending", "invoiced", "shipped" and "returned".	"pending"
customer	customer	dictionary
For customer properties see the customer resource documentation.
lines	lines	list with dictionaries
type	lines.[index].type	string (readonly)	Resource type.	"orderline"
uuid	lines.[index].uuid	uuid	Resource identifier. Must be a valid hex representation.	"06429e75a8ea11de80c09314b8ee4e52"
productUUID	lines.[index].productUUID	uuid	UUID of the product this line is based on.	"06429e75a8ea11de80c09314b8ee4e52"
quantity	lines.[index].quantity	decimal	Quantity of products on line. Expressed in product units.	"4", "1", "2.5"
totalWeight	lines.[index].totalWeight	decimal (readonly)	Total weight for products.	"1.0", "4.2"
tax	lines.[index].tax	decimal (readonly)	Total tax for order line.	"22.0", "0.00"
subtotal	lines.[index].subtotal	decimal (readonly)	Total price for products without tax.	"70.00", "20.00"
total	lines.[index].total	decimal (readonly)	Total price for products.	"100.0", "33.0"
taxes	lines.[index].taxes	list with dictionaries	Applied taxes to this order line.
name	lines.[index].taxes.[index].name	string	Tax name.	"GST", "BTW Hoog"
group	lines.[index].taxes.[index].group	string	Tax group.	"STATE", "COUNTY", "CITY"
taxtype	lines.[index].taxes.[index].taxtype	string	Tax type.	"SALES", "USE"
rate	lines.[index].taxes.[index].rate	decimal	Tax rate.	"7.00", "19.0", "1.5"
total	lines.[index].taxes.[index].total	decimal (readonly)	Tax total for tax on this orderline.	"7.00", "19.0", "1.5"
All other attributes are equal to the product resource.
payments	payments	list with dictionaries
type	payments.[index].type	string (readonly)	Resource type.	"payment"
uuid	payments.[index].uuid	uuid	Resource identifier. Must be a valid hex representation.	"06429e75a8ea11de80c09314b8ee4e52"
date	payments.[index].date	timestamp (readonly)	Date created.	1253783215
status	payments.[index].status	enum	Payment status. Options are "pending", "failed", "processed".	"processing"
total	payments.[index].total	decimal	Payment total.	"250.00"
method	payments.[index].method	enum	Payment method. Options are "cash", "debitcard", "creditcard", "check", "transfer".	"debitcard"
name	payments.[index].name	string	Payment method name.	"ACH Direct Online"
gateway	payments.[index].gateway	string	Optional used gateway.	"ach_direct"
currency	payments.[index].currency	string	Used payment currency.	"EUR", "USD"
reference	payments.[index].reference	string	Returned payment reference from gateway/processor.	"07B03856-31F8-4231-B499-7FA197D3ABBF"
paymentMethodUUID	payments.[index].paymentMethodUUID	string	Optional uuid from payment method this payment was based on.	"06429e75a8ea11de80c09314b8ee4e52"
error	payments.[index].error	string	Optional error if payment processing failed.	"Card limit reached."
data	payments.[index].data	dictionary	Optional extra returned data from the gateway.
testing	payments.[index].testing	boolean	Whether the gateway processed this payment in testing mode.	true, false
shipmentsSubTotal	shipmentsSubTotal	decimal (readonly)	Subtotal for all shipments.	"25.00"
productsSubTotal	shipmentsSubTotal	decimal (readonly)	Subtotal for all products.	"25.00"
subtotal	subtotal	decimal (readonly)	Subtotal for order.	"525.00"
shipmentsTax	shipmentsTax	decimal (readonly)	Tax for all shipments.	"25.00"
productsTax	productsTax	decimal (readonly)	Tax for all products.	"25.00"
tax	tax	decimal (readonly)	Tax for order.	"30.00"
taxes	taxes	dictionary (readonly)	Taxes used on order.
name	lines.[index].taxes.[index].name	string	Tax name.	"GST", "BTW Hoog"
group	lines.[index].taxes.[index].group	string	Tax group.	"STATE", "COUNTY", "CITY"
taxtype	lines.[index].taxes.[index].taxtype	string	Tax type.	"SALES", "USE"
rate	lines.[index].taxes.[index].rate	decimal	Tax rate.	"7.00", "19.0", "1.5"
total	lines.[index].taxes.[index].total	decimal (readonly)	Tax total for tax on this orderline.	"7.00", "19.0", "1.5"
shipmentsTotal	shipmentsTotal	decimal (readonly)	Total for all shipments.	"25.00"
productsTotal	productsTotal	decimal (readonly)	Total for all products.	"25.00"
total	total	decimal (readonly)	Total for order.	"550.00"
balance	balance	decimal (readonly)	Balance for this order (total - total of all payments).	"0.00", "100.00"
isPaid	isPaid	boolean (readonly)	Wether this order is fully paid.	"0.00", "100.00"