Skip to main content
POST
/
merchant
/
vat
/
setup_global_us_vat_config
US Vat Config Setup
curl --request POST \
  --url https://api.unibee.dev/merchant/vat/setup_global_us_vat_config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "global_us_vat_config": {
    "active": true,
    "availableGatewayNames": [
      "<string>"
    ],
    "checkAddressViaGateway": true,
    "defaultGatewayName": "<string>",
    "fromAddress": {
      "address": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "state": "<string>",
      "verified": true,
      "zipCode": "<string>"
    },
    "nexusAddresses": [
      {
        "address": "<string>",
        "city": "<string>",
        "countryCode": "<string>",
        "state": "<string>",
        "verified": true,
        "zipCode": "<string>"
      }
    ],
    "taxCode": "<string>",
    "toAddress": {
      "address": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "state": "<string>",
      "verified": true,
      "zipCode": "<string>"
    },
    "uploadInvoiceToGateway": true
  }
}
'
{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

​
Endpoint Overview

POST https://api.unibee.dev/merchant/vat/setup_global_us_vat_config US Vat Config Setup

​
Authorization

All UniBee Merchant API requests require authentication via API key.
HeaderRequiredDescription
AuthorizationYesBearer <your_api_key>
Content-TypeYesapplication/json (for request body)

​
Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

​
Request body

NameTypeRequiredDescription
global_us_vat_configstringNo

​
Request examples

​
cURL

curl -X POST "https://api.unibee.dev/merchant/vat/setup_global_us_vat_config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "global_us_vat_config": ""
}'

​
Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/vat/setup_global_us_vat_config" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "global_us_vat_config": ""
}'

​
Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success. The response schema for this endpoint is shown below.

​
Error handling

HTTP statusMeaning
400Bad request — invalid or missing parameters. Check message in the body.
401Unauthorized — missing or invalid API key.
404Not found — invalid path or resource.
500Server error — retry with backoff.
When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
global_us_vat_config
object

Response

200 - application/json
​
code
integer<int>
​
data
object
​
merchantId
integer<int64>
​
message
string<string>
​
redirect
string<string>
​
requestId
string<string>