Jump to

• Request
• Response
• Examples

Create a pricebook

post

/crmRestApi/resources/11.13.18.05/priceBookHeaders

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DefaultPricebookFlag: boolean
  Title: Default Price Book

  Maximum Length: 1

  Default Value: false

  Indicates if it is the default price book for the currency.
• Description: string
  Title: Description

  Maximum Length: 1999

  A brief description of the price book.
• HeaderExternalKey: string
  Title: Header External Key

  Maximum Length: 120

  The external key value for the price book.
• HeaderExternalSource: string
  Title: Header External Source

  Maximum Length: 120

  Default Value: PB_HEADER

  The source for the external key of the price book.
• Name(required): string
  Title: Name

  Maximum Length: 150

  The name of the price book.
• PricebookCode: string
  Title: Price Book Code

  Maximum Length: 80

  The code indicating the price book. This value is auto-generated when a pricebook is created.
• PricebookId: integer (int64)
  Title: Price Book ID

  The unique identifier of the price book.
• PriceBookItem: array Price Book Items
  Title: Price Book Items

  The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code indicating the status of the price book. For example, Draft, Active, or Expired.
• StatusSearchLovVA: array Status Search
  Title: Status Search

  The Status Search resource lets you search for the status of a pricebook.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusSearchLovVA":{
            "title":"Status Search",
            "type":"array",
            "description":"The Status Search resource lets you search for the status of a pricebook.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-post-request"
            }
        },
        "HeaderExternalKey":{
            "title":"Header External Key",
            "maxLength":"120",
            "type":"string",
            "description":"The external key value for the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1999",
            "type":"string",
            "description":"A brief description of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderExternalSource":{
            "title":"Header External Source",
            "maxLength":"120",
            "type":"string",
            "description":"The source for the external key of the price book.",
            "nullable":true,
            "default":"PB_HEADER",
            "x-queryable":true
        },
        "PriceBookItem":{
            "title":"Price Book Items",
            "type":"array",
            "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-post-request"
            }
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the price book. This value is auto-generated when a pricebook is created.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultPricebookFlag":{
            "title":"Default Price Book",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if it is the default price book for the currency.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the price book. For example, Draft, Active, or Expired.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "PricebookId":{
            "title":"Price Book ID",
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Price Book Items

Type: array

Title: Price Book Items

The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.

Show Source

• Array of: object priceBookHeaders-PriceBookItem-item-post-request

{
    "title":"Price Book Items",
    "type":"array",
    "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-post-request"
    }
}

Nested Schema : Status Search

Type: array

Title: Status Search

The Status Search resource lets you search for the status of a pricebook.

Show Source

• Array of: object priceBookHeaders-StatusSearchLovVA-item-post-request

{
    "title":"Status Search",
    "type":"array",
    "description":"The Status Search resource lets you search for the status of a pricebook.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-post-request"
    }
}

Nested Schema : priceBookHeaders-PriceBookItem-item-post-request

Type: object

Show Source

• CurrencyCode: string
  Maximum Length: 15

  The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.
• InvItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the item selected in the price book.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization associated with the item selected in the price book.
• ItemDescription: string
  Title: Name

  A brief description of the price book item.
• ItemExternalKey: string
  Title: External Key

  Maximum Length: 120

  The external key value for the price book item.
• ItemExternalSource: string
  Title: External Source

  Maximum Length: 120

  Default Value: PB_LINE

  The source for the external key of the price book item.
• ListPrice: number
  Title: List Price

  Default Value: 0

  The price of the item.
• PricebookCode: string
  Title: Price Book Code

  Maximum Length: 80
• PricebookId: integer (int64)
  The unique identifier of the price book.
• PricebookItemId: integer (int64)
  The unique identifier of the price book item.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement of the item.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":"120",
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":"120",
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PricebookItemId":{
            "type":"integer",
            "description":"The unique identifier of the price book item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : priceBookHeaders-StatusSearchLovVA-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : priceBookHeaders-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DefaultPricebookFlag: boolean
  Title: Default Price Book

  Maximum Length: 1

  Default Value: false

  Indicates if it is the default price book for the currency.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the price book can be deleted. The default value is true.
• Description: string
  Title: Description

  Maximum Length: 1999

  A brief description of the price book.
• HeaderExternalKey: string
  Title: Header External Key

  Maximum Length: 120

  The external key value for the price book.
• HeaderExternalSource: string
  Title: Header External Source

  Maximum Length: 120

  Default Value: PB_HEADER

  The source for the external key of the price book.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 150

  The name of the price book.
• PricebookCode: string
  Title: Price Book Code

  Maximum Length: 80

  The code indicating the price book. This value is auto-generated when a pricebook is created.
• PricebookId: integer (int64)
  Title: Price Book ID

  The unique identifier of the price book.
• PriceBookItem: array Price Book Items
  Title: Price Book Items

  The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code indicating the status of the price book. For example, Draft, Active, or Expired.
• StatusSearchLovVA: array Status Search
  Title: Status Search

  The Status Search resource lets you search for the status of a pricebook.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the price book can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"1999",
            "type":"string",
            "description":"A brief description of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderExternalSource":{
            "title":"Header External Source",
            "maxLength":"120",
            "type":"string",
            "description":"The source for the external key of the price book.",
            "nullable":true,
            "default":"PB_HEADER",
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the price book. This value is auto-generated when a pricebook is created.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the price book. For example, Draft, Active, or Expired.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the price book can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusSearchLovVA":{
            "title":"Status Search",
            "type":"array",
            "description":"The Status Search resource lets you search for the status of a pricebook.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-response"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the price book can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderExternalKey":{
            "title":"Header External Key",
            "maxLength":"120",
            "type":"string",
            "description":"The external key value for the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBookItem":{
            "title":"Price Book Items",
            "type":"array",
            "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-response"
            }
        },
        "DefaultPricebookFlag":{
            "title":"Default Price Book",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if it is the default price book for the currency.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PricebookId":{
            "title":"Price Book ID",
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Price Book Items

Type: array

Title: Price Book Items

The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.

Show Source

• Array of: object priceBookHeaders-PriceBookItem-item-response

{
    "title":"Price Book Items",
    "type":"array",
    "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-response"
    }
}

Nested Schema : Status Search

Type: array

Title: Status Search

The Status Search resource lets you search for the status of a pricebook.

Show Source

• Array of: object priceBookHeaders-StatusSearchLovVA-item-response

{
    "title":"Status Search",
    "type":"array",
    "description":"The Status Search resource lets you search for the status of a pricebook.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : priceBookHeaders-PriceBookItem-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Maximum Length: 15

  The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.
• InvItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the item selected in the price book.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization associated with the item selected in the price book.
• ItemDescription: string
  Title: Name

  A brief description of the price book item.
• ItemExternalKey: string
  Title: External Key

  Maximum Length: 120

  The external key value for the price book item.
• ItemExternalSource: string
  Title: External Source

  Maximum Length: 120

  Default Value: PB_LINE

  The source for the external key of the price book item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  Default Value: 0

  The price of the item.
• PricebookCode: string
  Title: Price Book Code

  Maximum Length: 80
• PricebookId: integer (int64)
  The unique identifier of the price book.
• PricebookItemId: integer (int64)
  The unique identifier of the price book item.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement of the item.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":"120",
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PricebookItemId":{
            "type":"integer",
            "description":"The unique identifier of the price book item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":"120",
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : priceBookHeaders-StatusSearchLovVA-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS.
• LookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  The type of the FND Lookup.
• Meaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the lookup.
• Tag: string
  Title: Tag

  Read Only: true

  Maximum Length: 150

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the FND Lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

PriceBookItem

Operation: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem

Parameters:

• priceBookHeaders_Id: $request.path.priceBookHeaders_Id

The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.

StatusCodeLovForUIVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DORA_QSC_PRICE_BOOK_STATUS

The list of different status codes associated with the price book. The maximum value for this attribute is 30.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

StatusSearchLovVA

Operation: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA

Parameters:

• priceBookHeaders_Id: $request.path.priceBookHeaders_Id

The Status Search resource lets you search for the status of a pricebook.

YesNoPricebookFlagFndLookupsVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

The list of values to indicate whether the pricebook is the default for a currency. The valid values are Y and N.

The following properties are defined on the LOV link relation:

• Source Attribute: DefaultPricebookFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to create a pricebook header by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/priceBookHeaders

Example of Request Body

The following example shows the contents of the request body in JSON format.

{

"CurrencyCode" : "USD",

"Name" : "Test/PriceBook/001",

"Description" : "Test Pricebook 001",

"StatusCode" : "DRAFT"

}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "PricebookCode" : "74c5a19c-fc12-4999-8ffc-f2996a1149c6",
  "CurrencyCode" : "USD",
  "Name" : "Test/PriceBook/001",
  "Description" : "Test Pricebook 001",
  "StatusCode" : "DRAFT",
  "CustomAttr_c" : null,
  "TestSearch_c" : "tw",
  "TestAttr_c" : null,
  "links" : [ {
   . . .
  } ]
}

Back to Top