https://www.spiffystores.com.au/kb/index.php?action=history&feed=atom&title=API_Customer
API Customer - Revision history
2026-06-09T18:16:26Z
Revision history for this page on the wiki
MediaWiki 1.34.1
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7547&oldid=prev
Admin: /* Customer Properties */
2019-04-09T02:36:18Z
<p><span dir="auto"><span class="autocomment">Customer Properties</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 02:36, 9 April 2019</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l27" >Line 27:</td>
<td colspan="2" class="diff-lineno">Line 27:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|<pre>{ "name": "Mr Bilbo Baggins" }</pre></div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|<pre>{ "name": "Mr Bilbo Baggins" }</pre></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The customer's full name.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The customer's full name.</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|-</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">!company</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|<pre>{ "company": "ABC Packing Company" }</pre></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">The customer's company.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!email</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!email</div></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7441:rev-7547 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7441&oldid=prev
Admin: /* Example Request and Response */
2018-08-31T01:07:45Z
<p><span dir="auto"><span class="autocomment">Example Request and Response</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 01:07, 31 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l442" >Line 442:</td>
<td colspan="2" class="diff-lineno">Line 442:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "wholesale": false,</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "wholesale": false,</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "credit": 0.0,</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "credit": 0.0,</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"> "accounting_id": "2b74006d-a599-42dd-b228-52596f49333c",</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"> "pos_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "tags": "wholesaler",</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "tags": "wholesaler",</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "default_address": {</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "default_address": {</div></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7440:rev-7441 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7440&oldid=prev
Admin: /* Example Request and Response */
2018-08-31T01:07:18Z
<p><span dir="auto"><span class="autocomment">Example Request and Response</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 01:07, 31 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l235" >Line 235:</td>
<td colspan="2" class="diff-lineno">Line 235:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "wholesale": false,</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "wholesale": false,</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "credit": 0.0,</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "credit": 0.0,</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"> "accounting_id": "2b74006d-a599-42dd-b228-52596f49333c",</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"> "pos_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "tags": "wholesaler",</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "tags": "wholesaler",</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "default_address": {</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> "default_address": {</div></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7439:rev-7440 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7439&oldid=prev
Admin: /* Customer Properties */
2018-08-31T01:05:54Z
<p><span dir="auto"><span class="autocomment">Customer Properties</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 01:05, 31 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l139" >Line 139:</td>
<td colspan="2" class="diff-lineno">Line 139:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|<pre>{ "credit": 15.40 }</pre></div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|<pre>{ "credit": 15.40 }</pre></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The amount of store credit that the customer has in their account.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The amount of store credit that the customer has in their account.</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|-</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">!accounting_id</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|<pre>{ "accounting_id": "2b74006d-a599-42dd-b228-52596f49333c" }</pre></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">This field is used if the store has a supported accounting app installed. The field is used to store the value of the customer record id in the associated accounting software. This value can then be used to ensure that all orders for this customer are posted to the same customer account in the accounting software.</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|-</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">!pos_id</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|<pre>{ "pos_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4" }</pre></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">This field is used if the store has a supported point of sale app installed. The field is used to store the value of the customer record id in the associated point of sale software. This value can then be used to ensure that all orders for this customer are posted to the same customer account in the point of sale software.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!tags</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!tags</div></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7415:rev-7439 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7415&oldid=prev
Admin: /* GET /api/customers/CUSTOMER_ID.json */
2018-08-21T23:52:32Z
<p><span dir="auto"><span class="autocomment">GET /api/customers/CUSTOMER_ID.json</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 23:52, 21 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l399" >Line 399:</td>
<td colspan="2" class="diff-lineno">Line 399:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="reference"</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="reference"</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response.</div></td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response<ins class="diffchange diffchange-inline">. If a list of fields is provided, then the <code>default_address</code> and <code>addresses</code> fields will always be excluded</ins>.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7414:rev-7415 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7414&oldid=prev
Admin: /* Optional Parameters */
2018-08-21T23:52:05Z
<p><span dir="auto"><span class="autocomment">Optional Parameters</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 23:52, 21 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l334" >Line 334:</td>
<td colspan="2" class="diff-lineno">Line 334:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response.</div></td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response<ins class="diffchange diffchange-inline">. If a list of fields is provided, then the <code>default_address</code> and <code>addresses</code> fields will always be excluded</ins>.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7413:rev-7414 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7413&oldid=prev
Admin: /* Optional Parameters */
2018-08-21T23:49:47Z
<p><span dir="auto"><span class="autocomment">Optional Parameters</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 23:49, 21 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l193" >Line 193:</td>
<td colspan="2" class="diff-lineno">Line 193:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>!fields</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response.</div></td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>|A comma-separated list of fields to return in the response<ins class="diffchange diffchange-inline">. If a list of fields is provided, then the <code>default_address</code> and <code>addresses</code> fields will always be excluded</ins>.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7205:rev-7413 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7205&oldid=prev
Admin at 05:11, 23 May 2018
2018-05-23T05:11:26Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 05:11, 23 May 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td>
<td colspan="2" class="diff-lineno">Line 1:</td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"><html></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> <style type="text/css"></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> table.reference {</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> width: 100%;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> border: 1px solid #c9c9c9;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> }</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> table.reference th, table.reference td {</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> border: 1px solid #c9c9c9;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> padding: 10px;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> }</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> table.reference th {</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> text-align: left;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> vertical-align: top;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> width: 30%;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> font-size: 100%;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> }</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> table.reference td pre {</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> margin: 10px 0px;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> font-size: 80%;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> display: block;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> }</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> pre {</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> width: 100%;</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> }</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"> </style></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"></html></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The Customer resource stores information about a store's customers, such as their contact details, their order history, and whether they've agreed to receive email marketing.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The Customer resource stores information about a store's customers, such as their contact details, their order history, and whether they've agreed to receive email marketing.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7200:rev-7205 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7200&oldid=prev
Admin: /* Page Properties */
2018-05-23T02:53:19Z
<p><span dir="auto"><span class="autocomment">Page Properties</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 02:53, 23 May 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l32" >Line 32:</td>
<td colspan="2" class="diff-lineno">Line 32:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>For security reasons, the Customer resource doesn't store credit card information. Customers always need to enter this information when they go to the checkout.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>For security reasons, the Customer resource doesn't store credit card information. Customers always need to enter this information when they go to the checkout.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>== <del class="diffchange diffchange-inline">Page </del>Properties ==</div></td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>== <ins class="diffchange diffchange-inline">Customer </ins>Properties ==</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="reference"</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="reference"</div></td></tr>
<!-- diff cache key spiffystores_kb_134-mediawiki-:diff::1.12:old-7199:rev-7200 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Customer&diff=7199&oldid=prev
Admin: Created page with "<html> <style type="text/css"> table.reference { width: 100%; border: 1px solid #c9c9c9; } table.reference th, table.reference td { border: 1px..."
2018-05-23T02:37:16Z
<p>Created page with "<html> <style type="text/css"> table.reference { width: 100%; border: 1px solid #c9c9c9; } table.reference th, table.reference td { border: 1px..."</p>
<p><b>New page</b></p><div><html><br />
<style type="text/css"><br />
table.reference {<br />
width: 100%;<br />
border: 1px solid #c9c9c9;<br />
}<br />
table.reference th, table.reference td {<br />
border: 1px solid #c9c9c9;<br />
padding: 10px;<br />
}<br />
table.reference th {<br />
text-align: left;<br />
vertical-align: top;<br />
width: 30%;<br />
font-size: 100%;<br />
}<br />
table.reference td pre {<br />
margin: 10px 0px;<br />
font-size: 80%;<br />
display: block;<br />
}<br />
pre {<br />
width: 100%;<br />
}<br />
</style><br />
</html><br />
<br />
The Customer resource stores information about a store's customers, such as their contact details, their order history, and whether they've agreed to receive email marketing.<br />
<br />
The Customer resource also holds information on the status of a customer's account. Customers with accounts save time at checkout when they're logged in because they don't need to enter their contact information. You can use the Customer API to check whether a customer has an active account, and then invite them to create one if they don't.<br />
<br />
For security reasons, the Customer resource doesn't store credit card information. Customers always need to enter this information when they go to the checkout.<br />
<br />
== Page Properties ==<br />
<br />
{| class="reference"<br />
!id<br />
|<pre>{ "id" : 123456789 }</pre><br />
A unique numeric identifier for the customer.<br />
|-<br />
!title<br />
|<pre>{ "title": "Mr" }</pre><br />
The salutation or title for the customer.<br />
|-<br />
!first_name<br />
|<pre>{ "first_name": "Bilbo" }</pre><br />
The customer's first name.<br />
|-<br />
!last_name<br />
|<pre>{ "last_name": "Baggins" }</pre><br />
The customer's last name.<br />
|-<br />
!name<br />
|<pre>{ "name": "Mr Bilbo Baggins" }</pre><br />
The customer's full name.<br />
|-<br />
!email<br />
|<pre>{ "email": "bilbo@lordoftherings.com" }</pre><br />
The unique email address of the customer. Attempting to assign the same email address to multiple<br />
customers returns an error.<br />
|-<br />
!default_address<br />
|<pre>{ "default_address": {<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
}<br />
}</pre><br />
The default address for the customer.<br />
|-<br />
!addresses<br />
|<pre>{ "addresses": [<br />
{<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
}<br />
]<br />
}</pre><br />
A list of the customer's addresses.<br />
|-<br />
!accepts_marketing<br />
|<pre>{ "accepts_marketing": false }</pre><br />
This indicates whether the customer has consented to receive marketing material via email.<br />
|-<br />
!note<br />
|<pre>{ "note": "This customer is eligible for the frequent traveller bonus." }</pre><br />
A note about the customer.<br />
|-<br />
!orders_count<br />
|<pre>{ "orders_count": 32 }</pre><br />
The number of orders associated with this customer.<br />
|-<br />
!state<br />
|<pre>{ "state": "enabled" }</pre><br />
The state of the customer's account with a store. The state can be changed in the toolbox or by the<br />
customer, but not through the API. It is disabled by default.<br />
<br />
Valid values are:<br />
<br />
* guest: The customer does not have an account.<br />
* disabled: The customer doesn't have an active account. Customer acounts can be disabled from the toolbox at any time.<br />
* invited: The customer has received an emailed invitation to create an account.<br />
* enabled: The customer has created an account.<br />
* declined: The customer declined the email invitation to create an account.<br />
|-<br />
!total_spent<br />
|<pre>{ "total_spent": "465.30" }</pre><br />
The total amount of money that the customer has spent across their order history.<br />
|-<br />
!sign_in_count<br />
|<pre>{ "sign_in_count": 314 }</pre><br />
The number of times that the customer has signed in.<br />
|-<br />
!current_sign_in_at<br />
|<pre>{ "current_sign_in_at": "2017-09-20T10:47:18.424+10:00" }</pre><br />
The time of the current sign-in.<br />
|-<br />
!current_sign_in_ip<br />
|<pre>{ "current_sign_in_ip": "192.168.10.200" }</pre><br />
The IP address used by the customer for the current sign-in.<br />
|-<br />
!last_sign_in_at<br />
|<pre>{ "last_sign_in_at": "2017-09-20T10:43:18.716+10:00" }</pre><br />
The time of the previous sign-in.<br />
|-<br />
!last_sign_in_ip<br />
|<pre>{ "last_sign_in_ip": "192.168.10.200" }</pre><br />
The IP address used by the customer for the previous sign-in.<br />
|-<br />
!last_order_id<br />
|<pre>{ "last_order_id": 23919 }</pre><br />
The ID of the customer's last order.<br />
|-<br />
!wholesale<br />
|<pre>{ "wholesale": true }</pre><br />
The customer has access to wholesale pricing.<br />
|-<br />
!credit<br />
|<pre>{ "credit": 15.40 }</pre><br />
The amount of store credit that the customer has in their account.<br />
|-<br />
!tags<br />
|<pre>{ "tags": "loyal,wholesaler" }</pre><br />
Tags that the store owner has attached to the customer, formatted as a string of comma-separated values.<br />
|-<br />
!created_at<br />
|<pre>{ "created_at": "2008-07-15T20:00:00-04:00" }</pre><br />
The date and time (ISO 8601 format) when the customer was created.<br />
|-<br />
!updated_at<br />
|<pre>{ "updated_at": "2008-07-16T20:00:00-04:00" }</pre><br />
The date and time (ISO 8601 format) when the customer was last updated.<br />
|}<br />
<br />
== Endpoints ==<br />
<br />
=== <code>GET /api/customers.json</code> ===<br />
<br />
Retrieve a list of customers.<br />
<br />
==== Optional Parameters ====<br />
<br />
{| class="reference"<br />
!limit<br />
|Number of results returned. The default is 30, with a maximum of 50 in a single request.<br />
|-<br />
!page<br />
|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.<br />
|-<br />
!ids<br />
|Restrict results to customers specified by a comma-separated list of IDs.<br />
|-<br />
!since_id<br />
|Limit the results to only include objects which have an id greater than the given value.<br />
|-<br />
!wholesale_status<br />
|Limit the results to only include customers with the given wholesale status ('wholesale' or 'retail').<br />
|-<br />
!marketing_status<br />
|Limit the results to only include customers with the given marketing status ('accepts_marketing' or 'rejects_marketing').<br />
|-<br />
!created_at_min<br />
|Return only the customers created after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!created_at_max<br />
|Return only the customers created before the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_min<br />
|Return only the customers updated after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_max<br />
|Return only the customers updated before the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!fields<br />
|A comma-separated list of fields to return in the response.<br />
|}<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
GET /api/customers.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"customers": [<br />
{<br />
"id": 6,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"email": "bilbo@lordoftherings.com",<br />
"accepts_marketing": true,<br />
"note": "Here is some sample text.",<br />
"orders_count": 200,<br />
"state": "enabled",<br />
"total_spent": 13908.63,<br />
"created_at": "2010-06-15T23:15:50.925+10:00",<br />
"updated_at": "2017-09-20T10:47:18.428+10:00",<br />
"sign_in_count": 314,<br />
"current_sign_in_at": "2017-09-20T10:47:18.424+10:00",<br />
"current_sign_in_ip": "192.168.10.200",<br />
"last_sign_in_at": "2017-09-20T10:43:18.716+10:00",<br />
"last_sign_in_ip": "192.168.10.200",<br />
"last_order_id": 1353,<br />
"wholesale": false,<br />
"credit": 0.0,<br />
"tags": "wholesaler",<br />
"default_address": {<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
},<br />
"addresses": [<br />
{<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
}<br />
]<br />
}, ...<br />
]<br />
}<br />
<br />
Examples using filters<br />
<br />
GET /api/customers.json?fields=id,name,email<br />
<br />
GET /api/customers.json?whole_status=wholesale<br />
<br />
GET /api/customers.json?ids=232133,354345,234234<br />
<br />
</pre><br />
<br />
=== <code>GET /api/customers/search.json</code> ===<br />
<br />
Searches for customers that match a supplied query.<br />
<br />
==== Optional Parameters ====<br />
<br />
{| class="reference"<br />
!limit<br />
|Number of results returned. The default is 30, with a maximum of 50 in a single request.<br />
|-<br />
!page<br />
|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.<br />
|-<br />
!query<br />
|Text to search for in the store's customer data. The text is used to search the customer's name, email address and location.<br />
<br />
Additionally, or instead, search filters can be added to limit the search. A search filter may be prefixed by '-' to indicate the condition is negated.<br />
<br />
For example, the following search filter could be specified - '-country:Australia total_spent:>100'<br />
<br />
The following search filters can be specified:<br />
<br />
* accepts_marketing (0 or 1)<br />
* country (country name)<br />
* last_abandoned_order_date (last_week or last_month)<br />
* order_date (last_week, last_month, last_3_months, <yyyy-mm-dd or >yyyy-mm-dd)<br />
* orders_count (n, <n or >n)<br />
* state (guest, enabled, disabled, invited, declined)<br />
* total_spent (n, <n or >n)<br />
* credit (n, <n or >n)<br />
* wholesale (0 or 1)<br />
|-<br />
!since_id<br />
|Limit the results to only include objects which have an id greater than the given value.<br />
|-<br />
!wholesale_status<br />
|Limit the results to only include customers with the given wholesale status ('wholesale' or 'retail').<br />
|-<br />
!marketing_status<br />
|Limit the results to only include customers with the given marketing status ('accepts_marketing' or 'rejects_marketing').<br />
|-<br />
!created_at_min<br />
|Return only the customers created after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!created_at_max<br />
|Return only the customers created before the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_min<br />
|Return only the customers updated after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_max<br />
|Return only the customers updated before the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!fields<br />
|A comma-separated list of fields to return in the response.<br />
|}<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
GET /api/customers/search.json?query=Bilbo country:"New Zealand" total_spent:>100<br />
<br />
HTTP/1.1 200 OK<br />
</pre><br />
<br />
=== <code>GET /api/customers/count.json</code> ===<br />
<br />
Return a count of the number of customers.<br />
<br />
==== Optional Parameters ====<br />
<br />
{| class="reference"<br />
!since_id<br />
|Limit the results to only include objects which have an id greater than the given value.<br />
|-<br />
!wholesale_status<br />
|Limit the results to only include customers with the given wholesale status ('wholesale' or 'retail').<br />
|-<br />
!marketing_status<br />
|Limit the results to only include customers with the given marketing status ('accepts_marketing' or 'rejects_marketing').<br />
|-<br />
!created_at_min<br />
|Return only the customers created after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!created_at_max<br />
|Return only the customers created before the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_min<br />
|Return only the customers updated after the given date and time. Use the format "2014-12-31 12:00".<br />
|-<br />
!updated_at_max<br />
|Return only the customers updated before the given date and time. Use the format "2014-12-31 12:00".<br />
|}<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
GET /api/customers/count.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"count": 14567<br />
}<br />
<br />
Examples using filters<br />
<br />
GET /api/customers/count.json?marketing_status=accepts_marketing<br />
<br />
</pre><br />
<br />
=== <code>GET /api/customers/CUSTOMER_ID.json</code> ===<br />
<br />
Retrieves a single customer by ID.<br />
<br />
==== Optional Parameters ====<br />
<br />
{| class="reference"<br />
!fields<br />
|A comma-separated list of fields to return in the response.<br />
|}<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
GET /api/customers/6.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"customer": {<br />
"id": 6,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"email": "bilbo@lordoftherings.com",<br />
"accepts_marketing": true,<br />
"note": "Here is some sample text.",<br />
"orders_count": 200,<br />
"state": "enabled",<br />
"total_spent": 13908.63,<br />
"created_at": "2010-06-15T23:15:50.925+10:00",<br />
"updated_at": "2017-09-20T10:47:18.428+10:00",<br />
"sign_in_count": 314,<br />
"current_sign_in_at": "2017-09-20T10:47:18.424+10:00",<br />
"current_sign_in_ip": "192.168.10.200",<br />
"last_sign_in_at": "2017-09-20T10:43:18.716+10:00",<br />
"last_sign_in_ip": "192.168.10.200",<br />
"last_order_id": 1353,<br />
"wholesale": false,<br />
"credit": 0.0,<br />
"tags": "wholesaler",<br />
"default_address": {<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
},<br />
"addresses": [<br />
{<br />
"id": 1969,<br />
"title": "Mr",<br />
"first_name": "Bilbo",<br />
"last_name": "Baggins",<br />
"name": "Mr Bilbo Baggins",<br />
"company": "The Fellowship of the Ring",<br />
"address1": "2 Bag End",<br />
"address2": "",<br />
"city": "Hobbiton",<br />
"province": "Waikato",<br />
"province_code": "WKO",<br />
"country": "New Zealand",<br />
"country_code": "NZ",<br />
"zip": "1234",<br />
"phone": "123456789",<br />
"default": true<br />
}<br />
]<br />
}<br />
}<br />
</pre><br />
<br />
=== <code>POST /api/customers.json</code> ===<br />
<br />
Creates a customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
POST /api/customers.json<br />
<br />
{<br />
"customer": {<br />
"title": "Mr",<br />
"first_name": "Gandalf",<br />
"last_name": "Wizard",<br />
"email": "gandalf@lordoftherings.com",<br />
...<br />
}<br />
}<br />
<br />
HTTP/1.1 201 Created<br />
</pre><br />
<br />
=== <code>PUT /api/customers/CUSTOMER_ID.json</code> ===<br />
<br />
Updates a customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
PUT /api/customers/6.json<br />
<br />
{<br />
"customer": {<br />
"id": 6,<br />
"note": "The ring has been found."<br />
}<br />
}<br />
<br />
HTTP/1.1 200 OK<br />
</pre><br />
<br />
=== <code>DELETE /api/customers/CUSTOMER_ID.json</code> ===<br />
<br />
Deletes a customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
DELETE /api/customers/6.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{}<br />
</pre><br />
<br />
== Further Reference ==<br />
<br />
* [[An Introduction to the Spiffy Stores API]]<br />
* [[Creating Private API Keys]]<br />
* [[Using the API]]<br />
* [[API Reference]]</div>
Admin