Query all tax information in the store

Requires read_shipping access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/countries.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

countriesobject[]

Tax list
code string

National code
Example: US
custom_tax_infoobject[]

Custom tax information
type string

Tax type
Example: product_category
countryobject

Country
name string

National name
Example: USA
provincesobject[]

Province information
tax_name string

Tax name
Example: VAT
tax_percentage string

Tax percentage value
Example: 5%
code string

Province code
Example: AJ
country_id string

National id
Example: 1213231
id string

id
Example: 12323
name string

Province name
Example: Washington
tax string

Tax value
Example: 0.05
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT
code string

National code
Example: US
name string

Custom tax name
Example: Product classification 1
product_category_id string

Product classification id
Example: 1231232311
id string

Store dimension national id
Example: 4220
name string

National name
Example: USA
provincesobject[]

Province information
name string

Province name
Example: Washington
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT
tax_percentage string

Tax percentage value
Example: 5%
code string

Province code
Example: AJ
country_id string

National id
Example: 1232332
id string

id
Example: 12323
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/countries.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal