Query specify tax information from the country

Requires read_shipping access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/countries/:id.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 .

Path Parameters

id string required

International code id for the store dimension

Example: 13445

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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

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

dataobject

Return body
countryobject

National structural body
provincesobject[]

Province structure
code string

Province code
Example: AJ
country_id string

National id
Example: 1000034
id string

Province id
Example: 100003666
name string

Province name
Example: Washington
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT
tax_percentage string

Tax 100 points
Example: 5
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT
code string

Country code for two letters
Example: US
custom_tax_infoobject[]

Custom tax information
countryobject

Country
code string

National code
Example: US
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: 123123
id string

id
Example: 12231
tax string

Tax value
Example: 0.05
tax_name string

Tax name
Example: VAT
name string

Custom tax name
Example: Product classification 1
product_category_id string

Product classification id
Example: 1213213231
type string

Tax type
Example: product_category
id string

Store dimension id
Example: 100033
name string

National english full name
Example: USA

API Explorer

Debugger

Base URL

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

ParamOptions

id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/countries/id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal