Products

Create Product

Products define the specific goods or services the partner is offering to its customers. Products can be physical goods, digital goods, SaaS subscriptions, etc. The products also have compliance data embedded within them, which allows proper tax calculations per item based.

Products are not mandatory for any kind of partner, but using products to create a catalogue and then using those product objects to create sessions and subscriptions allows efficient operations.

This API is used to create a product for both physical goods, digital goods and subscription based services.

A Product object accommodates all the compliance data for calculating indirect taxes as well for physical products.

POST

product

v1.0

createProduct

Create Product

curl --request POST \
  --url https://sandbox-api.transactbridge.com/product/v1.0/createProduct \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "referenceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "price": 123,
  "currCode": "<string>",
  "isStaticQuotePrice": true,
  "taxIncPrice": true,
  "availableStock": 123,
  "active": true,
  "shippable": true,
  "hsnCode": "<string>",
  "userTaxId": "<string>",
  "isKycEnabled": true,
  "thumbnail": "<string>",
  "images": [
    "<string>"
  ],
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  },
  "shippableData": {
    "partNumber": "<string>",
    "eccn": "<string>",
    "hsCode": "<string>",
    "weight": "<string>",
    "length": "<string>",
    "width": "<string>",
    "height": "<string>"
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/product/v1.0/createProduct"

payload = {
    "referenceId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "price": 123,
    "currCode": "<string>",
    "isStaticQuotePrice": True,
    "taxIncPrice": True,
    "availableStock": 123,
    "active": True,
    "shippable": True,
    "hsnCode": "<string>",
    "userTaxId": "<string>",
    "isKycEnabled": True,
    "thumbnail": "<string>",
    "images": ["<string>"],
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    },
    "shippableData": {
        "partNumber": "<string>",
        "eccn": "<string>",
        "hsCode": "<string>",
        "weight": "<string>",
        "length": "<string>",
        "width": "<string>",
        "height": "<string>"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    referenceId: '<string>',
    name: '<string>',
    description: '<string>',
    price: 123,
    currCode: '<string>',
    isStaticQuotePrice: true,
    taxIncPrice: true,
    availableStock: 123,
    active: true,
    shippable: true,
    hsnCode: '<string>',
    userTaxId: '<string>',
    isKycEnabled: true,
    thumbnail: '<string>',
    images: ['<string>'],
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'},
    shippableData: {
      partNumber: '<string>',
      eccn: '<string>',
      hsCode: '<string>',
      weight: '<string>',
      length: '<string>',
      width: '<string>',
      height: '<string>'
    }
  })
};

fetch('https://sandbox-api.transactbridge.com/product/v1.0/createProduct', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.transactbridge.com/product/v1.0/createProduct",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'referenceId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'price' => 123,
    'currCode' => '<string>',
    'isStaticQuotePrice' => true,
    'taxIncPrice' => true,
    'availableStock' => 123,
    'active' => true,
    'shippable' => true,
    'hsnCode' => '<string>',
    'userTaxId' => '<string>',
    'isKycEnabled' => true,
    'thumbnail' => '<string>',
    'images' => [
        '<string>'
    ],
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ],
    'shippableData' => [
        'partNumber' => '<string>',
        'eccn' => '<string>',
        'hsCode' => '<string>',
        'weight' => '<string>',
        'length' => '<string>',
        'width' => '<string>',
        'height' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.transactbridge.com/product/v1.0/createProduct"

	payload := strings.NewReader("{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.transactbridge.com/product/v1.0/createProduct")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/product/v1.0/createProduct")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {}
}

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

referenceId

string

required

Your unique ID for the product. Send it as items[].productReferenceId when you create a billing session or subscription. Max 128 characters.

Maximum string length: 128

name

string

required

Product name. Used as the item name if the billing session or subscription item doesn't send one.

description

string

Product description. Used as the item description if the item doesn't send one.

price

number

Product price. In a billing session it replaces the item amount when isStaticQuotePrice is true.

currCode

string

Currency of price. Defaults to your settlement currency.

isStaticQuotePrice

boolean

If true, a billing session uses the product price instead of the amount in the request. Can only be set when you create the product.

isStaticQuotePrice can't be changed through Update Product, so set them when you create the product.

taxIncPrice

boolean

If true, price already includes tax. Needed for tax-inclusive billing sessions that use a fixed product price. Can only be set when you create the product.

taxIncPrice can't be changed through Update Product, so set them when you create the product.

availableStock

number

Units in stock. A billing session is rejected if the quantity is more than the stock (only when isStaticQuotePrice is false).

active

boolean

true makes the product usable. Inactive products are rejected in billing sessions and subscriptions.

shippable

boolean

true for physical goods. One billing session can't have both shippable and non-shippable products.

hsnCode

string

HSN code of the product. Sets the tax category for the product.Required if shippable is true

userTaxId

string

ID of the tax category used to calculate tax on this product.

isKycEnabled

boolean

If true, the customer must complete KYC before paying for this product.

thumbnail

string<uri>

Image URL. Used as the item image if the item doesn't send one.

images

string[]

List of image URLs. Used if there is no thumbnail and the item doesn't send an image.

Response

200 - application/json

Contains the product object created.

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the product object created.

Create Product

curl --request POST \
  --url https://sandbox-api.transactbridge.com/product/v1.0/createProduct \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "referenceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "price": 123,
  "currCode": "<string>",
  "isStaticQuotePrice": true,
  "taxIncPrice": true,
  "availableStock": 123,
  "active": true,
  "shippable": true,
  "hsnCode": "<string>",
  "userTaxId": "<string>",
  "isKycEnabled": true,
  "thumbnail": "<string>",
  "images": [
    "<string>"
  ],
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  },
  "shippableData": {
    "partNumber": "<string>",
    "eccn": "<string>",
    "hsCode": "<string>",
    "weight": "<string>",
    "length": "<string>",
    "width": "<string>",
    "height": "<string>"
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/product/v1.0/createProduct"

payload = {
    "referenceId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "price": 123,
    "currCode": "<string>",
    "isStaticQuotePrice": True,
    "taxIncPrice": True,
    "availableStock": 123,
    "active": True,
    "shippable": True,
    "hsnCode": "<string>",
    "userTaxId": "<string>",
    "isKycEnabled": True,
    "thumbnail": "<string>",
    "images": ["<string>"],
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    },
    "shippableData": {
        "partNumber": "<string>",
        "eccn": "<string>",
        "hsCode": "<string>",
        "weight": "<string>",
        "length": "<string>",
        "width": "<string>",
        "height": "<string>"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    referenceId: '<string>',
    name: '<string>',
    description: '<string>',
    price: 123,
    currCode: '<string>',
    isStaticQuotePrice: true,
    taxIncPrice: true,
    availableStock: 123,
    active: true,
    shippable: true,
    hsnCode: '<string>',
    userTaxId: '<string>',
    isKycEnabled: true,
    thumbnail: '<string>',
    images: ['<string>'],
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'},
    shippableData: {
      partNumber: '<string>',
      eccn: '<string>',
      hsCode: '<string>',
      weight: '<string>',
      length: '<string>',
      width: '<string>',
      height: '<string>'
    }
  })
};

fetch('https://sandbox-api.transactbridge.com/product/v1.0/createProduct', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.transactbridge.com/product/v1.0/createProduct",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'referenceId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'price' => 123,
    'currCode' => '<string>',
    'isStaticQuotePrice' => true,
    'taxIncPrice' => true,
    'availableStock' => 123,
    'active' => true,
    'shippable' => true,
    'hsnCode' => '<string>',
    'userTaxId' => '<string>',
    'isKycEnabled' => true,
    'thumbnail' => '<string>',
    'images' => [
        '<string>'
    ],
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ],
    'shippableData' => [
        'partNumber' => '<string>',
        'eccn' => '<string>',
        'hsCode' => '<string>',
        'weight' => '<string>',
        'length' => '<string>',
        'width' => '<string>',
        'height' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.transactbridge.com/product/v1.0/createProduct"

	payload := strings.NewReader("{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.transactbridge.com/product/v1.0/createProduct")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/product/v1.0/createProduct")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": 123,\n  \"currCode\": \"<string>\",\n  \"isStaticQuotePrice\": true,\n  \"taxIncPrice\": true,\n  \"availableStock\": 123,\n  \"active\": true,\n  \"shippable\": true,\n  \"hsnCode\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"isKycEnabled\": true,\n  \"thumbnail\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"shippableData\": {\n    \"partNumber\": \"<string>\",\n    \"eccn\": \"<string>\",\n    \"hsCode\": \"<string>\",\n    \"weight\": \"<string>\",\n    \"length\": \"<string>\",\n    \"width\": \"<string>\",\n    \"height\": \"<string>\"\n  }\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {}
}

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Create Product

Authorizations

Body

Response