Jump to

• Request
• Response
• Examples

Create a deal product

post

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct

Request

Path Parameters

• dealsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Deal Registrations resource and used to uniquely identify an instance of Deal Registrations. The client should not generate the hash key value. Instead, the client should query on the Deal Registrations collection resource in order to navigate to a specific instance of Deal Registrations to get the hash key.

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

• Amount: number
  Title: Amount

  The amount associated with the product line. The amount equals quantity times the registered price.
• ConvCurrencyCode: string
  Maximum Length: 15

  The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.
• ConvExchangeRate: number
  The exchange rate for converting the entered currency to the standard CRM corporate currency.
• ConvRateType: string
  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. 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.
• DealId: integer (int64)
  The unique identifier of the parent deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate unique identifier of the deal registration.
• DealProdId: integer (int64)
  The unique identifier of the deal registration product.
• DealProdNumber: string
  Maximum Length: 30

  The alternate unique identifier of the deal registration product.
• InventoryItemId: integer (int64)
  The unique identifier of the product inventory item associated with the deal registration.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization.
• ItemName: string
  Title: Item Description

  Maximum Length: 240

  The name of the product associated with the deal registration.
• ProductGroupId: integer (int64)
  The unique identifier of the product group associated with the deal registration.
• ProductGroupName: string
  Title: Name

  Maximum Length: 250

  The name of the product group associated with the deal registration.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  Public Unique Identifier for Product Group in Deal Registration
• ProductType: string
  Title: Type

  The product line type, such as product or product group.
• Quantity: number
  Title: Quantity

  The quantity of the product or product group.
• RegisteredPrice: number
  Title: Registered Price

  The registered price of the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the product quantity.

{
    "type":"object",
    "properties":{
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the parent deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConvCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.",
            "nullable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the deal registration.",
            "nullable":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the product line. The amount equals quantity times the registered price.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductType":{
            "title":"Type",
            "type":"string",
            "description":"The product line type, such as product or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product or product group.",
            "nullable":true
        },
        "DealProdId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductGroupName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealProdNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the deal registration product.",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. 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":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConvExchangeRate":{
            "type":"number",
            "description":"The exchange rate for converting the entered currency to the standard CRM corporate currency.",
            "nullable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the product associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RegisteredPrice":{
            "title":"Registered Price",
            "type":"number",
            "description":"The registered price of the product.",
            "nullable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the product quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":"50",
            "type":"string",
            "description":"Public Unique Identifier for Product Group in Deal Registration",
            "nullable":false
        }
    }
}

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 : deals-DealProduct-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount associated with the product line. The amount equals quantity times the registered price.
• ConvCurrencyCode: string
  Maximum Length: 15

  The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.
• ConvExchangeRate: number
  The exchange rate for converting the entered currency to the standard CRM corporate currency.
• ConvRateType: string
  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the deal product record was created.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. 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.
• DealId: integer (int64)
  The unique identifier of the parent deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate unique identifier of the deal registration.
• DealProdId: integer (int64)
  The unique identifier of the deal registration product.
• DealProdNumber: string
  Maximum Length: 30

  The alternate unique identifier of the deal registration product.
• InventoryItemId: integer (int64)
  The unique identifier of the product inventory item associated with the deal registration.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization.
• ItemDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  The description of the product associated with the deal registration.
• ItemName: string
  Title: Item Description

  Maximum Length: 240

  The name of the product associated with the deal registration.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  Public Unique Identifier for Item in Deal Registration
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

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

  Read Only: true

  Maximum Length: 1000

  The description of the product group associated with the deal registration.
• ProductGroupId: integer (int64)
  The unique identifier of the product group associated with the deal registration.
• ProductGroupName: string
  Title: Name

  Maximum Length: 250

  The name of the product group associated with the deal registration.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  Public Unique Identifier for Product Group in Deal Registration
• ProductType: string
  Title: Type

  The product line type, such as product or product group.
• Quantity: number
  Title: Quantity

  The quantity of the product or product group.
• RegisteredPrice: number
  Title: Registered Price

  The registered price of the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the product quantity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal product record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the parent deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the product group associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the product associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the deal registration product.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. 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":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"Public Unique Identifier for Item in Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "type":"number",
            "description":"The exchange rate for converting the entered currency to the standard CRM corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the product associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the product quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConvCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the product line. The amount equals quantity times the registered price.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Type",
            "type":"string",
            "description":"The product line type, such as product or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product or product group.",
            "nullable":true,
            "x-queryable":true
        },
        "RegisteredPrice":{
            "title":"Registered Price",
            "type":"number",
            "description":"The registered price of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":"50",
            "type":"string",
            "description":"Public Unique Identifier for Product Group in Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal product 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 deal product record.",
            "nullable":true,
            "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"
    }
}

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

ProductGroupExtnLovVA

Operation: /crmRestApi/resources/11.13.18.05/productGroups

Parameters:

• finder: ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

Name for Product Group detail base public view object.

ProductTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE%2CBindLookupCode%3D{ProductType}

The lookups resource is used to view standard lookup codes.

SalesCatalogExtnProductsLovVA

Operation: /crmRestApi/resources/11.13.18.05/products

Parameters:

• finder: ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.

Back to Top

Examples

The following example shows how to create a deal product by submitting a post request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals/300100071405733/child/DealProduct

Example of Request Body

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

{
  "ProductGroupId":100000011628005,
  "Quantity":90,
  "RegisteredPrice":100
}

Example of Response Body

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

{
  Amount: 9000
  ConvCurrencyCode: "USD"
  ConvExchangeRate: 1
  ConvRateType: "Corporate"
  CurrencyCode: "USD"
  DealId: 300100071395747
  DealProdId: 300100071521746
  ProductType: "Group"
  ProductGroupId: 100000011628005
  Quantity: 90
  RegisteredPrice: 100
  ...
}

Back to Top