create configuration record

1 min

POST

https://api.upstartcommerce.com/v1/tax/cfg/records

This endpoint allows a tenant to create a new configuration record.

Authorized permissions:

CfgModuleHttpApiAuthorizers.recordModifyAuthorizer

Header Parameters

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

Body Parameters

bodyobject
Description
The tax configuration record to create.
- recordIdstring
  Description
  The record identifier for this configuration record.
  Min Length
  1
- templateIdstringrequired
  Description
  Template identifier for this configuration's template.
  Min Length
  1
- siteIdsstring[]
  Description
  Unique site identifiers associated with the tenant who wants to create this configuration.
- tagsstring[]
- namestring
  Description
  Name of the tax calculation system for this configuration record.
  Min Length
  1
- dataobjectrequired
  - taxProviderstringrequired
    Description
    Name of the provider that provides the tax calculation service for this configuration record.
    Min Length
    1
  - taxCalculationEnabledbooleanrequired
    Description
    This flag determines whether the tax will be calculated for this configuration record or not. If the flag is set to true, the tax will be calculated for this configuration record.
  - addressValidationEnabledbooleanrequired
    Description
    This flag determines whether the address for this configuration will be validated or not. If the flag is set to true, the address will be validated.
  - documentRecordingEnabledbooleanrequired
    Description
    This flag determines whether the transactions made by this configuration will be reported to the authorities or not. If the flag is set to true, the transactions will be recorded permanently.
  - transactionLoggingEnabledbooleanrequired
    Description
    This flag determines whether the transactions made by this configuration will be logged or not. If the flag is set to true, the transactions will be logged.
  - usernamestringrequired
    Description
    Username of the user this configuration record is associated with.
    Min Length
    1
  - companyCodestringrequired
    Description
    Unique company code for this configuration's company.
    Min Length
    1
  - environmentstringrequired
    Description
    Environment type for this configuration.
    Min Length
    1
  - timeoutSecondsnumberrequired
    Description
    This field specifies the time limit after which the API throws an error.
  - passwordstringrequired
    Description
    Unique password associated with the username.
    Min Length
    1
  - taxAddressobjectrequired
    Description
    Address for this configuration's company.
    - citystringrequired
      Description
      City name.
      Min Length
      1
    - street1stringrequired
      Description
      Street name/number.
      Min Length
      1
    - countrystringrequired
      Description
      Country where the company resides.
      Min Length
      1
    - postalCodestringrequired
      Description
      Postal code.
      Min Length
      1
    - stateOrRegionstringrequired
      Description
      Two character code for State or Region.
      Min Length
      1
- enabledbooleanrequired

Responses

200

Success-the configuration record is created.

string
Description
Template identifier of the created configuration record.

400

Bad Request-the request body is either missing the required fields or the validations have failed for the request body.

object
- namestringrequired
  Description
  Error name.
  Min Length
  1
- codestringrequired
  Description
  Error code.
  Min Length
  1
- detailobject[]required
  Description
  Error details.
  - pathstringrequired
    Description
    Field from the request body which is causing the error.
    Min Length
    1
  - errorsobject[]required
    Description
    Error details.
    - idstringrequired
      Description
      Error type.
      Min Length
      1
    - messagestringrequired
      Description
      Error message.
      Min Length
      1

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/cfg/records \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "templateId": "",
     "data": {
     "taxProvider": "",
     "taxCalculationEnabled": "",
     "addressValidationEnabled": "",
     "documentRecordingEnabled": "",
     "transactionLoggingEnabled": "",
     "username": "",
     "companyCode": "",
     "environment": "",
     "timeoutSeconds": "",
     "password": "",
     "taxAddress": {
     "city": "",
     "street1": "",
     "country": "",
     "postalCode": "",
     "stateOrRegion": ""
     }
     },
     "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({
   "templateId": "",
   "data": {
      "taxProvider": "",
      "taxCalculationEnabled": "",
      "addressValidationEnabled": "",
      "documentRecordingEnabled": "",
      "transactionLoggingEnabled": "",
      "username": "",
      "companyCode": "",
      "environment": "",
      "timeoutSeconds": "",
      "password": "",
      "taxAddress": {
         "city": "",
         "street1": "",
         "country": "",
         "postalCode": "",
         "stateOrRegion": ""
      }
   },
   "enabled": ""
});

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

fetch("https://api.upstartcommerce.com/v1/tax/cfg/records", 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/cfg/records")

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({
   "templateId": "",
   "data": {
      "taxProvider": "",
      "taxCalculationEnabled": "",
      "addressValidationEnabled": "",
      "documentRecordingEnabled": "",
      "transactionLoggingEnabled": "",
      "username": "",
      "companyCode": "",
      "environment": "",
      "timeoutSeconds": "",
      "password": "",
      "taxAddress": {
         "city": "",
         "street1": "",
         "country": "",
         "postalCode": "",
         "stateOrRegion": ""
      }
   },
   "enabled": ""
})

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

python

import requests
import json

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

payload = json.dumps({
   "templateId": "",
   "data": {
      "taxProvider": "",
      "taxCalculationEnabled": "",
      "addressValidationEnabled": "",
      "documentRecordingEnabled": "",
      "transactionLoggingEnabled": "",
      "username": "",
      "companyCode": "",
      "environment": "",
      "timeoutSeconds": "",
      "password": "",
      "taxAddress": {
         "city": "",
         "street1": "",
         "country": "",
         "postalCode": "",
         "stateOrRegion": ""
      }
   },
   "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)

200

// Success-the configuration record is created.
""

400

// Bad Request-the request body is either missing the required fields or the validations have failed for the request body.
{
  "name": "",
  "code": "",
  "detail": [
    {
      "path": "",
      "errors": [
        {
          "id": "",
          "message": ""
        }
      ]
    }
  ]
}

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.