create tax provider

1 min

POST

https://api.upstartcommerce.com/v1/tax/provider

This endpoint allows the creation of a tax provider against a certain tenant.

Authorized permissions:

Authorizers.taxModify

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Body Parameters

bodyobject
Description
The tax provider to create.
- tenantstringrequired
  Description
  Tenant identifier this tax provider is for.
  Min Length
  1
- taxProviderIdstringrequired
  Description
  Tax provider identifier.
  Min Length
  1
- taxProviderNamestringrequired
  Description
  Tax provider name.
  Min Length
  1
- enabledbooleanrequired
  Description
  This flag determines whether the tax provider services can be used by this tenant or not. If it is true, the tax provider's services can be used.

Responses

201

Success-the tax provider is created.

object
- tenantstringrequired
  Description
  Tenant identifier this tax provider is for.
  Min Length
  1
- taxProviderIdstringrequired
  Description
  Tax provider identifier.
  Min Length
  1
- taxProviderNamestringrequired
  Description
  Tax provider name.
  Min Length
  1
- enabledbooleanrequired
  Description
  This flag determines whether the tax provider services can be used by this tenant or not. If it is true, the tax provider's services can be used.

401

Unauthorized-the provided credentials were invalid for this endpoint.

GeneralError
Description
Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.
- namestringrequired
  Description
  Error name.
  Min Length
  1
- codestringrequired
  Description
  Error code.
  Min Length
  1
- reasonstring
  Description
  Reason why this error occurred.
  Min Length
  1
- detailstringrequired
  Description
  Error details.
  Min Length
  1

404

Not Found-the requested resource was not found in the NoChannel system.

415

Unsupported Media Type-content type isn't set to application/json.

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/tax/provider \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "tenant": "",
     "taxProviderId": "",
     "taxProviderName": "",
     "enabled": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "tenant": "",
   "taxProviderId": "",
   "taxProviderName": "",
   "enabled": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tax/provider", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tax/provider")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "tenant": "",
   "taxProviderId": "",
   "taxProviderName": "",
   "enabled": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tax/provider"

payload = json.dumps({
   "tenant": "",
   "taxProviderId": "",
   "taxProviderName": "",
   "enabled": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Success-the tax provider is created.
{
  "tenant": "",
  "taxProviderId": "",
  "taxProviderName": "",
  "enabled": false
}

401

// Unauthorized-the provided credentials were invalid for this endpoint.
{
  "name": "",
  "code": "",
  "reason": "",
  "detail": ""
}

404

// Not Found-the requested resource was not found in the NoChannel system.

415

// Unsupported Media Type-content type isn't set to application/json.