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
Node.JS
PHP
Example responses
pricebook successful
User is unauthorized to make the request
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
Node.JS
PHP
Example responses
pricebook list
User is unauthorized to make the request
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
Node.JS
PHP
Example responses
pricebook successful
User is unauthorized to make the request
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
Node.JS
PHP
Example responses
pricebook successful
User is unauthorized to make the request
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
Node.JS
PHP
Example responses