Pricebooks API

Create a pricebook on threekit platform

Create a pricebook on the threekit platform

REST Endpoint

POST https://preview.threekit.com/api/orgs/{orgId}/pricebooks

Query Parameters

Name	In	Type	Required	Description
orgId	path	string	true	ID of the organization which the pricebook belong to
body	body	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	pricebook successful	None
401	Unauthorized	User is unauthorized to make the request	None

Examples

Code

CURL

curl --request POST \
  --url https://preview.threekit.com/api/orgs/string/pricebooks \
  --header 'authorization: Bearer {access-token}' \
  --header 'content-type: name' \
  --data '"North AMERA"'

Node.JS

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "preview.threekit.com",
  "port": null,
  "path": "/api/orgs/string/pricebooks",
  "headers": {
    "content-type": "name",
    "authorization": "Bearer {access-token}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("\"North AMERA\"");
req.end();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://preview.threekit.com/api/orgs/string/pricebooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "\"North AMERA\"",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access-token}",
    "content-type: name"
  ),
));

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

curl_close($curl);

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

Example responses

pricebook successful

{
  "id": "dc987a52-d505-4ea3-ac9f-66a495a07a89",
  "orgId": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "name": "Bala",
  "createdBy": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "currencies": [
    "CNY"
  ],
  "createdAt": "2021-01-26T15:43:15.640Z",
  "deletedAt": null
}

User is unauthorized to make the request

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

list pricebooks for an organization

return a list of pricebooks for an organization

REST Endpoint

GET https://preview.threekit.com/api/orgs/{orgId}/pricebooks

Query Parameters

Name	In	Type	Required	Description
orgId	path	string	true	ID of the organization which the pricebook belong to

Responses

Status	Meaning	Description	Schema
200	OK	pricebook list	None
401	Unauthorized	User is unauthorized to make the request	None

Examples

Code

CURL

curl --request GET \
  --url https://preview.threekit.com/api/orgs/string/pricebooks \
  --header 'authorization: Bearer {access-token}'

Node.JS

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "preview.threekit.com",
  "port": null,
  "path": "/api/orgs/string/pricebooks",
  "headers": {
    "authorization": "Bearer {access-token}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://preview.threekit.com/api/orgs/string/pricebooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access-token}"
  ),
));

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

curl_close($curl);

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

Example responses

pricebook list

{
  "pricebooks": [
    {
      "id": "dc987a52-d505-4ea3-ac9f-66a495a07a89",
      "orgId": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
      "name": "China Currency",
      "createdBy": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
      "currencies": [
        "CNY"
      ],
      "createdAt": "2021-01-26T15:43:15.640Z",
      "deletedAt": null
    },
    {
      "id": "3e90c6f2-b50a-4f3e-b583-92d5bc00fa70",
      "orgId": "17fdf3a6-eef7-4508-8d76-e3ecf430488c",
      "name": "North America",
      "createdBy": "19f5a133-b3c5-4043-a44d-04a5881f18cd",
      "currencies": [
        "USD",
        "CAD"
      ],
      "createdAt": "2021-01-27T18:06:03.980Z",
      "deletedAt": null
    }
  ]
}

User is unauthorized to make the request

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

Get a specific pricebook

Get a pricebook based on its id.

REST Endpoint

GET https://preview.threekit.com/api/orgs/{orgId}/pricebooks/{pricebookId}

Query Parameters

Name	In	Type	Required	Description
orgId	path	string	true	ID of the organization which the pricebook belong to
pricebookId	path	string	true	ID of the pricebook

Responses

Status	Meaning	Description	Schema
200	OK	pricebook successful	None
401	Unauthorized	User is unauthorized to make the request	None

Examples

Code

CURL

curl --request GET \
  --url https://preview.threekit.com/api/orgs/string/pricebooks/string \
  --header 'authorization: Bearer {access-token}'

Node.JS

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "preview.threekit.com",
  "port": null,
  "path": "/api/orgs/string/pricebooks/string",
  "headers": {
    "authorization": "Bearer {access-token}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://preview.threekit.com/api/orgs/string/pricebooks/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access-token}"
  ),
));

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

curl_close($curl);

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

Example responses

pricebook successful

{
  "id": "dc987a52-d505-4ea3-ac9f-66a495a07a89",
  "orgId": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "name": "Bala",
  "createdBy": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "currencies": [
    "CNY"
  ],
  "createdAt": "2021-01-26T15:43:15.640Z",
  "deletedAt": null
}

User is unauthorized to make the request

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

Update a pricebook

Update a pricebook.

REST Endpoint

PUT https://preview.threekit.com/api/orgs/{orgId}/pricebooks/{pricebookId}

Query Parameters

Name	In	Type	Required	Description
orgId	path	string	true	ID of the organization which the pricebook belong to
pricebookId	path	string	true	ID of the pricebook
body	body	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	pricebook successful	None
401	Unauthorized	User is unauthorized to make the request	None

Examples

Code

CURL

curl --request PUT \
  --url https://preview.threekit.com/api/orgs/string/pricebooks/string \
  --header 'authorization: Bearer {access-token}' \
  --header 'content-type: name' \
  --data '"My Pricebook"'

Node.JS

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "preview.threekit.com",
  "port": null,
  "path": "/api/orgs/string/pricebooks/string",
  "headers": {
    "content-type": "name",
    "authorization": "Bearer {access-token}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("\"My Pricebook\"");
req.end();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://preview.threekit.com/api/orgs/string/pricebooks/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "\"My Pricebook\"",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access-token}",
    "content-type: name"
  ),
));

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

curl_close($curl);

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

Example responses

pricebook successful

{
  "id": "dc987a52-d505-4ea3-ac9f-66a495a07a89",
  "orgId": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "name": "Bala",
  "createdBy": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "currencies": [
    "CNY"
  ],
  "createdAt": "2021-01-26T15:43:15.640Z",
  "deletedAt": null
}

User is unauthorized to make the request

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

Delete a pricebook

Delete a pricebook with its id.

REST Endpoint

DELETE https://preview.threekit.com/api/orgs/{orgId}/pricebooks/{pricebookId}

Query Parameters

Name	In	Type	Required	Description
orgId	path	string	true	ID of the organization which the pricebook belong to
pricebookId	path	string	true	ID of the pricebook

Responses

Status	Meaning	Description	Schema
200	OK	pricebook successful	None
401	Unauthorized	User is unauthorized to make the request	None

Examples

Code

CURL

curl --request DELETE \
  --url https://preview.threekit.com/api/orgs/string/pricebooks/string \
  --header 'authorization: Bearer {access-token}'

Node.JS

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "preview.threekit.com",
  "port": null,
  "path": "/api/orgs/string/pricebooks/string",
  "headers": {
    "authorization": "Bearer {access-token}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://preview.threekit.com/api/orgs/string/pricebooks/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access-token}"
  ),
));

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

curl_close($curl);

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

Example responses

pricebook successful

{
  "id": "dc987a52-d505-4ea3-ac9f-66a495a07a89",
  "orgId": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "name": "Bala",
  "createdBy": "aa785547-3b05-4bb4-be7f-3a148a752d3b",
  "currencies": [
    "CNY"
  ],
  "createdAt": "2021-01-26T15:43:15.640Z",
  "deletedAt": null
}

User is unauthorized to make the request

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

Menu

Articles in this section

In this article

Create a pricebook on threekit platform

REST Endpoint

Query Parameters

Responses

Examples

Code

CURL

Node.JS

PHP

Example responses

pricebook successful

User is unauthorized to make the request

list pricebooks for an organization

REST Endpoint

Query Parameters

Responses

Examples

Code

CURL

Node.JS

PHP

Example responses

pricebook list

User is unauthorized to make the request

Get a specific pricebook

REST Endpoint

Query Parameters

Responses

Examples

Code

CURL

Node.JS

PHP

Example responses

pricebook successful

User is unauthorized to make the request

Update a pricebook

REST Endpoint

Query Parameters

Responses

Examples

Code

CURL

Node.JS

PHP

Example responses

pricebook successful

User is unauthorized to make the request

Delete a pricebook

REST Endpoint

Query Parameters

Responses

Examples

Code

CURL

Node.JS

PHP

Example responses

pricebook successful

User is unauthorized to make the request

Related articles