Jump to

• Request
• Response

Get all mapped product templates

get

/crmRestApi/resources/11.13.18.05/mappedProductTemplates

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the mapped product template with the specified primary key.
    Finder Variables:
    • InventoryItemId; integer; The unique identifier of the inventory item corresponding to the product template.
    • OrganizationId; integer; The unique identifier of the inventory item organization corresponding to the product template.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ATPCode; string; The ATP code to check if available to promise and/or capable to promise information, when placing demand.
  • ATPComponentsCode; string; Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
  • AllowMaintenanceAsset; string; The maintainable asset configuration.
  • AllowMaintenanceAssetFlag; boolean; Indicates whether maintainable assets can be defined for the item.
  • AllowSuspend; string; Indicates whether a service can be suspended.
  • AllowSuspendFlag; boolean; Indicates whether a service can be suspended.
  • AllowTerminate; string; Indicates whether a service can be terminated.
  • AllowTerminateFlag; boolean; Indicates whether a service can be terminated.
  • ApprovalStatus; string; The approval status of the item.
  • AssetTracked; string; Indicates whether an item is tracked as an asset in installed base.
  • AssetTrackedFlag; boolean; Indicates whether an item is tracked as an asset in installed base.
  • AutoSerialAlphaPrefix; string; The starting alphabet prefix for all serial numbers which are being defined for the Item.
  • BOMItemType; number; The type of bill of material the item can possess such as standard, model, planning, and other.
  • CSSEnabled; string; Indicates if the product is enabled for customer self-service. The default value is No.
  • CSSEnabledFlag; boolean; Indicates if the product is enabled for customer self-service. The default value is No.
  • Collateral; string; Indicates whether the item is a collateral.
  • CollateralFlag; boolean; Indicates whether the item is a collateral.
  • ContainerItem; string; Indicates whether containers are used for shipping the items.
  • ContainerItemFlag; boolean; Indicates whether containers are used for Shipping the items.
  • ContainerTypeCode; string; The code that specifies the type of the container.
  • CoverageScheduleId; integer; The template associated with the contract item type.
  • CustomerOrder; string; Indicates whether to allow an item to be ordered by external customers.
  • CustomerOrderFlag; boolean; Indicates whether to allow an item to be ordered by external customers.
  • DefaultTemplate; string; Indicates whether it???s a default item template of that organization under root item class.
  • DefaultTemplateFlag; boolean; Indicates whether it???s a default item template of that organization under root item class.
  • DefaultUOM; string; The default unit of measure (UOM) for the product.
  • DefaultUOMCode; string; The default unit of measure (UOM) code for the product.
  • DimensionUOMCode; string; The unit of measure for the dimension of the item.
  • EligibilityCompatibilityRule; string; A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.
  • EligibilityCompatibilityRuleFlag; boolean; Indicates a specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.
  • EligibleToSell; string; Indicates whether the item can be sold or not.
  • EligibleToSellFlag; boolean; Indicates whether the item can be sold or not.
  • EquipmentType; number; Indicates whether the item is equipment.
  • EquipmentTypeFlag; boolean; Indicates whether the item is equipment.
  • Event; string; Indicates whether the item is event.
  • EventFlag; boolean; Indicates whether the item is event.
  • FinancingAllowed; string; Indicates whether a customer can finance this item.
  • FinancingAllowedFlag; boolean; Indicates whether a customer can finance this item.
  • InternalVolume; number; The internal volume of the container or vehicle.
  • InventoryItemId; integer; The unique identifier of the inventory item.
  • InventoryItemStatusCode; string; The predefined code that indicates the status of the product. The default value is active.
  • InvoiceEnabled; string; Indicates whether to activate an item for invoicing in Oracle Receivables.
  • InvoiceEnabledFlag; boolean; Indicates whether to activate an item for invoicing in Oracle Receivables.
  • InvoiceableItem; string; Indicates whether to include an item on an Oracle Receivables invoice.
  • InvoiceableItemFlag; boolean; Indicates whether to include an item on an Oracle Receivables invoice.
  • ItemCatalogGroupId; integer; The unique identifier of the catalog group that the product belongs to.
  • ItemTemplateName; string; The name of item template.
  • ItemType; string; Indicator or classification for an item, such as finished or purchased.
  • MaximumLoadWeight; number; The maximum load weight of the container or vehicle.
  • MinimumFillPercent; number; The minimum fill of the container or vehicle to be used.
  • OrganizationCode; string; The unique code of the sales product item organization.
  • OrganizationId; integer; The unique identifier of the inventory item organization associated with the item template.
  • PickComponents; string; Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.
  • PickComponentsFlag; boolean; Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.
  • ProcessingDays; number; The lead time for the order.
  • ProdTmplMappingCode; string; The unique identifer of product template mapping.
  • ProductType; string; The code indicating the type of the sales product, such as Goods, Included Warranty, Extended arranty, Service Level Agreement, Training, or Subscription.
  • ProductTypeCode; string; The code indicating the type of the product. The accepted values are COVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING.
  • ReplenishToOrder; string; The final assembly work order which is created based on sales order details.
  • ReplenishToOrderFlag; boolean; Indicates if the final assembly work order is to be created based on sales order details.
  • Returnable; string; Indicates whether we should allow the customers to return the item.
  • ReturnableFlag; boolean; Indicates whether to allow customers to return an item.
  • SerialNumberControlCode; number; The number assigned to each unit of an item and used to track the item.
  • ServReqEnabledCode; string; Indicates whether the product is eligible for service.
  • ServiceDuration; number; The number indicating the service duration.
  • ServiceDurationPeriodCode; string; The number indicating the service duration period.
  • ServiceDurationTypeCode; string; The type of duration applicable for a service item.
  • ServiceStartDelay; number; The attribute specifying the delay in starting a service after a milestone.
  • ServiceStartTypeCode; string; The type of service start rule which should be used for a service item.
  • ShippableItem; string; Indicates whether to ship an item to a customer.
  • ShippableItemFlag; boolean; Indicates whether to ship an item to a customer.
  • StartAutoSerialNumber; string; The starting number for all serial numbers for this item.
  • TemplateItem; string; Indicates whether it???s a template. The value will be always Y.
  • TemplateItemFlag; boolean; Indicates whether it???s a template. The value will be always true.
  • TemplateName; string; The name of the product template.
  • UnitHeight; number; The height of the item.
  • UnitLength; number; The length of the item.
  • UnitVolume; number; The volume of one unit of item.
  • UnitWeight; number; The weight of one unit of item.
  • UnitWidth; number; The width of the item.
  • VehicleItem; string; Indicates whether vehicles are used for shipping the items.
  • VehicleItemFlag; boolean; Indicates whether vehicles are used for shipping the items.
  • VolumeUOMCode; string; The volume unit of measure.
  • WIPSupplyType; integer; The supply type for components.
  • WeightUOMCode; string; The weight unit of measure.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : mappedProductTemplates

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/mappedProductTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object mappedProductTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/mappedProductTemplates-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 : mappedProductTemplates-item-response

Type: object

Show Source

• AllowMaintenanceAsset: string
  Read Only: true

  Maximum Length: 1

  The maintainable asset configuration.
• AllowMaintenanceAssetFlag: boolean
  Read Only: true

  Indicates whether maintainable assets can be defined for the item.
• AllowSuspend: string
  Read Only: true

  Maximum Length: 1

  Indicates whether a service can be suspended.
• AllowSuspendFlag: boolean
  Read Only: true

  Indicates whether a service can be suspended.
• AllowTerminate: string
  Read Only: true

  Maximum Length: 1

  Indicates whether a service can be terminated.
• AllowTerminateFlag: boolean
  Read Only: true

  Indicates whether a service can be terminated.
• ApprovalStatus: string
  Read Only: true

  Maximum Length: 30

  The approval status of the item.
• AssetTracked: string
  Read Only: true

  Maximum Length: 1

  Indicates whether an item is tracked as an asset in installed base.
• AssetTrackedFlag: boolean
  Read Only: true

  Indicates whether an item is tracked as an asset in installed base.
• ATPCode: string
  Read Only: true

  Maximum Length: 1

  The ATP code to check if available to promise and/or capable to promise information, when placing demand.
• ATPComponentsCode: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
• AutoSerialAlphaPrefix: string
  Read Only: true

  Maximum Length: 80

  The starting alphabet prefix for all serial numbers which are being defined for the Item.
• BOMItemType: number
  Read Only: true

  The type of bill of material the item can possess such as standard, model, planning, and other.
• Collateral: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the item is a collateral.
• CollateralFlag: boolean
  Read Only: true

  Indicates whether the item is a collateral.
• ContainerItem: string
  Read Only: true

  Maximum Length: 1

  Indicates whether containers are used for shipping the items.
• ContainerItemFlag: boolean
  Read Only: true

  Indicates whether containers are used for Shipping the items.
• ContainerTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code that specifies the type of the container.
• CoverageScheduleId: integer (int64)
  Read Only: true

  The template associated with the contract item type.
• CSSEnabled: string
  Read Only: true

  Maximum Length: 1

  Indicates if the product is enabled for customer self-service. The default value is No.
• CSSEnabledFlag: boolean
  Read Only: true

  Indicates if the product is enabled for customer self-service. The default value is No.
• CustomerOrder: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to allow an item to be ordered by external customers.
• CustomerOrderFlag: boolean
  Read Only: true

  Indicates whether to allow an item to be ordered by external customers.
• DefaultTemplate: string
  Read Only: true

  Maximum Length: 1

  Indicates whether it???s a default item template of that organization under root item class.
• DefaultTemplateFlag: boolean
  Read Only: true

  Indicates whether it???s a default item template of that organization under root item class.
• DefaultUOM: string
  Read Only: true

  The default unit of measure (UOM) for the product.
• DefaultUOMCode: string
  Read Only: true

  Maximum Length: 3

  The default unit of measure (UOM) code for the product.
• DimensionUOMCode: string
  Read Only: true

  Maximum Length: 3

  The unit of measure for the dimension of the item.
• EligibilityCompatibilityRule: string
  Read Only: true

  Maximum Length: 1

  A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.
• EligibilityCompatibilityRuleFlag: boolean
  Read Only: true

  Indicates a specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.
• EligibleToSell: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the item can be sold or not.
• EligibleToSellFlag: boolean
  Read Only: true

  Indicates whether the item can be sold or not.
• EquipmentType: number
  Read Only: true

  Indicates whether the item is equipment.
• EquipmentTypeFlag: boolean
  Read Only: true

  Indicates whether the item is equipment.
• Event: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the item is event.
• EventFlag: boolean
  Read Only: true

  Indicates whether the item is event.
• FinancingAllowed: string
  Read Only: true

  Maximum Length: 1

  Indicates whether a customer can finance this item.
• FinancingAllowedFlag: boolean
  Read Only: true

  Indicates whether a customer can finance this item.
• InternalVolume: number
  Read Only: true

  The internal volume of the container or vehicle.
• InventoryItemId: integer (int64)
  Read Only: true

  The unique identifier of the inventory item.
• InventoryItemStatusCode: string
  Read Only: true

  Maximum Length: 10

  The predefined code that indicates the status of the product. The default value is active.
• InvoiceableItem: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to include an item on an Oracle Receivables invoice.
• InvoiceableItemFlag: boolean
  Read Only: true

  Indicates whether to include an item on an Oracle Receivables invoice.
• InvoiceEnabled: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to activate an item for invoicing in Oracle Receivables.
• InvoiceEnabledFlag: boolean
  Read Only: true

  Indicates whether to activate an item for invoicing in Oracle Receivables.
• ItemCatalogGroupId: integer (int64)
  Read Only: true

  The unique identifier of the catalog group that the product belongs to.
• ItemTemplateName: string
  Read Only: true

  Maximum Length: 960

  The name of item template.
• ItemType: string
  Read Only: true

  Maximum Length: 30

  Indicator or classification for an item, such as finished or purchased.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumLoadWeight: number
  Read Only: true

  The maximum load weight of the container or vehicle.
• MinimumFillPercent: number
  Read Only: true

  The minimum fill of the container or vehicle to be used.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 1000

  The unique code of the sales product item organization.
• OrganizationId: integer (int64)
  Read Only: true

  The unique identifier of the inventory item organization associated with the item template.
• PickComponents: string
  Read Only: true

  Maximum Length: 1

  Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.
• PickComponentsFlag: boolean
  Read Only: true

  Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.
• ProcessingDays: number
  Read Only: true

  The lead time for the order.
• ProdTmplMappingCode: string
  Read Only: true

  Maximum Length: 300

  The unique identifer of product template mapping.
• ProductType: string
  Read Only: true

  Maximum Length: 80

  The code indicating the type of the sales product, such as Goods, Included Warranty, Extended arranty, Service Level Agreement, Training, or Subscription.
• ProductTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the type of the product. The accepted values are COVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING.
• ReplenishToOrder: string
  Read Only: true

  Maximum Length: 1

  The final assembly work order which is created based on sales order details.
• ReplenishToOrderFlag: boolean
  Read Only: true

  Indicates if the final assembly work order is to be created based on sales order details.
• Returnable: string
  Read Only: true

  Maximum Length: 1

  Indicates whether we should allow the customers to return the item.
• ReturnableFlag: boolean
  Read Only: true

  Indicates whether to allow customers to return an item.
• SerialNumberControlCode: number
  Read Only: true

  The number assigned to each unit of an item and used to track the item.
• ServiceDuration: number
  Read Only: true

  The number indicating the service duration.
• ServiceDurationPeriodCode: string
  Read Only: true

  Maximum Length: 10

  The number indicating the service duration period.
• ServiceDurationTypeCode: string
  Read Only: true

  Maximum Length: 3

  The type of duration applicable for a service item.
• ServiceStartDelay: number
  Read Only: true

  The attribute specifying the delay in starting a service after a milestone.
• ServiceStartTypeCode: string
  Read Only: true

  Maximum Length: 3

  The type of service start rule which should be used for a service item.
• ServReqEnabledCode: string
  Read Only: true

  Maximum Length: 30

  Indicates whether the product is eligible for service.
• ShippableItem: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to ship an item to a customer.
• ShippableItemFlag: boolean
  Read Only: true

  Indicates whether to ship an item to a customer.
• StartAutoSerialNumber: string
  Read Only: true

  Maximum Length: 80

  The starting number for all serial numbers for this item.
• TemplateItem: string
  Read Only: true

  Maximum Length: 1

  Indicates whether it???s a template. The value will be always Y.
• TemplateItemFlag: boolean
  Read Only: true

  Indicates whether it???s a template. The value will be always true.
• TemplateName: string
  Read Only: true

  Maximum Length: 255

  The name of the product template.
• UnitHeight: number
  Read Only: true

  The height of the item.
• UnitLength: number
  Read Only: true

  The length of the item.
• UnitVolume: number
  Read Only: true

  The volume of one unit of item.
• UnitWeight: number
  Read Only: true

  The weight of one unit of item.
• UnitWidth: number
  Read Only: true

  The width of the item.
• VehicleItem: string
  Read Only: true

  Maximum Length: 1

  Indicates whether vehicles are used for shipping the items.
• VehicleItemFlag: boolean
  Read Only: true

  Indicates whether vehicles are used for shipping the items.
• VolumeUOMCode: string
  Read Only: true

  Maximum Length: 3

  The volume unit of measure.
• WeightUOMCode: string
  Read Only: true

  Maximum Length: 3

  The weight unit of measure.
• WIPSupplyType: integer (int64)
  Read Only: true

  The supply type for components.

{
    "type":"object",
    "properties":{
        "EligibilityCompatibilityRule":{
            "maxLength":"1",
            "type":"string",
            "description":"A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumFillPercent":{
            "type":"number",
            "description":"The minimum fill of the container or vehicle to be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeightUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The weight unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceableItemFlag":{
            "type":"boolean",
            "description":"Indicates whether to include an item on an Oracle Receivables invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceableItem"
                ]
            },
            "x-queryable":true
        },
        "CustomerOrder":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether to allow an item to be ordered by external customers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ATPComponentsCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicator or classification for an item, such as finished or purchased.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"number",
            "description":"The number assigned to each unit of an item and used to track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibilityCompatibilityRuleFlag":{
            "type":"boolean",
            "description":"Indicates a specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EligibilityCompatibilityRule"
                ]
            },
            "x-queryable":true
        },
        "EquipmentType":{
            "type":"number",
            "description":"Indicates whether the item is equipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The approval status of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleToSellFlag":{
            "type":"boolean",
            "description":"Indicates whether the item can be sold or not.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EligibleToSell"
                ]
            },
            "x-queryable":true
        },
        "FinancingAllowed":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a customer can finance this item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemTemplateName":{
            "maxLength":"960",
            "type":"string",
            "description":"The name of item template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitWeight":{
            "type":"number",
            "description":"The weight of one unit of item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BOMItemType":{
            "type":"number",
            "description":"The type of bill of material the item can possess such as standard, model, planning, and other.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowTerminateFlag":{
            "type":"boolean",
            "description":"Indicates whether a service can be terminated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AllowTerminate"
                ]
            },
            "x-queryable":true
        },
        "ContainerItemFlag":{
            "type":"boolean",
            "description":"Indicates whether containers are used for Shipping the items.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContainerItem"
                ]
            },
            "x-queryable":true
        },
        "PickComponentsFlag":{
            "type":"boolean",
            "description":"Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PickComponents"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowTerminate":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a service can be terminated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The default unit of measure (UOM) code for the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether to activate an item for invoicing in Oracle Receivables.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceEnabled"
                ]
            },
            "x-queryable":true
        },
        "Returnable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether we should allow the customers to return the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetTrackedFlag":{
            "type":"boolean",
            "description":"Indicates whether an item is tracked as an asset in installed base.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssetTracked"
                ]
            },
            "x-queryable":true
        },
        "CoverageScheduleId":{
            "type":"integer",
            "description":"The template associated with the contract item type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShippableItemFlag":{
            "type":"boolean",
            "description":"Indicates whether to ship an item to a customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ShippableItem"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductType":{
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the sales product, such as Goods, Included Warranty, Extended arranty, Service Level Agreement, Training, or Subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VolumeUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The volume unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WIPSupplyType":{
            "type":"integer",
            "description":"The supply type for components.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalVolume":{
            "type":"number",
            "description":"The internal volume of the container or vehicle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceDurationPeriodCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The number indicating the service duration period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether to activate an item for invoicing in Oracle Receivables.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoSerialAlphaPrefix":{
            "maxLength":"80",
            "type":"string",
            "description":"The starting alphabet prefix for all serial numbers which are being defined for the Item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinancingAllowedFlag":{
            "type":"boolean",
            "description":"Indicates whether a customer can finance this item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FinancingAllowed"
                ]
            },
            "x-queryable":true
        },
        "UnitLength":{
            "type":"number",
            "description":"The length of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContainerItem":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether containers are used for shipping the items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VehicleItem":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether vehicles are used for shipping the items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowMaintenanceAsset":{
            "maxLength":"1",
            "type":"string",
            "description":"The maintainable asset configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingDays":{
            "type":"number",
            "description":"The lead time for the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceStartTypeCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The type of service start rule which should be used for a service item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Collateral":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the item is a collateral.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateItemFlag":{
            "type":"boolean",
            "description":"Indicates whether it???s a template. The value will be always true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TemplateItem"
                ]
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item organization associated with the item template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PickComponents":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetTracked":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an item is tracked as an asset in installed base.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the product. The accepted values are\nCOVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFlag":{
            "type":"boolean",
            "description":"Indicates whether the item is event.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Event"
                ]
            },
            "x-queryable":true
        },
        "DefaultTemplateFlag":{
            "type":"boolean",
            "description":"Indicates whether it???s a default item template of that organization under root item class.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DefaultTemplate"
                ]
            },
            "x-queryable":true
        },
        "ShippableItem":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether to ship an item to a customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitVolume":{
            "type":"number",
            "description":"The volume of one unit of item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateItem":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether it???s a template. The value will be always Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitWidth":{
            "type":"number",
            "description":"The width of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServReqEnabledCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the product is eligible for service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the product template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"The unique code of the sales product item organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ATPCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The ATP code to check if available to promise and/or capable to promise information, when placing demand.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowMaintenanceAssetFlag":{
            "type":"boolean",
            "description":"Indicates whether maintainable assets can be defined for the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AllowMaintenanceAsset"
                ]
            },
            "x-queryable":true
        },
        "StartAutoSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The starting number for all serial numbers for this item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerOrderFlag":{
            "type":"boolean",
            "description":"Indicates whether to allow an item to be ordered by external customers.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CustomerOrder"
                ]
            },
            "x-queryable":true
        },
        "DefaultTemplate":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether it???s a default item template of that organization under root item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishToOrder":{
            "maxLength":"1",
            "type":"string",
            "description":"The final assembly work order which is created based on sales order details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure for the dimension of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EquipmentTypeFlag":{
            "type":"boolean",
            "description":"Indicates whether the item is equipment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EquipmentType"
                ]
            },
            "x-queryable":true
        },
        "ProdTmplMappingCode":{
            "maxLength":"300",
            "type":"string",
            "description":"The unique identifer of product template mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumLoadWeight":{
            "type":"number",
            "description":"The maximum load weight of the container or vehicle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleToSell":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the item can be sold or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowSuspendFlag":{
            "type":"boolean",
            "description":"Indicates whether a service can be suspended.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AllowSuspend"
                ]
            },
            "x-queryable":true
        },
        "CSSEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowSuspend":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a service can be suspended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCatalogGroupId":{
            "type":"integer",
            "description":"The unique identifier of the catalog group that the product belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ServiceDurationTypeCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The type of duration applicable for a service item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishToOrderFlag":{
            "type":"boolean",
            "description":"Indicates if the final assembly work order is to be created based on sales order details.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ReplenishToOrder"
                ]
            },
            "x-queryable":true
        },
        "ContainerTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code that specifies the type of the container.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemStatusCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The predefined code that indicates the status of the product. The default value is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceStartDelay":{
            "type":"number",
            "description":"The attribute specifying the delay in starting a service after a milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceableItem":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether to include an item on an Oracle Receivables invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollateralFlag":{
            "type":"boolean",
            "description":"Indicates whether the item is a collateral.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Collateral"
                ]
            },
            "x-queryable":true
        },
        "VehicleItemFlag":{
            "type":"boolean",
            "description":"Indicates whether vehicles are used for shipping the items.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "VehicleItem"
                ]
            },
            "x-queryable":true
        },
        "DefaultUOM":{
            "type":"string",
            "description":"The default unit of measure (UOM) for the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceDuration":{
            "type":"number",
            "description":"The number indicating the service duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Event":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the item is event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CSSEnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CSSEnabled"
                ]
            },
            "x-queryable":true
        },
        "ReturnableFlag":{
            "type":"boolean",
            "description":"Indicates whether to allow customers to return an item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Returnable"
                ]
            },
            "x-queryable":true
        },
        "UnitHeight":{
            "type":"number",
            "description":"The height of the item.",
            "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."
        }
    }
}

Back to Top