GET v1/Pricebooks/{id}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Common.Dto.Get.PricebookName | Description | Type | Additional information |
---|---|---|---|
name | string |
None. |
|
description | string |
None. |
|
code | string |
None. |
|
createdTimestamp | date |
None. |
|
modifiedTimestamp | date |
None. |
|
deletable | boolean |
None. |
|
defaultPrice | Common.Dto.Get.PricebookEntryBase |
None. |
|
pricebookEntries | Collection of Common.Dto.Get.PricebookEntry |
None. |
|
priceLimits | Collection of Common.Dto.Get.PricebookPriceLimitAmount |
None. |
|
id | integer |
None. |
|
uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "name": "sample string 1", "description": "sample string 2", "code": "sample string 3", "createdTimestamp": "2025-05-21T09:38:47.6979654+00:00", "modifiedTimestamp": "2025-05-21T09:38:47.6979654+00:00", "deletable": true, "defaultPrice": { "id": 1, "pricingModel": { "pricingModelType": "sample string 1", "quantityRanges": [ { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" }, { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" } ], "pricingFormulaType": "sample string 2", "id": 3, "uri": "sample string 4" } }, "pricebookEntries": [ { "priority": 1, "salesTrackingCode1Id": 1, "salesTrackingCode1Name": "sample string 2", "salesTrackingCode1Code": "sample string 3", "salesTrackingCode2Id": 1, "salesTrackingCode2Name": "sample string 4", "salesTrackingCode2Code": "sample string 5", "salesTrackingCode3Id": 1, "salesTrackingCode3Name": "sample string 6", "salesTrackingCode3Code": "sample string 7", "salesTrackingCode4Id": 1, "salesTrackingCode4Name": "sample string 8", "salesTrackingCode4Code": "sample string 9", "salesTrackingCode5Id": 1, "salesTrackingCode5Name": "sample string 10", "salesTrackingCode5Code": "sample string 11", "id": 12, "pricingModel": { "pricingModelType": "sample string 1", "quantityRanges": [ { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" }, { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" } ], "pricingFormulaType": "sample string 2", "id": 3, "uri": "sample string 4" } }, { "priority": 1, "salesTrackingCode1Id": 1, "salesTrackingCode1Name": "sample string 2", "salesTrackingCode1Code": "sample string 3", "salesTrackingCode2Id": 1, "salesTrackingCode2Name": "sample string 4", "salesTrackingCode2Code": "sample string 5", "salesTrackingCode3Id": 1, "salesTrackingCode3Name": "sample string 6", "salesTrackingCode3Code": "sample string 7", "salesTrackingCode4Id": 1, "salesTrackingCode4Name": "sample string 8", "salesTrackingCode4Code": "sample string 9", "salesTrackingCode5Id": 1, "salesTrackingCode5Name": "sample string 10", "salesTrackingCode5Code": "sample string 11", "id": 12, "pricingModel": { "pricingModelType": "sample string 1", "quantityRanges": [ { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" }, { "min": 1.0, "max": 1.0, "prices": [ { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" }, { "amount": 1.0, "conditionAmount": 1.0, "variableAmount": 1.0, "currency": "sample string 1", "conditionAmountDays": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" } ], "pricingFormulaType": "sample string 2", "id": 3, "uri": "sample string 4" } } ], "priceLimits": [ { "amount": 1.0, "currency": "sample string 2" }, { "amount": 1.0, "currency": "sample string 2" } ], "id": 7, "uri": "sample string 8" }