Difference between revisions of "API Order"
From Spiffy Stores Knowledge Base
Line 334: | Line 334: | ||
* transaction_id - The transaction identifier returned by the gateway | * transaction_id - The transaction identifier returned by the gateway | ||
* description - A text description of the transaction | * description - A text description of the transaction | ||
+ | |} | ||
+ | == Endpoints == | ||
+ | |||
+ | === <code>GET /api/orders.json</code> === | ||
+ | |||
+ | Return a list of orders. | ||
+ | |||
+ | ==== Optional Parameters ==== | ||
+ | |||
+ | {| class="wikitable" style="width: 100%" | ||
+ | |style="width: 30%"|limit | ||
+ | |Number of results returned. The default is 30, with a maximum of 50 in a single request. | ||
+ | |- | ||
+ | |page | ||
+ | |The number of the page to return. The number of results per page is set by the <code>limit</code> parameter. If more results are required, then submit the request again, increasing the page number each time. | ||
+ | |- | ||
+ | |ids | ||
+ | |A comma-separated list of products ids. | ||
+ | |- | ||
+ | |since_id | ||
+ | |Limit the results to only include objects which have an id greater than the given value. | ||
+ | |- | ||
+ | |vendor | ||
+ | |Limit the results to only include products supplied by the given vendor. | ||
+ | |- | ||
+ | |product_type | ||
+ | |Limit the results to only include products that belong to the given product_type. | ||
+ | |- | ||
+ | |handle | ||
+ | |Return the product with the given handle. | ||
+ | |- | ||
+ | |collection_id | ||
+ | |Return only the products that belong to the given collection. | ||
+ | |- | ||
+ | |created_at_min | ||
+ | |Return only the products created after the given date and time. Use the format "2014-12-31 12:00". | ||
+ | |- | ||
+ | |created_at_max | ||
+ | |Return only the products created before the given date and time. Use the format "2014-12-31 12:00". | ||
+ | |- | ||
+ | |updated_at_min | ||
+ | |Return only the products updated after the given date and time. Use the format "2014-12-31 12:00". | ||
+ | |- | ||
+ | |updated_at_max | ||
+ | |Return only the products updated before the given date and time. Use the format "2014-12-31 12:00". | ||
+ | |- | ||
+ | |published_status | ||
+ | |Return only products with the given published status.<br/> | ||
+ | * published - Include only published products | ||
+ | * unpublished - Include only unpublished products | ||
+ | * any - Include all products (default) | ||
+ | |- | ||
+ | |featured_status | ||
+ | |Return only products with the given featured status.<br/> | ||
+ | * featured - Include only featured products | ||
+ | * any - Include all products (default) | ||
+ | |- | ||
+ | |archived_status | ||
+ | |Return only products with the given archived status.<br/> | ||
+ | * archived - Include only archived products | ||
+ | * any - Include all products (default) | ||
+ | |- | ||
+ | |fields | ||
+ | |A comma-separated list of fields to return in the response. | ||
|} | |} |
Revision as of 16:32, 26 February 2015
The Spiffy Stores API Order object represents a request from a customer to purchase one or more products from your store. The process of creating an order during the checkout process collects together sets of information about the customer's requested, including customer details and billing and shipping addresses, a list of the items being purchased, information about the payment, and shipping and fulfilment details.
Order Properties
id | { "id" : 123456789 } A unique numeric identifier for the order. This ID is only used with the API interface. This ID is not the same as the Order Number, which is also a unique numeric identifier for the order, but is used by the store owner and customer. |
order_number | { "order_number" : 1045 } A unique numeric identifier for the order that is used as a reference number for the store owner and customers. This is not the same as the |
name | { "name" : "#001045" } This is the |
browser_ip | { "browser_ip" : "202.60.66.249" } This is the IP address used by the customer when the order was placed. |
buyer_accepts_marketing | { "buyer_accepts_marketing" : true } If the customer indicates during the checkout process that they are happy to receive marketing and other promotional emails, then their response is recorded here. |
cart_token | { "cart_token" : "65853ecbd10916e70999e7056b01a5e7" } This is a unique token that identifies the cart that is associated with a particular order. |
created_at | { "created_at" : "2007-10-24T18:26:31Z" } The date and time when the order was created. The timestamp is in ISO 8601 format. |
updated_at | { "updated_at" : "2014-01-16T05:50:56Z" } The date and time when the order was last updated. The timestamp is in ISO 8601 format. |
currency | { "currency" : "AUD" } The three letter currency code (ISO 4217) used for the order. |
{ "email" : "customer@any_domain.com" } The customer's email address. | |
credit | { "credit" : "0.0" } An order can have credit applied to it from a customer's account. If this is the case, then the amount of credit that has been applied to the order is returned here. |
taxes_included | { "taxes_included" : true } For certain tax systems such as GST and VAT, the amount of tax is included in the price of an item and in this case, this field will return |
tax_price | { "tax_price" : "3.04" } The total amount of all taxes applied to the order. |
included_tax_price | { "included_tax_price" : "3.04" } The total amount of all taxes applied to the order that are included as part of the item prices. |
tax_label | { "tax_label" : "GST" } The description of the tax item applied to the entire order. |
discount_price | { "discount_price" : "0.0" } The total amount of all discounts that have been applied to the order via coupon codes. Note that this does not include the amount of any discount that has been calculated as a result of a shopping cart discount. This amount is available through |
cart_discount_price | { "cart_discount_price" : "3.8" } The total amount of all discounts that have been applied to the order via shopping cart discounts. |
shipping_price | { "shipping_price" : "17.2" } The total amount of shipping costs for the order. |
shipping_lines | { "shipping_lines" : [ An array of
|
subtotal_price | { "subtotal_price" : "16.19" } The total amount of the order less coupon code discounts, but before shipping and additional taxes. |
total_line_items_price | { "total_line_items_price" : "16.19" } The total amount of the order, before shipping and additional taxes and before any coupon code discounts have been applied. |
total_price | { "total_price" : "33.39" } The total amount of all items in the order, including shipping, taxes and discounts. |
test | { "test" : false } Return true if this is a test order. |
gateway | { "gateway" : "Bank Deposit" } The name of the payment gateway that was used to process the payment for this order. |
note | { "note" : "This order has top priority." } The text of an optional note that can be attach to the order by the store owner. |
total_weight | { "total_weight" : 200.0 } The total weight of all items in the order, expressed in grams. |
financial_status | { "financial_status" : "paid" } Returns the current financial status of the order. The following statuses are used:
|
fulfilment_status | { "fulfilment_status" : null } Returns the current fulfilment status of the order. The following statuses are used:
|
tax_lines | { "tax_lines" : [ An array of
|
cancel_reason | { "cancel_reason" : "Fraudulent order" } If an order has been cancelled, the reason for the cancellation is returned. The following reasons may be returned:
|
cancelled_at | { "cancelled_at" : "2015-02-23T03:02:51Z" } The date and time when the order was cancelled. The timestamp is in ISO 8601 format. |
closed_at | { "closed_at" : "2015-02-23T03:02:51Z" } The date and time when the order was closed. The timestamp is in ISO 8601 format. |
discount_codes | { "discount_codes" : [ An array of
The following discount types are supported:
|
billing_address | { "billing_address" : { Returns the billing address associated with the order. The address has the following properties:
|
shipping_address | { "shipping_address" : { Returns the shipping address associated with the order. The address has the following properties:
|
customer | { "customer" : { Returns an object containing information about the customer. This information is only available if the customer has registered for an account, so this information will not be available for guest checkout orders. Customer objects contain the following fields:
|
line_items | { "line_items" : [ An array of
Items that are marked as gift cards are not taxed or included in any shipping charge calculations. |
fulfilments | { "fulfilments" : [ An array of
|
transactions | { "transactions" : [ An array of
|
Endpoints
GET /api/orders.json
Return a list of orders.
Optional Parameters
limit | Number of results returned. The default is 30, with a maximum of 50 in a single request. |
page | The number of the page to return. The number of results per page is set by the limit parameter. If more results are required, then submit the request again, increasing the page number each time.
|
ids | A comma-separated list of products ids. |
since_id | Limit the results to only include objects which have an id greater than the given value. |
vendor | Limit the results to only include products supplied by the given vendor. |
product_type | Limit the results to only include products that belong to the given product_type. |
handle | Return the product with the given handle. |
collection_id | Return only the products that belong to the given collection. |
created_at_min | Return only the products created after the given date and time. Use the format "2014-12-31 12:00". |
created_at_max | Return only the products created before the given date and time. Use the format "2014-12-31 12:00". |
updated_at_min | Return only the products updated after the given date and time. Use the format "2014-12-31 12:00". |
updated_at_max | Return only the products updated before the given date and time. Use the format "2014-12-31 12:00". |
published_status | Return only products with the given published status.
|
featured_status | Return only products with the given featured status.
|
archived_status | Return only products with the given archived status.
|
fields | A comma-separated list of fields to return in the response. |