Jump to

• Request
• Response
• Examples

Create one price book

post

/fscmRestApi/resources/11.13.18.05/priceBooks

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• BusinessUnit: string
  Maximum Length: 255

  The business unit for which the price book can be used for sales.
• BusinessUnitId(required): integer (int64)
  Value that uniquely identifies the business unit for which the price book can be used for sales.
• Currency: string
  Maximum Length: 255

  The code for the currency used in the price book.
• CurrencyCode(required): string
  Maximum Length: 15

  The currency used in the price book.
• Description: string
  Maximum Length: 1000

  The description of the price book.
• dimensions: array Price Book Dimension
  Title: Price Book Dimension

  Information about the parameters used in filtering items or calculating the prices that appear in the price book.
• EndDate: string (date-time)
  The date and time on which the price book is no longer effective.
• Name(required): string
  Maximum Length: 80

  The name of the price book.
• PriceBookId: integer (int64)
  Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.
• PriceBookNumber(required): string
  Maximum Length: 30

  The number for the price book.
• PricingDate(required): string (date-time)
  The date and time when price book values are calculated.
• StartDate(required): string (date-time)
  The date and time when the price book goes into effect.
• StatusCode: string
  Maximum Length: 30

  The generation status of the price book.

{
    "required":[
        "BusinessUnitId",
        "CurrencyCode",
        "Name",
        "PriceBookNumber",
        "PricingDate",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"The business unit for which the price book can be used for sales.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit for which the price book can be used for sales.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"The code for the currency used in the price book.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency used in the price book.",
            "nullable":false
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the price book.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date and time on which the price book is no longer effective.",
            "format":"date-time",
            "nullable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PriceBookNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The number for the price book.",
            "nullable":false
        },
        "PricingDate":{
            "type":"string",
            "description":"The date and time when price book values are calculated.",
            "format":"date-time",
            "nullable":false
        },
        "StartDate":{
            "type":"string",
            "description":"The date and time when the price book goes into effect.",
            "format":"date-time",
            "nullable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The generation status of the price book.",
            "nullable":true
        },
        "dimensions":{
            "title":"Price Book Dimension",
            "type":"array",
            "description":"Information about the parameters used in filtering items or calculating the prices that appear in the price book.",
            "items":{
                "$ref":"#/components/schemas/priceBooks-dimensions-item-post-request"
            }
        }
    }
}

Nested Schema : Price Book Dimension

Type: array

Title: Price Book Dimension

Information about the parameters used in filtering items or calculating the prices that appear in the price book.

Show Source

• Array of: object schema

{
    "title":"Price Book Dimension",
    "type":"array",
    "description":"Information about the parameters used in filtering items or calculating the prices that appear in the price book.",
    "items":{
        "$ref":"#/components/schemas/priceBooks-dimensions-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DimensionCriteria: string (byte)
  Criteria used to generate the price book.
• PriceBookDimensionId: integer (int64)
  Value that uniquely identifies the price book dimension.
• PriceBookId: integer (int64)
  Value that uniquely identifies the price book.
• ProductCriteria: string (byte)
  Product criteria used to generate the price book.
• Version: integer (int32)
  Version of the price book.

{
    "type":"object",
    "properties":{
        "DimensionCriteria":{
            "type":"string",
            "description":"Criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PriceBookDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductCriteria":{
            "type":"string",
            "description":"Product criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Version":{
            "type":"integer",
            "description":"Version of the price book.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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 : priceBooks-item-response

Type: object

Show Source

• BusinessUnit: string
  Maximum Length: 255

  The business unit for which the price book can be used for sales.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit for which the price book can be used for sales.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the record was created.
• Currency: string
  Maximum Length: 255

  The code for the currency used in the price book.
• CurrencyCode: string
  Maximum Length: 15

  The currency used in the price book.
• Description: string
  Maximum Length: 1000

  The description of the price book.
• dimensions: array Price Book Dimension
  Title: Price Book Dimension

  Information about the parameters used in filtering items or calculating the prices that appear in the price book.
• EndDate: string (date-time)
  The date and time on which the price book is no longer effective.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 80

  The name of the price book.
• PriceBookId: integer (int64)
  Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.
• PriceBookNumber: string
  Maximum Length: 30

  The number for the price book.
• PricingDate: string (date-time)
  The date and time when price book values are calculated.
• StartDate: string (date-time)
  The date and time when the price book goes into effect.
• StatusCode: string
  Maximum Length: 30

  The generation status of the price book.

{
    "type":"object",
    "properties":{
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"The business unit for which the price book can be used for sales.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit for which the price book can be used for sales.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"The code for the currency used in the price book.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency used in the price book.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date and time on which the price book is no longer effective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PriceBookNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The number for the price book.",
            "nullable":false,
            "x-queryable":true
        },
        "PricingDate":{
            "type":"string",
            "description":"The date and time when price book values are calculated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date and time when the price book goes into effect.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The generation status of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "dimensions":{
            "title":"Price Book Dimension",
            "type":"array",
            "description":"Information about the parameters used in filtering items or calculating the prices that appear in the price book.",
            "items":{
                "$ref":"#/components/schemas/priceBooks-dimensions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Price Book Dimension

Type: array

Title: Price Book Dimension

Information about the parameters used in filtering items or calculating the prices that appear in the price book.

Show Source

• Array of: object priceBooks-dimensions-item-response

{
    "title":"Price Book Dimension",
    "type":"array",
    "description":"Information about the parameters used in filtering items or calculating the prices that appear in the price book.",
    "items":{
        "$ref":"#/components/schemas/priceBooks-dimensions-item-response"
    }
}

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 : priceBooks-dimensions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the record was created.
• DimensionCriteria: string (byte)
  Criteria used to generate the price book.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceBookDimensionId: integer (int64)
  Value that uniquely identifies the price book dimension.
• PriceBookId: integer (int64)
  Value that uniquely identifies the price book.
• ProductCriteria: string (byte)
  Product criteria used to generate the price book.
• Version: integer (int32)
  Version of the price book.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionCriteria":{
            "type":"string",
            "description":"Criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductCriteria":{
            "type":"string",
            "description":"Product criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Version":{
            "type":"integer",
            "description":"Version of the price book.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

deletePriceBook

Operation: /fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/action/deletePriceBook

Parameters:

• PriceBookNumber: $request.path.PriceBookNumber

Deletes one price book and its contents based on a set of parameters.

dimensions

Operation: /fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/child/dimensions

Parameters:

• PriceBookNumber: $request.path.PriceBookNumber

Information about the parameters used in filtering items or calculating the prices that appear in the price book.

generatePriceBook

Operation: /fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/action/generatePriceBook

Parameters:

• PriceBookNumber: $request.path.PriceBookNumber

Generates a precalculated collection of prices based on a set of input parameters.

Back to Top

Examples

This example describes how to create price books.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/priceBooks"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "BusinessUnit": "Vision Operations",
  "BusinessUnitId": "204",
  "CurrencyCode": "USD",
  "Description": "RM_PB_TEST Testing",
  "EndDate": null,
  "Name": "RM_TEST",
  "PriceBookNumber": "RM_PB_TEST",
  "StartDate": "2025-07-07T00:00:00+00:00",
  "StatusCode": "ORA_QP_PB_DRAFT",
  "PricingDate": "2025-07-07T00:00:00+00:00"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "PriceBookId": "300100639346697",
  "Name": "RM_TEST",
  "PriceBookNumber": "RM_PB_TEST",
  "Description": "RM_PB_TEST Testing",
  "BusinessUnitId": "204",
  "BusinessUnit": "Vision Operations",
  "CurrencyCode": "USD",
  "Currency": "US Dollar",
  "StartDate": "2025-07-07T00:00:00+00:00",
  "CreatedBy": "PRICING_MGR_OPERATIONS",
  "EndDate": null,
  "PricingDate": "2025-07-07T00:00:00+00:00",
  "CreationDate": "2025-07-24T05:20:00+00:00",
  "LastUpdateDate": "2025-07-31T11:33:56.004+00:00",
  "LastUpdateLogin": "39AD42326F4268BDE063FC79060ADF5A",
  "LastUpdatedBy": "SCMOPERATIONS",
  "StatusCode": "ORA_QP_PB_DRAFT"
  }

Back to Top