TAG LINE
SMALL TITLE
A unique identifier for particular product that has custom pricing attached to it. Allowing you to have 2 of the same products but with different custom pricing on each based on their product code. These are used in Account Price Plans and on Sales Orders.
Essentially you can create a customer specific product code with pricing for a Package added to their Price Plan. This creates a customer specific product catalog that can then be added to the account like a standard Package.
identity READ-ONLY | "identity": 15 Type: Number This is the unique numeric identifier for the AccountProductCode |
name | "name": "Hello World" Type: String This is the user defined name given to the Product Code. |
accountId | "accountId": 22 Type: Number Unique identifier for the associated Account object. |
accountName | "accountName": "Sample Name" Type: String The name of the object associated with the accountId property. |
ownerId READ-ONLY | "ownerId": 20 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| DELETE | api/v2/Account/ProductCode/{id} |
| Delete an instance of the AccountProductCode object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountProductCode object. |
Delete an instance of the AccountProductCode object. DELETE api/v2/Account/ProductCode/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountProductCode"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Account/ProductCode/ |
| Retrieve all of the AccountProductCode objects. | |
Retrieve all of the AccountProductCode objects. GET api/v2/Account/ProductCode/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 23,
"accountName": "Sample Text Data",
"ownerId": 8,
"ownerName": "Sample Text Data"
}
]
} | |
| GET | api/v2/Account/ProductCode/AvailableFor/Account/{id} |
| Retrieve all AccountProductCode objects that are available for the specified Account. | |
| {id} | Unique identifier for the Account object. |
| GET | api/v2/Account/ProductCode/AvailableFor/Account/{id}/PackageFrequency/{packageFrequencyId} |
| Retrieve all the AccountProductCode objects that are available for the specified Account and PackageFrequency. | |
| {id} | Unique identifier for the Account object. |
| {packageFrequencyId} | Unique identifier for the PackageFrequency object. |
| GET | api/v2/Account/ProductCode/Paged |
| Retrieve all of the AccountProductCode objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountProductCode objects in a paged fashion. GET api/v2/Account/ProductCode/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 20,
"accountName": "Sample Text Data",
"ownerId": 1,
"ownerName": "Sample Text Data"
}
]
}
} | |
| GET | api/v2/Account/ProductCode/{id} |
| Retrieve an instance of the AccountProductCode object by its ID. | |
| {id} | Unique identifier for the AccountProductCode object. |
Retrieve an instance of the AccountProductCode object by its ID. GET api/v2/Account/ProductCode/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"accountId": 18,
"accountName": "Sample Text Data",
"ownerId": 25,
"ownerName": "Sample Text Data"
}
} | |
| POST | api/v2/Account/ProductCode/ |
| Create a new instance of the AccountProductCode object. | |
Create a new instance of the AccountProductCode object. POST api/v2/Account/ProductCode/
{
"name": "Sample Text Data",
"accountId": 24
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 26,
"accountName": "Sample Text Data",
"ownerId": 20,
"ownerName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v2/Account/ProductCode/{id} |
| Update an existing instance of the AccountProductCode object. | |
Update an existing instance of the AccountProductCode object. PUT api/v2/Account/ProductCode/{id}
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 0
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 14,
"accountName": "Sample Text Data",
"ownerId": 3,
"ownerName": "Sample Text Data"
}
]
}
} | |