Difference between revisions of "API Order"
From Spiffy Stores Knowledge Base
| Line 14: | Line 14: | ||
|- | |- | ||
|order_number | |order_number | ||
| − | |<code>{ "order_number" : | + | |<code>{ "order_number" : 1045 }</code><br/> |
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 <code>id</code>, which is only used to refer to orders within the API. | 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 <code>id</code>, which is only used to refer to orders within the API. | ||
| + | |- | ||
| + | |name | ||
| + | |<code>{ "name" : "#001045" }</code><br/> | ||
| + | This is the <code>order_number</code>, formatted according the the store preferences for order number formatting. | ||
| + | |- | ||
| + | |browser_ip | ||
| + | |<code>{ "browser_ip" : "202.60.66.249" }</code><br/> | ||
| + | This is the IP address used by the customer when the order was placed. | ||
| + | |- | ||
| + | |buyer_accepts_marketing | ||
| + | |<code>{ "buyer_accepts_marketing" : true }</code><br/> | ||
| + | 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. | ||
| + | |||
| + | |||
|} | |} | ||
Revision as of 11:10, 23 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.
|