https://www.spiffystores.com.au/kb/index.php?action=history&feed=atom&title=API_Address
API Address - Revision history
2026-06-15T12:17:13Z
Revision history for this page on the wiki
MediaWiki 1.34.1
https://www.spiffystores.com.au/kb/index.php?title=API_Address&diff=7204&oldid=prev
Admin at 05:10, 23 May 2018
2018-05-23T05:10:59Z
<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:10, 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 Address resource stores the addresses that a customer has entered. Each customer can have multiple addresses associated with 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 Address resource stores the addresses that a customer has entered. Each customer can have multiple addresses associated with their account.</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-7202:rev-7204 -->
</table>
Admin
https://www.spiffystores.com.au/kb/index.php?title=API_Address&diff=7202&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-23T03:18:32Z
<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 Address resource stores the addresses that a customer has entered. Each customer can have multiple addresses associated with their account.<br />
<br />
== Address Properties ==<br />
<br />
{| class="reference"<br />
!id<br />
|<pre>{ "id" : 123456789 }</pre><br />
A unique numeric identifier for the address.<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 />
!company<br />
|<pre>{ "company": "The Fellowship of the Ring" }</pre><br />
The customer's company name.<br />
|-<br />
!address1<br />
|<pre>{ "address1": "2 Bag End" }</pre><br />
The customer's first address line.<br />
|-<br />
!address2<br />
|<pre>{ "address2": "" }</pre><br />
The customer's second address line.<br />
|-<br />
!city<br />
|<pre>{ "city": "Hobbiton" }</pre><br />
The customer's city.<br />
|-<br />
!province<br />
|<pre>{ "province": "Waikato" }</pre><br />
The customer's province, state or region.<br />
|-<br />
!province_code<br />
|<pre>{ "province_code": "WKO" }</pre><br />
The customer's province, state or region code.<br />
|-<br />
!country<br />
|<pre>{ "country": "New Zealand" }</pre><br />
The customer's country.<br />
|-<br />
!country_code<br />
|<pre>{ "country_code": "NZ" }</pre><br />
The customer's country code.<br />
|-<br />
!zip<br />
|<pre>{ "zip": "1234" }</pre><br />
The customer's postal code.<br />
|-<br />
!phone<br />
|<pre>{ "phone": "123456789" }</pre><br />
The customer's phone number.<br />
|-<br />
!default<br />
|<pre>{ "default": true }</pre><br />
This is the default address for the customer.<br />
|}<br />
<br />
== Endpoints ==<br />
<br />
=== <code>GET /api/customers/CUSTOMER_ID/addresses.json</code> ===<br />
<br />
Retrieve a list of addresses for the customer.<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 />
!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/4123/addresses.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"addressess": [<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 />
Examples using filters<br />
<br />
GET /api/customers/4123/addresses.json?fields=id,name,country<br />
<br />
</pre><br />
<br />
=== <code>GET /api/customers/CUSTOMER_ID/addresses/count.json</code> ===<br />
<br />
Return a count of the number of addresses belonging to a customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
GET /api/customers/4123/addresses/count.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"count": 5<br />
}<br />
<br />
</pre><br />
<br />
=== <code>GET /api/customers/CUSTOMER_ID/addresses/ADDRESS_ID.json</code> ===<br />
<br />
Retrieves a single address 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/4123/addresses/1969.json<br />
<br />
HTTP/1.1 200 OK<br />
<br />
{<br />
"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 />
}<br />
</pre><br />
<br />
=== <code>POST /api/customers/CUSTOMER_ID/addresses.json</code> ===<br />
<br />
Creates an address for the customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
POST /api/customers/4123/addresses.json<br />
<br />
{<br />
"address": {<br />
"title": "Mr",<br />
"first_name": "Gandalf",<br />
"last_name": "Wizard",<br />
...<br />
}<br />
}<br />
<br />
HTTP/1.1 201 Created<br />
</pre><br />
<br />
=== <code>PUT /api/customers/CUSTOMER_ID/addresses/ADDRESS_ID.json</code> ===<br />
<br />
Updates an address for the customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
PUT /api/customers/4123/addresses/1969.json<br />
<br />
{<br />
"address": {<br />
"id": 1969,<br />
"phone": "987654321"<br />
}<br />
}<br />
<br />
HTTP/1.1 200 OK<br />
</pre><br />
<br />
=== <code>DELETE /api/customers/CUSTOMER_ID/addresses/ADDRESS_ID.json</code> ===<br />
<br />
Deletes a address from the customer.<br />
<br />
==== Example Request and Response ====<br />
<br />
<pre><br />
DELETE /api/customers/4123/addresses/1969.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