Order API
The Order API manages orders for a store.
In this topic:
Fields
- user_id (string)
A unique id that represents a user account at Weebly. - site_id (string)
Site id unique to the user - order_id (string)
The unique order id (within the store) of the order. - order_date (string)
Date the order was placed. - full_name (string) [calculated]
The name on the order - order_status (string)
The order status - order_notes (string)
Notes entered by the end user. - order_currency (string)
The currency of the order - order_tax_rates (array)
List of tax rate objects for this order - tax_total (decimal)
Total tax amount for this order - order_tax_total (decimal)
- order_shipping_total (decimal)
Total shipping amount for the order - order_subtotal (decimal)
Subtotal amount of the order - order_total (decimal)
Total amount of the order - items (array)
See Order Item. - shipments (array)
See Order Shipment. - coupons (array)
See Coupons.
GET /user/USER_ID/site/SITE_ID/store/order
Returns the following fields for an array of orders for the store:
- user_id
- site_id
- order_id
- order_date
- full_name
- order_status
- order_currency
- order_total
- query (string) Filter
Use this parameter to retrieve only orders that have a full text search match based on the query string.
- filterby (string)
Field name to set a filter on. - filterfor (string)
Value to search filterby field for.
You can use the following URL encoded operators with your filterfor parameter:- < use %3C
- > use %3E
- <= use %3C%3D
- >= use %3E%3D
- sortby (string)
Field name to sort on. Valid value is order_date. - sortdir (string)
Use asc for ascending sort or desc for descending sort.
Example CURL Request
Example Response
Example CURL Request with Search Parameter
Example Filtered Response
GET /user/USER_ID/site/SITE_ID/store/order/count
Returns the number of orders for a store, all unless filtered by a search parameter.
Example CURL Request
Example Response
GET /user/USER_ID/site/SITE_ID/store/order/ORDER_ID
Returns all fields for a given order.
Example CURL Request
Example Response