API Customer Credit - Revision history

Admin: /* Optional Parameters */

2018-08-21T23:54:53Z

Optional Parameters

Admin: /* Optional Parameters */

2018-08-21T23:54:33Z

Optional Parameters

Admin: /* Optional Parameters */

2018-06-06T04:54:26Z

Optional Parameters

Admin: /* Optional Parameters */

2018-06-06T04:53:29Z

Optional Parameters

Admin at 02:13, 24 May 2018

2018-05-24T02:13:43Z

Shawn: /* Further Reference */

2016-09-30T04:03:41Z

Further Reference

Shawn at 04:03, 30 September 2016

2016-09-30T04:03:00Z

Admin at 03:35, 30 September 2016

2016-09-30T03:35:58Z

Admin: Created page with "The Spiffy Stores API Customer Credit object represents a credit transaction that has been applied to a customer's account. Credits can be added to a customer's account when g..."

2016-09-30T03:34:52Z

Created page with "The Spiffy Stores API Customer Credit object represents a credit transaction that has been applied to a customer's account. Credits can be added to a customer's account when g..."

New page

The Spiffy Stores API Customer Credit object represents a credit transaction that has been applied to a customer's account. Credits can be added to a customer's account when goods are returned or they may be used as a form of loyalty bonus.

== Customer Credit Properties ==

<html>
<style type="text/css">
table.wikitable td { padding: 10px 20px !important; text-align: left; vertical-align: middle; }
</style>
</html>
{| class="wikitable" style="width: 100%"
|style="width: 30%"|id
|<code>{ "id" : 123456789 }</code> 
A unique numeric identifier for the customer credit. This ID is only used with the API interface.
|-
|amount
|<code>{ "amount" : 54.53 }</code> 
The value of the customer credit. Positive amounts record an increase to the total credit assigned to the customer's account. A negative amount represents the amount of credit that has been posted against an order.
|-
|description
|<code>{ "description" : "Goods returned from Order #12345" }</code> 
The description provides reference information on why the credit was issued or redeemed.
|-
|customer
|<code>{ "customer" : {   "id": 6,   "title": "Mr",   "first_name": "Frodo",   "last_name": "Baggins",   "name": "Mr Frodo Baggins",   "email": "frodo@theshire.com",   "accepts_marketing": true,   "created_at": "2010-06-15T13:15:50Z",   "updated_at": "2015-02-23T03:02:51Z",   "note": "This customer has an interest in rings.",   "orders_count": 512,   "state": "enabled",   "total_spent": "11230.63",   "sign_in_count": 261,   "current_sign_in_at": "2015-02-23T03:02:51Z",   "current_sign_in_ip": "192.168.10.164",   "last_sign_in_at": "2015-02-19T05:58:54Z",   "last_sign_in_ip": "192.168.10.164",   "wholesale": false,   "credit": "0.0",   "tags": "friend,ring_bearer,brave,hobbit" } }</code> 
Returns an object containing information about the customer.

Customer objects contain the following fields:

* id - A unique numeric identifier for the customer
* title - The customer's title
* first_name - The customer's first name
* last_name - The customer's last name
* name - The customer's full name, including title
* email - The customer's email address
* accepts_marketing - Acceptance of marketing emails
* created_at - The date and time when the account was created
* updated_at - The date and time when the account was updated
* note - Additional information about the customer
* orders_count - The number of orders placed by the customer
* state - The current state of the customer's account Valid states are:
** enabled
** disabled
** invited
** declined
* total_spent - The total amount spent by the customer
* sign_in_count - The number of successful sign ins
* current_sign_in_at - The time of the current sign in
* current_sign_in_ip - The IP address of current sign in
* last_sign_in_at - The time of the last sign in
* last_sign_in_ip - The IP address of the last sign in
* wholesale - Customer has access to wholesale prices
* credit - Amount of credit in customer's account
* tags - Tags associated with customer
|-
|order
|<code>{ "order" : { Order details… } }</code> 
Returns an object containing information about the order. The customer credit has an associated order only when a credit is being posted against a specific order. 
More detailed information about the order can be found at [[API Order]].
|-
|created_at
|<code>{ "created_at" : "2015-10-24T18:26:31Z" }</code> 
The date and time when the customer credit was created. The timestamp is in ISO 8601 format.
|-
|updated_at
|<code>{ "updated_at" : "2016-01-16T05:50:56Z" }</code> 
The date and time when the customer credit was last updated. The timestamp is in ISO 8601 format.
|}

== Endpoints ==

=== <code>GET /api/customer_credits.json</code> ===

Return a list of customer credits. Use the optional parameters to return specific customer credits.

==== 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 order ids.
|-
|since_id
|Limit the results to only include objects which have an id greater than the given value.
|-
|created_at_min
|Return only the customer credits created after the given date and time. Use the format "2014-12-31 12:00".
|-
|created_at_max
|Return only the customer credits created before the given date and time. Use the format "2014-12-31 12:00".
|-
|updated_at_min
|Return only the customer credits updated after the given date and time. Use the format "2014-12-31 12:00".
|-
|updated_at_max
|Return only the customer credits updated before the given date and time. Use the format "2014-12-31 12:00".
|-
|customer_id
|Return all the customer credits belonging to the specified customer.
|-
|fields
|A comma-separated list of fields to return in the response.
|}

==== Example Request and Response ====

<pre>
GET /api/customer_credits.json

HTTP/1.1 200 OK

{
"customer_credits": [
{
"id": 3456,
"amount": 5.0,
"description": "Signup Bonus",
"created_at": "2015-07-25T13:10:30Z",
"updated_at": "2015-07-25T13:10:30Z",
"customer":
{
"id": 6,
"title": "Mr",
"first_name": "Important",
"last_name": "Customer",
"name": "Mr Important Customer",
"email": "customer@customer.domain.com",
"accepts_marketing": true,
"created_at": "2010-06-15T13:15:50Z",
"note": "Here is some sample text.",
"orders_count": 512,
"state": "enabled",
"total_spent": "11230.63",
"updated_at": "2015-02-23T03:02:51Z",
"sign_in_count": 261,
"current_sign_in_at": "2015-02-23T03:02:51Z",
"current_sign_in_ip": "192.168.10.164",
"last_sign_in_at": "2015-02-19T05:58:54Z",
"last_sign_in_ip": "192.168.10.164",
"wholesale": true,
"credit": "100.0",
"tags":"friend,wholesaler"
},
"order": null
}, ...
]
}

Examples using filters

GET /api/customer_credits.json?limit=10

GET /api/customer_credits.json?customer_id=2322

</pre>

=== <code>GET /api/customer_credits/count.json</code> ===

Return a count of customer credits.

==== Optional Parameters ====

{| class="wikitable" style="width: 100%"
|style="width: 30%"|since_id
|Limit the results to only include objects which have an id greater than the given value.
|-
|created_at_min
|Return only the customer credits created after the given date and time. Use the format "2014-12-31 12:00".
|-
|created_at_max
|Return only the customer credits created before the given date and time. Use the format "2014-12-31 12:00".
|-
|updated_at_min
|Return only the customer credits updated after the given date and time. Use the format "2014-12-31 12:00".
|-
|updated_at_max
|Return only the customer credits updated before the given date and time. Use the format "2014-12-31 12:00".
|-
|customer_id
|Return all the customer credits belonging to the specified customer.
|}

==== Example Request and Response ====

<pre>
GET /api/customer_credits/count.json

HTTP/1.1 200 OK

{
"count": 123
}

Examples using filters

GET /api/customer_credits/count.json?customer_id=2322
</pre>

=== <code>GET /api/customer_credits/CUSTOMER_CREDIT_ID.json</code> ===

Return a single customer credit.

==== Optional Parameters ====

{| class="wikitable" style="width: 100%"
|style="width: 30%"|fields
|A comma-separated list of fields to return in the response.
|}

==== Example Request and Response ====

<pre>
GET /api/customer_credits/16789.json

HTTP/1.1 200 OK

{
"customer_credit":
{
"id": 16789,
"created_at": "2015-02-27T18:08:33Z",
"updated_at": "2015-02-27T18:08:33Z",
"amount": -105.0,
"description": "Payment for order #1234",
...
}
}

</pre>

=== <code>POST /api/customer_credits.json</code> ===

Create a new customer credit.

==== Example Request and Response ====

<pre>
POST /api/custmer_credits.json

{
"customer_credit": {
"amount": 11.11,
"description": "Signup bonus",
"customer_id": 42
}
}

HTTP/1.1 201 Created

</pre>

@@ Line 206: / Line 206: @@
 {| class="reference"
 !fields
-|A comma-separated list of fields to return in the response.
+|A comma-separated list of fields to return in the response. If a list of fields is provided, then the <code>customer</code> and <code>order</code> fields will always be excluded.
 |}

@@ Line 101: / Line 101: @@
 |-
 !fields
-|A comma-separated list of fields to return in the response.
+|A comma-separated list of fields to return in the response. If a list of fields is provided, then the <code>customer</code> and <code>order</code> fields will always be excluded.
 |}

← Older revision		Revision as of 04:03, 30 September 2016
Line 263:		Line 263:
	* [[Creating Private API Keys]]		* [[Creating Private API Keys]]
	* [[Using the API]]		* [[Using the API]]
		+	* [[API Reference]]

← Older revision		Revision as of 04:03, 30 September 2016
Line 255:		Line 255:

	</pre>		</pre>
		+
		+	<br><br><br>
		+
		+	== Further Reference ==
		+
		+	* [[An Introduction to the Spiffy Stores API]]
		+	* [[Creating Private API Keys]]
		+	* [[Using the API]]

← Older revision		Revision as of 03:35, 30 September 2016
Line 1:		Line 1:
	The Spiffy Stores API Customer Credit object represents a credit transaction that has been applied to a customer's account. Credits can be added to a customer's account when goods are returned or they may be used as a form of loyalty bonus.		The Spiffy Stores API Customer Credit object represents a credit transaction that has been applied to a customer's account. Credits can be added to a customer's account when goods are returned or they may be used as a form of loyalty bonus.
		+
		+	Credits in a customer's account may then be used as payment or partial payment against future orders.

	== Customer Credit Properties ==		== Customer Credit Properties ==

@@ Line 204: / Line 204: @@
 ==== Optional Parameters ====
-{| class="wikitable" style="width: 100%"
+{| class="reference"
-|style="width: 30%"|fields
+!fields
 |A comma-separated list of fields to return in the response.
 |}

@@ Line 162: / Line 162: @@
 ==== Optional Parameters ====
-{| class="wikitable" style="width: 100%"
+{| class="reference"
-|style="width: 30%"|since_id
+!since_id
 |Limit the results to only include objects which have an id greater than the given value.
 |-
-|created_at_min
+!created_at_min
 |Return only the customer credits created after the given date and time. Use the format "2014-12-31 12:00".
 |-
-|created_at_max
+!created_at_max
 |Return only the customer credits created before the given date and time. Use the format "2014-12-31 12:00".
 |-
-|updated_at_min
+!updated_at_min
 |Return only the customer credits updated after the given date and time. Use the format "2014-12-31 12:00".
 |-
-|updated_at_max
+!updated_at_max
 |Return only the customer credits updated before the given date and time. Use the format "2014-12-31 12:00".
 |-
-|customer_id
+!customer_id
 |Return all the customer credits belonging to the specified customer.
 |}

@@ Line 5: / Line 5: @@
 == Customer Credit Properties ==
-<html>
+{| class="reference"
-  <style type="text/css">
+!id
 |<code>{ "id" : 123456789 }</code><br/>
 A unique numeric identifier for the customer credit. This ID is only used with the API interface.
 |-
-|amount
+!amount
 |<code>{ "amount" : 54.53 }</code><br/>
 The value of the customer credit. Positive amounts record an increase to the total credit assigned to the customer's account. A negative amount represents the amount of credit that has been posted against an order.
 |-
-|description
+!description
 |<code>{ "description" : "Goods returned from Order #12345" }</code><br/>
 The description provides reference information on why the credit was issued or redeemed.
 |-
-|customer
+!customer
 |<code>{ "customer" : {<br/>&nbsp;&nbsp;"id": 6,<br/>&nbsp;&nbsp;"title": "Mr",<br/>&nbsp;&nbsp;"first_name": "Frodo",<br/>&nbsp;&nbsp;"last_name": "Baggins",<br/>&nbsp;&nbsp;"name": "Mr Frodo Baggins",<br/>&nbsp;&nbsp;"email": "frodo@theshire.com",<br/>&nbsp;&nbsp;"accepts_marketing": true,<br/>&nbsp;&nbsp;"created_at": "2010-06-15T13:15:50Z",<br/>&nbsp;&nbsp;"updated_at": "2015-02-23T03:02:51Z",<br/>&nbsp;&nbsp;"note": "This customer has an interest in rings.",<br/>&nbsp;&nbsp;"orders_count": 512,<br/>&nbsp;&nbsp;"state": "enabled",<br/>&nbsp;&nbsp;"total_spent": "11230.63",<br/>&nbsp;&nbsp;"sign_in_count": 261,<br/>&nbsp;&nbsp;"current_sign_in_at": "2015-02-23T03:02:51Z",<br/>&nbsp;&nbsp;"current_sign_in_ip": "192.168.10.164",<br/>&nbsp;&nbsp;"last_sign_in_at": "2015-02-19T05:58:54Z",<br/>&nbsp;&nbsp;"last_sign_in_ip": "192.168.10.164",<br/>&nbsp;&nbsp;"wholesale": false,<br/>&nbsp;&nbsp;"credit": "0.0",<br/>&nbsp;&nbsp;"tags": "friend,ring_bearer,brave,hobbit"<br/>} }</code><br/>
 Returns an object containing information about the customer.
@@ Line 55: / Line 50: @@
 * tags - Tags associated with customer
 |-
-|order
+!order
 |<code>{ "order" : { Order details&hellip; } }</code><br/>
 Returns an object containing information about the order. The customer credit has an associated order only when a credit is being posted against a specific order.<br/>
 More detailed information about the order can be found at [[API Order]].
 |-
-|created_at
+!created_at
 |<code>{ "created_at" : "2015-10-24T18:26:31Z" }</code><br/>
 The date and time when the customer credit was created. The timestamp is in ISO 8601 format.
 |-
-|updated_at
+!updated_at
 |<code>{ "updated_at" : "2016-01-16T05:50:56Z" }</code><br/>
 The date and time when the customer credit was last updated. The timestamp is in ISO 8601 format.
@@ Line 77: / Line 72: @@
 ==== Optional Parameters ====
-{| class="wikitable" style="width: 100%"
+{| class="reference"
-|style="width: 30%"|limit
+!limit
 |Number of results returned. The default is 30, with a maximum of 50 in a single request.
 |-
-|page
+!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
+!ids
 |A comma-separated list of order ids.
 |-
-|since_id
+!since_id
 |Limit the results to only include objects which have an id greater than the given value.
 |-
-|created_at_min
+!created_at_min
 |Return only the customer credits created after the given date and time. Use the format "2014-12-31 12:00".
 |-
-|created_at_max
+!created_at_max
 |Return only the customer credits created before the given date and time. Use the format "2014-12-31 12:00".
 |-
-|updated_at_min
+!updated_at_min
 |Return only the customer credits updated after the given date and time. Use the format "2014-12-31 12:00".
 |-
-|updated_at_max
+!updated_at_max
 |Return only the customer credits updated before the given date and time. Use the format "2014-12-31 12:00".
 |-
-|customer_id
+!customer_id
 |Return all the customer credits belonging to the specified customer.
 |-
-|fields
+!fields
 |A comma-separated list of fields to return in the response.
 |}