Price Book Headers
priceBookHeaders Based on latest (2026.09)
Create, change, delete and look up Price Book Headers, with price book item and status search lov VA.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
priceBookHeaders_Id- Required on create
Name- At a glance
- 16 fields0 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/priceBookHeaders?fields=CreatedBy,CreationDate,CurrencyCode,DefaultPricebookFlag,DeleteFlag&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CurrencyCode": "<string, max 15>",
"DefaultPricebookFlag": false,
"DeleteFlag": false
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 16
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DefaultPricebookFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-onlySearchable |
Description | text · max 1999 | Optional on createUpdatableSearchable |
HeaderExternalKey | text · max 120 | Optional on createUpdatableSearchable |
HeaderExternalSource | text · max 120 · default PB_HEADER | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
Name | text · max 150 | Required on createUpdatableSearchable |
PricebookCode | text · max 80 | Optional on createSearchable |
PricebookId | number | Optional on createSearchable |
StatusCode | text · max 30 · default DRAFT | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/<name>. Add them to a GET with expand.
PriceBookItemGET · POST · PATCH · DELETE Price Book Items · 17 fields · 1 findersCreatedByCreationDateCurrencyCodeInvItemIdInvOrgIdItemDescriptionItemExternalKeyItemExternalSourceItemNumberLastUpdateDateLastUpdateLoginLastUpdatedByListPricePriceUOMCodePricebookCodePricebookIdPricebookItemIdStatusSearchLovVAGET · POST · PATCH · DELETE Status Search · 4 fields · 15 findersLookupCodeLookupTypeMeaningTag
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/priceBookHeadersand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CurrencyCode, notcurrencycode. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.