Get Order Setting

GET /v1/settings/orders

To Retrieve global setting of the merchant's order, the merchant is defined by the token in the header

Invoice setting
Currently customer can choose between two invoice provider, choosing which provider einvoice and tradevan, to enable using tradevan to provide invoice service, merchant need to have rollout key einvoice_tradvan enabled

Request Example

curl --request GET \
     --url <<api_domain>>/v1/settings/orders \
     --header 'Accept: application/json'

Response Parameters

Field

Type

Description

Example

invoice_activation

String

active

current_invoice_service_provider

String

tradevan

invoice

Object

{
    "tax_id": "24973192",
    "oversea_tax_type": "2",
    "tax_type": "1",
    "n_p_o_b_a_n": {
        "name": "社團法人中華民國晴天社會福利協會",
        "code": "9595995",
        "short_name": "晴天協會",
        "tax_id": "26661737",
        "county": "桃園市"
    },
    "source": {
        "business_group_code": "SL24973192",
        "business_type_code": "SLFTP"
    }
}

invoice_tradevan

Object

{
    "tax_id": "24973192",
    "oversea_tax_type": "2",
    "tax_type": "1",
    "n_p_o_b_a_n": {
        "name": "社團法人中華民國晴天社會福利協會",
        "code": "9595995",
        "short_name": "晴天協會",
        "tax_id": "26661737",
        "county": "桃園市"
    },
    "source": {
        "business_group_code": "SL24973192",
        "business_type_code": "SLFTP"
    }
}

no_duplicate_uniform_invoice

Boolean

false

enabled_location_id

Boolean

啟用「儲位編號設定」功能

true

customer_cancel_order

Object

{
   "enabled": true,        
   "auto_revert_credit": false
}

customer_return_order

Object

{
   "enabled": true,     "available_return_days": "7"
}

default_out_of_stock_reminder

Boolean

Enable "Out-Of-Stock Reminder".
啟用「商品預設缺貨提醒」功能
(To be released)

false

Response Example

{
  "invoice_activation": 'active',
  "current_invoice_service_provider":"tradevan",
  "invoice":{
    "tax_id":"24973192",
    "oversea_tax_type":"2",
    "tax_type":"1",
    "n_p_o_b_a_n":{
      "name":"社團法人中華民國晴天社會福利協會",
      "code":"9595995",
      "short_name":"晴天協會",
      "tax_id":"26661737",
      "county":"桃園市"
    },
    "source":{
      "business_group_code":"SL24973192",
      "business_type_code":"SLFTP"
    }
  },
  "invoice_tradevan":{
    "tax_id":"24973192",
    "oversea_tax_type":"2",
    "tax_type":"1",
    "n_p_o_b_a_n":{
      "name":"社團法人中華民國晴天社會福利協會",
      "code":"9595995",
      "short_name":"晴天協會",
      "tax_id":"26661737",
      "county":"桃園市"
    },
    "source":{
      "business_group_code":"SL24973192",
      "business_type_code":"SLFTP"
    },
    "no_duplicate_uniform_invoice": false,
  },
  "customer_cancel_order": {
    "enabled": true,
    "auto_revert_credit": false
  },
  "customer_return_order": {
    "enabled": true,
    "available_return_days": "7"
  }
}
invoice_activation string active, inactive, null default null
current_invoice_service_provider string enum `tradevan` OR `cetustek`
invoice object
invoice.tax_id string Provided by the Government
invoice.tax_type string Use in TW, Available values:
1: Tax
2: No Tax - export not via custom
3: No Tax
5: No Tax - export via custom
invoice.source string Provided by einvoice provider
invoice_tradevan object
invoice.tax_id string Provided by the Government
invoice_tradevan.tax_type string Use in TW, Available values:
1: Tax
2: No Tax - export not via custom
3: No Tax
5: No Tax - export via custom
invoice.source string Provided by einvoice provider