TAG LINE
TAG LINE
SMALL TITLE

Price Book

(API Version v8)


What can you do with PriceBook?

  • DELETE PriceBook/{id}
    Delete an instance of the PriceBook object.

  • GET PriceBook/
    Retrieve all of the PriceBook objects.

  • GET PriceBook/Paged
    Retrieve all of the PriceBook objects in a paged fashion.

  • GET PriceBook/Paged/Detail
    Retrieve all of the PriceBook objects in a paged fashion with all object details.

  • GET PriceBook/{id}
    Retrieve an instance of the PriceBook object by its ID.

  • GET PriceBook/{id}/Detail
    Retrieve deep detail of the PriceBook object by its ID.

  • PATCH PriceBook/{id}
    Update or Add the PriceBook object and optionally make changes to any child objects.

  • POST PriceBook/
    Create a new instance of the PriceBook object.

  • PUT PriceBook/{id}
    Update an existing instance of the PriceBook object.


Properties

Property Details
identity
READ-ONLY
"identity": 27
Type: Number
This is the unique numeric identifier for the PriceBook
ownerId
READ-ONLY
"ownerId": 22
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.
name
"name": "Hello World"
Type: String
priceBookRegionId
"priceBookRegionId": 5
Type: Number
Unique identifier for the associated PriceBookRegion object.
priceBookRegionName
"priceBookRegionName": "Sample Name"
Type: String
The name of the object associated with the priceBookRegionId property.
description
"description": "Hello World"
Type: String
isStandard
"isStandard": true
Type: Boolean
isActive
"isActive": true
Type: Boolean
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the PriceBook object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEPriceBook/{id}
Delete an instance of the PriceBook object. Upon successful delete, this API will return a record of all of the related 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 PriceBook object.
Delete an instance of the PriceBook object.
DELETE PriceBook/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "priceBook"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETPriceBook/
Retrieve all of the PriceBook objects.
Retrieve all of the PriceBook objects.
GET PriceBook/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 22,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "priceBookRegionId": 21,
            "priceBookRegionName": "Sample Text Data",
            "description": "Sample Text Data",
            "isStandard": true,
            "isActive": true,
            "created": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETPriceBook/Paged
Retrieve all of the PriceBook 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 PriceBook objects in a paged fashion.
GET PriceBook/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "priceBookRegionId": 23,
                "priceBookRegionName": "Sample Text Data",
                "description": "Sample Text Data",
                "isStandard": true,
                "isActive": true,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETPriceBook/Paged/Detail
Retrieve all of the PriceBook objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the PriceBook objects in a paged fashion with all object details.
GET PriceBook/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "priceBookRegionId": 18,
                "priceBookRegionName": "Sample Text Data",
                "description": "Sample Text Data",
                "isStandard": true,
                "isActive": true,
                "created": "2021-04-26T15:25:27.587Z",
                "details": {
                    "packageFrequencyList": [
                        {
                            "identity": 17,
                            "packageId": 17,
                            "packageName": "Sample Text Data",
                            "packageFrequencyId": 98,
                            "packageFrequencyName": "Sample Text Data",
                            "packageCurrencyId": 93,
                            "currencyId": 10,
                            "currencyName": "Sample Text Data",
                            "currencyCode": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}
GETPriceBook/{id}
Retrieve an instance of the PriceBook object by its ID.
{id}Unique identifier for the PriceBook object.
Retrieve an instance of the PriceBook object by its ID.
GET PriceBook/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 25,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "priceBookRegionId": 27,
        "priceBookRegionName": "Sample Text Data",
        "description": "Sample Text Data",
        "isStandard": true,
        "isActive": true,
        "created": "2021-04-26T15:25:27.587Z"
    }
}
GETPriceBook/{id}/Detail
Retrieve deep detail of the PriceBook object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the PriceBook object.
Retrieve deep detail of the PriceBook object by its ID.
GET PriceBook/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 0,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "priceBookRegionId": 11,
        "priceBookRegionName": "Sample Text Data",
        "description": "Sample Text Data",
        "isStandard": true,
        "isActive": true,
        "created": "2021-04-26T15:25:27.587Z",
        "details": {
            "packageFrequencyList": [
                {
                    "identity": 17,
                    "packageId": 17,
                    "packageName": "Sample Text Data",
                    "packageFrequencyId": 98,
                    "packageFrequencyName": "Sample Text Data",
                    "packageCurrencyId": 93,
                    "currencyId": 10,
                    "currencyName": "Sample Text Data",
                    "currencyCode": "Sample Text Data"
                }
            ]
        }
    }
}
PATCHPriceBook/{id}
Update or Add the PriceBook object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the PriceBook object.
Update or Add the PriceBook object and optionally make changes to any child objects.
PATCH PriceBook/{id}

{
    "details": {},
    "priceBooks": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Sample Text Data",
                "priceBookRegionId": 15,
                "description": "Sample Text Data",
                "isStandard": true,
                "isActive": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "priceBook",
                "instance": {
                    "identity": 1,
                    "ownerId": 14,
                    "ownerName": "Sample Text Data",
                    "name": "Sample Text Data",
                    "priceBookRegionId": 27,
                    "priceBookRegionName": "Sample Text Data",
                    "description": "Sample Text Data",
                    "isStandard": true,
                    "isActive": true,
                    "created": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTPriceBook/
Create a new instance of the PriceBook object.
Create a new instance of the PriceBook object.
POST PriceBook/

{
    "name": "Sample Text Data",
    "priceBookRegionId": 27,
    "description": "Sample Text Data",
    "isStandard": true,
    "isActive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "priceBookRegionId": 11,
                "priceBookRegionName": "Sample Text Data",
                "description": "Sample Text Data",
                "isStandard": true,
                "isActive": true,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTPriceBook/{id}
Update an existing instance of the PriceBook object.
Update an existing instance of the PriceBook object.
PUT PriceBook/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "priceBookRegionId": 11,
    "description": "Sample Text Data",
    "isStandard": true,
    "isActive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "priceBookRegionId": 22,
                "priceBookRegionName": "Sample Text Data",
                "description": "Sample Text Data",
                "isStandard": true,
                "isActive": true,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}