Product

Contains all the list of products and maintained by the admin.

classification
string <= 255 characters

The Type of Product. Options Include: Own, Competitor, Complimentary.

code
string <= 255 characters

Unique code of a product.

createdAt
string <date-time>

The date and time the task was created.

custom1
string

The value of the product's first custom field.

custom2
string

The value of the product's second custom field.

custom3
string

The value of the product's third custom field.

custom4
string

The value of the product's fourth custom field.

custom5
string

The value of the product's fifth custom field.

custom6
string

The value of the product's sixth custom field.

custom7
string

The value of the product's seventh custom field.

custom8
string

The value of the product's eight custom field.

custom9
string

The value of the product's ninth custom field.

custom10
string

The value of the product's 10th custom field.

custom11
string

The value of the product's 11th custom field.

custom12
string

The value of the product's 12th custom field.

custom13
string

The value of the product's 13th custom field.

custom14
string

The value of the product's 14th custom field.

custom15
string

The value of the product's 15th custom field.

custom16
string

The value of the product's 16th custom field.

custom17
string

The value of the product's 17th custom field.

custom18
string

The value of the product's 18th custom field.

custom19
string

The value of the product's 19th custom field.

custom20
string

The value of the product's 20th custom field.

custom21
string

The value of the product's 21st custom field.

custom22
string

The value of the product's 22nd custom field.

custom23
string

The value of the product's 23rd custom field.

custom24
string

The value of the product's 24th custom field.

custom25
string

The value of the product's 25th custom field.

custom26
string

The value of the product's 26th custom field.

custom27
string

The value of the product's 27th custom field.

custom28
string

The value of the product's 28th custom field.

custom29
string

The value of the product's 29th custom field.

custom30
string

The value of the product's 30th custom field.

custom31
string

The value of the product's 31st custom field.

custom32
string

The value of the product's 32nd custom field.

custom33
string

The value of the product's 33rd custom field.

custom34
string

The value of the product's 34th custom field.

custom35
string

The value of the product's 35th custom field.

custom36
string

The value of the product's 36th custom field.

custom37
string

The value of the product's 37th custom field.

custom38
string

The value of the product's 38th custom field.

custom39
string

The value of the product's 39th custom field.

custom40
string

The value of the product's 40th custom field.

custom41
string

The value of the product's 41st custom field.

custom42
string

The value of the product's 42nd custom field.

custom43
string

The value of the product's 43rd custom field.

custom44
string

The value of the product's 44th custom field.

custom45
string

The value of the product's 45th custom field.

custom46
string

The value of the product's 46th custom field.

custom47
string

The value of the product's 47th custom field.

custom48
string

The value of the product's 48th custom field.

custom49
string

The value of the product's 49th custom field.

custom50
string

The value of the product's 50th custom field.

custom51
string

The value of the product's 51st custom field.

custom52
string

The value of the product's 52nd custom field.

custom53
string

The value of the product's 53rd custom field.

custom54
string

The value of the product's 54th custom field.

custom55
string

The value of the product's 55th custom field.

custom56
string

The value of the product's 56th custom field.

custom57
string

The value of the product's 57th custom field.

custom58
string

The value of the product's 58th custom field.

custom59
string

The value of the product's 59th custom field.

custom60
string

The value of the product's 60th custom field.

custom61
string

The value of the product's 61st custom field.

custom62
string

The value of the product's 62nd custom field.

custom63
string

The value of the product's 63rd custom field.

custom64
string

The value of the product's 64th custom field.

custom65
string

The value of the product's 65th custom field.

custom66
string

The value of the product's 66th custom field.

custom67
string

The value of the product's 67th custom field.

custom68
string

The value of the product's 68th custom field.

custom69
string

The value of the product's 69th custom field.

custom70
string

The value of the product's 70th custom field.

custom71
string

The value of the product's 71st custom field.

custom72
string

The value of the product's 72nd custom field.

custom73
string

The value of the product's 73rd custom field.

custom74
string

The value of the product's 74th custom field.

custom75
string

The value of the product's 75th custom field.

custom76
string

The value of the product's 76th custom field.

custom77
string

The value of the product's 77th custom field.

custom78
string

The value of the product's 78th custom field.

custom79
string

The value of the product's 79th custom field.

custom80
string

The value of the product's 80th custom field.

custom81
string

The value of the product's 81st custom field.

custom82
string

The value of the product's 82nd custom field.

custom83
string

The value of the product's 83rd custom field.

custom84
string

The value of the product's 84th custom field.

custom85
string

The value of the product's 85th custom field.

custom86
string

The value of the product's 86th custom field.

custom87
string

The value of the product's 87th custom field.

custom88
string

The value of the product's 88th custom field.

custom89
string

The value of the product's 89th custom field.

custom90
string

The value of the product's 90th custom field.

custom91
string

The value of the product's 91st custom field.

custom92
string

The value of the product's 92nd custom field.

custom93
string

The value of the product's 93rd custom field.

custom94
string

The value of the product's 94th custom field.

custom95
string

The value of the product's 95th custom field.

custom96
string

The value of the product's 96th custom field.

custom97
string

The value of the product's 97th custom field.

custom98
string

The value of the product's 98th custom field.

custom99
string

The value of the product's 99th custom field.

custom100
string

The value of the product's 100th custom field.

custom101
string

The value of the product's 101st custom field.

custom102
string

The value of the product's 102nd custom field.

custom103
string

The value of the product's 103rd custom field.

custom104
string

The value of the product's 104th custom field.

custom105
string

The value of the product's 105th custom field.

custom106
string

The value of the product's 106th custom field.

custom107
string

The value of the product's 107th custom field.

custom108
string

The value of the product's 108th custom field.

custom109
string

The value of the product's 109th custom field.

custom110
string

The value of the product's 110th custom field.

custom111
string

The value of the product's 111th custom field.

custom112
string

The value of the product's 112th custom field.

custom113
string

The value of the product's 113th custom field.

custom114
string

The value of the product's 114th custom field.

custom115
string

The value of the product's 115th custom field.

custom116
string

The value of the product's 116th custom field.

custom117
string

The value of the product's 117th custom field.

custom118
string

The value of the product's 118th custom field.

custom119
string

The value of the product's 119th custom field.

custom120
string

The value of the product's 120th custom field.

custom121
string

The value of the product's 121st custom field.

custom122
string

The value of the product's 122nd custom field.

custom123
string

The value of the product's 123rd custom field.

custom124
string

The value of the product's 124th custom field.

custom125
string

The value of the product's 125th custom field.

custom126
string

The value of the product's 126th custom field.

custom127
string

The value of the product's 127th custom field.

custom128
string

The value of the product's 128th custom field.

custom129
string

The value of the product's 129th custom field.

custom130
string

The value of the product's 130th custom field.

custom131
string

The value of the product's 131st custom field.

custom132
string

The value of the product's 132nd custom field.

custom133
string

The value of the product's 133rd custom field.

custom134
string

The value of the product's 134th custom field.

custom135
string

The value of the product's 135th custom field.

custom136
string

The value of the product's 136th custom field.

custom137
string

The value of the product's 137th custom field.

custom138
string

The value of the product's 138th custom field.

custom139
string

The value of the product's 139th custom field.

custom140
string

The value of the product's 140th custom field.

custom141
string

The value of the product's 141st custom field.

custom142
string

The value of the product's 142nd custom field.

custom143
string

The value of the product's 143rd custom field.

custom144
string

The value of the product's 144th custom field.

custom145
string

The value of the product's 145th custom field.

custom146
string

The value of the product's 146th custom field.

custom147
string

The value of the product's 147th custom field.

custom148
string

The value of the product's 148th custom field.

custom149
string

The value of the product's 149th custom field.

custom150
string

The value of the product's 150th custom field.

deleted
boolean

A boolean value whether the product has deleted or not.

description
string <= 16777215 characters

A custom description of the product.

name
string <= 255 characters

Name of a product.

productFamily
string <= 255 characters

Name of Product Family associated with the Product.

status
boolean

A boolean value whether the product is active or not.

unitOfMeasure
string <= 255 characters

Unit of the product; for example, kilograms, liters, or cases.

updatedAt
string <date-time>

The date and time the task was last updated.

website
string <= 255 characters

Website URL of this product.

{
}

Product Relationships

(user (data (object) or links (object)))

The creator of this task.

data (object) or links (object) (user)

The owner of this task.

Array of links (object) (purchase)
(user (data (object) or links (object)))
{
}

Product Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Product has to external sources. provideDataConnections

⌵ Product Actions

Get a Collection of Products

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/products
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Product
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/products
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Product by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/products/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Product by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/products/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Product
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/products/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}