Admin: /* Optional Parameters */

2018-08-21T22:58:03Z

Optional Parameters

Admin: /* Optional Parameters */

2018-08-21T22:57:45Z

Optional Parameters

Admin: /* Country Properties */

2018-05-24T01:00:54Z

Country Properties

Admin: Created page with "The Country resource represents the tax rates applied to orders from the different countries where a store sells its products. Merchants select the countries for which they w..."

2018-05-23T07:44:33Z

Created page with "The Country resource represents the tax rates applied to orders from the different countries where a store sells its products. Merchants select the countries for which they w..."

New page

The Country resource represents the tax rates applied to orders from the different countries where a store sells its products.

Merchants select the countries for which they wish to accept sales for their products when they set up their Shipping Countries on the Regions and Taxes page of the toolbox.

The Country resource lets you access the countries and tax rates set up by the merchant. The countries list includes a default entry called 'Rest of World', which represents all non-specified countries.

You can use the Country resource to modify the sales tax rate for a country or sub-region to account for surtaxes or exemptions that apply to the store.

== Country Properties ==

{| class="reference"
!id
|<pre>{ "id" : 113 }</pre>
A unique numeric identifier for the country.
|-
!name
|<pre>{ "name": "Australia" }</pre>
The full name of the country in English.
|-
!code
|<pre>{ "code": "AU" }</pre>
The 2-letter international country code.
|-
!tax
|<pre>{ "tax": 0.1 }</pre>
The national sales tax rate applied to orders made by customers from that country.
|-
!tax_percentage
|<pre>{ "tax_percentage": 10.0 }</pre>
The national sales tax rate applied to orders made by customers from that country. This is expressed as a percentage.
|-
!tax_name
|<pre>{ "tax_name": "GST" }</pre>
The name of the national sales tax.
|-
!tax_inclusive
|<pre>{ "tax_inclusive": true }</pre>
Indicates whether prices are quoted including or excluding sales tax.
|-
!free_shipping
|<pre>{ "free_shipping": true }</pre>
Indicates that the country is eligible for free shipping.
|-
!handling_fee
|<pre>{ "handling_fee": 0.0 }</pre>
The default handling fee that is added to the cost of shipping to the country.
|-
!currency
|<pre>{ "currency": "AUD" }</pre>
The currency used in this country.
|-
!unit_system
|<pre>{ "unit_system": "metric" }</pre>
The unit system used in this country.
|-
!provinces
|<pre>{
"provinces": [
{
"id": 1218,
"name": "Australian Capital Territory",
"code": "ACT",
"country_id": 113,
"tax": 0.00,
"tax_percentage": 0.0,
"tax_name": "GST",
"free_shipping": true,
"handling_fee": 0.0
},
...
]
}</pre>
The sub-regions of a country, such as its provinces or states.
|-
|}

== Endpoints ==

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

Retrieve a list of all countries.

==== Optional Parameters ====

{| class="reference"
!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.
|-
!fields
|A comma-separated list of fields to return in the response.
|}

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

<pre>
GET /api/countries.json

HTTP/1.1 200 OK

{
"countries": [
{
"id": 270,
"name": "Algeria",
"code": "DZ",
"tax": 0.17,
"tax_percentage": 17.0,
"tax_name": "VAT",
"tax_inclusive": true,
"free_shipping": false,
"handling_fee": 0.0,
"currency": "DZD",
"unit_system": "metric",
"provinces": [
]
}, ...
]
}

Examples using filters

GET /api/countries.json?fields=id,name,currency

</pre>

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

Return a count of the number of countries.

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

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

HTTP/1.1 200 OK

{
"count": 15
}

</pre>

=== <code>GET /api/countries/COUNTRY_ID.json</code> ===

Retrieves a single country by ID.

==== Optional Parameters ====

{| class="reference"
!fields
|A comma-separated list of fields to return in the response.
|}

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

<pre>
GET /api/countries/270.json

HTTP/1.1 200 OK

{
"country": {
"id": 270,
"name": "Algeria",
"code": "DZ",
"tax": 0.17,
"tax_percentage": 17.0,
"tax_name": "VAT",
"tax_inclusive": true,
"free_shipping": false,
"handling_fee": 0.0,
"currency": "DZD",
"unit_system": "metric",
"provinces": [
]
}
}
</pre>

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

Add a country to the store.

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

<pre>
POST /api/countries.json

{
"country": {
"code": "FR"
}
}

or

{
"country": {
"name": "France",
"tax": 0.15,
"tax_name": "VAT",
...
}
}

HTTP/1.1 201 Created
</pre>

=== <code>PUT /api/countries/COUNTRY_ID.json</code> ===

Updates a store country.

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

<pre>
PUT /api/countries/270.json

{
"country": {
"id": 270,
"free_shipping": true
}
}

HTTP/1.1 200 OK
</pre>

=== <code>DELETE /api/countries/COUNTRY_ID.json</code> ===

Deletes a country from the store.

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

<pre>
DELETE /api/countries/270.json

HTTP/1.1 200 OK

{}
</pre>

== Further Reference ==

* [[An Introduction to the Spiffy Stores API]]
* [[Creating Private API Keys]]
* [[Using the API]]
* [[API Reference]]

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

@@ Line 72: / Line 72: @@
 }</pre>
 The sub-regions of a country, such as its provinces or states.
 |}

API Country - Revision history

Admin: /* Optional Parameters */

Admin: /* Optional Parameters */

Admin: /* Country Properties */

Admin: Created page with "The Country resource represents the tax rates applied to orders from the different countries where a store sells its products. Merchants select the countries for which they w..."