HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Funciton

Get Taxes
獲取稅金設定列表

URL

GET https://open.shopline.io/v1/taxes

Request parameters

ParameterTypeDescriptionExample
show_all_regionsBooleanDo get all regions?
是否顯示各地區稅金
true

Response fields

FieldTypeDescritptionExample
idStringTax ID
稅金設定 ID
5f8e5dc08a8bb70a5c9cd93c
nameStringTax Setting Name
稅金設定名稱
稅金名稱
merchant_idStringMerchant ID
商户ID
5e8c5b7a2c389a006ad21050
countryStringCountry of Tax
稅收國家/地區
US
is_default_ratesBooleanUsing Default Tax Rates
自動計算稅率
false
enable_inclusiveBooleanAll Products' Price Include Tax
所有商品皆已含稅
false
allow_inclusive_taxBooleanAllow Inclusive Tax
國家商品允許含稅
true
service_charge_taxableBooleanService Charge Taxable
服務稅應稅
true
emoji_flagStringEmoji Flag
國家 emoji
🇺🇸
salesHashTax of Sales
基本消費稅
{
"general": {
"id": "612f964fc3645f0044c284c5",
"region": null,
"rate": 0.03,
"type": "sales",
"default_rate": 0.0736,
"default_rate_range": [
0.0736,
0.0736
]
},
"details": [
{
"id": "61f3734eaebdcb0041843274",
"region": "AK",
"rate": 0.05,
"type": "sales",
"default_rate": 0,
"default_rate_range": [
0,
0.0785
]
}
]
}
deliveryHashTax of Delivery
運費税
{
"general": {
"id": "612f964fc3645f0044c284c6",
"region": null,
"rate": null,
"type": "delivery",
"default_rate": 0.0,
"default_rate_range": [
0.0,
0.0
]
},
"details": []
}
service_chargeHashTax of Service Charge
服務稅
{
"general": {
"id": "612f964fc3645f0044c284c6",
"region": null,
"rate": null,
"type": "delivery",
"default_rate": 0.0,
"default_rate_range": [
0.0,
0.0
]
},
"details": []
}

Response Example

{
  "items": [
    {
      "id": "612c8f2638be9e0045dd61de",
      "name": "Taipei",
      "merchant_id": "611cd8ade0f510001e130048",
      "country": "TW",
      "is_default_rates": false,
      "enable_inclusive": false,
      "allow_inclusive_tax": true,
      "service_charge_taxable": false,
      "emoji_flag": "🇹🇼",
      "sales": {
        "general": {
          "id": "612c8f2638be9e0045dd61df",
          "region": null,
          "rate": 0.01,
          "type": "sales",
          "default_rate": 0.05,
          "default_rate_range": [
            0.05,
            0.05
          ]
        },
        "details": []
      },
      "delivery": {
        "general": {
          "id": "612c8f2638be9e0045dd61e0",
          "region": null,
          "rate": 0.05,
          "type": "delivery",
          "default_rate": 0,
          "default_rate_range": [
            0,
            0
          ]
        },
        "details": []
      },
      "service_charge": {
        "general": {
          "id": "612c8f2638be9e0045dd61e1",
          "region": null,
          "rate": null,
          "type": "service_charge",
          "default_rate": 0,
          "default_rate_range": [
            0,
            0
          ]
        },
        "details": []
      },
      "created_at": "2021-08-30T07:56:22.371+00:00",
      "updated_at": "2022-02-21T03:50:41.850+00:00"
    },
    {
      "id": "612f964fc3645f0044c284c4",
      "name": "cde",
      "merchant_id": "611cd8ade0f510001e130048",
      "country": "US",
      "is_default_rates": false,
      "enable_inclusive": true,
      "allow_inclusive_tax": true,
      "service_charge_taxable": false,
      "emoji_flag": "🇺🇸",
      "sales": {
        "general": {
          "id": "612f964fc3645f0044c284c5",
          "region": null,
          "rate": 0.03,
          "type": "sales",
          "default_rate": 0.0736,
          "default_rate_range": [
            0.0736,
            0.0736
          ]
        },
        "details": [
          {
            "id": "61f3734eaebdcb0041843274",
            "region": "AK",
            "rate": 0.05,
            "type": "sales",
            "default_rate": 0,
            "default_rate_range": [
              0,
              0.0785
            ]
          }
        ]
      },
      "delivery": {
        "general": {
          "id": "612f964fc3645f0044c284c6",
          "region": null,
          "rate": null,
          "type": "delivery",
          "default_rate": 0,
          "default_rate_range": [
            0,
            0
          ]
        },
        "details": []
      },
      "service_charge": {
        "general": {
          "id": "612f964fc3645f0044c284c7",
          "region": null,
          "rate": null,
          "type": "service_charge",
          "default_rate": 0,
          "default_rate_range": [
            0,
            0
          ]
        },
        "details": []
      },
      "created_at": "2021-09-01T15:03:43.542+00:00",
      "updated_at": "2022-02-10T03:13:51.994+00:00"
    }
  ]
}