Jump to

• Request
• Response
• Examples

Update a product

patch

/crmRestApi/resources/11.13.18.05/products/{InventoryItemId}

Request

Path Parameters

• InventoryItemId(required): integer(int64)
  The unique identifier of the inventory item. This value is generated when the product is created.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowMaintenanceAssetFlag: boolean
  Title: Enable Asset Maintenance

  Maximum Length: 1

  Indicates whether maintainable assets can be defined for the item.
• AllowSuspendFlag: boolean
  Title: Allow Suspend

  Maximum Length: 1

  Indicates whether a service can be suspended.
• AllowTerminateFlag: boolean
  Title: Allow Terminate

  Maximum Length: 1

  Indicates whether a service can be terminated.
• AssetTrackedFlag: boolean
  Title: Enable Asset Tracking

  Maximum Length: 1

  Indicates whether an item is tracked as an asset in installed base.
• ATPCode: string
  Title: Check ATP

  Maximum Length: 1

  Check available to promise and/or capable to promise information when placing demand.
• ATPComponentsCode: string
  Title: ATP Components

  Maximum Length: 1

  Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
• AttachmentEntityName: string
  Default Value: ITEM_ENTITY

  The name of the attachment entity.
• AutoSerialAlphaPrefix: string
  Title: Starting Serial Prefix

  Maximum Length: 80

  The starting alphabet prefix for all serial numbers which are being defined for the Item.
• BOMItemType: string
  Title: Structure Item Type

  Maximum Length: 30

  The type of bill of material the item can possess such as standard, model, planning, and other.
• CollateralFlag: boolean
  Title: Collateral

  Maximum Length: 1

  Indicates whether the item is a collateral.
• ConfigurableFlag: boolean
  Title: Configurable

  Maximum Length: 1

  Identifies whether the product is configurable at the time of quoting.
• ContainerItemFlag: boolean
  Title: Container

  Maximum Length: 1

  Indicates whether containers are used for Shipping the items.
• ContainerTypeCode: string
  Title: Container Type

  Maximum Length: 30

  Attribute indicating the type of the Container.
• CoverageName: string
  Title: Standard Coverage

  Maximum Length: 150

  The name of template associated with the contract item type.
• CoverageScheduleId: integer (int64)
  Title: Coverage Schedule ID

  The template associated with the contract item type.
• CSSEnabled: string
  Title: Enable Customer Self-Service

  Maximum Length: 1

  Default Value: N

  Indicates if the product is enabled for customer self-service. The default value is No.
• CustomerOrderFlag: boolean
  Title: Customer Ordered

  Maximum Length: 1

  Indicates whether to allow an item to be ordered by external customers.
• CxAssetTrackedFlag: boolean
  Title: Enable Customer Asset Tracking

  Maximum Length: 1

  Default Value: false

  Indicates whether the products set to "Y" are to be displayed as customer owned assets.
• DefaultPeriodicity: string
  Title: Default Periodicity

  Maximum Length: 80

  The default price periodicity such as monthly, for the product.
• DefaultPeriodicityCode: string
  Title: Default Periodicity Code

  Maximum Length: 30

  The default price periodicity code such as monthly, for the product.
• DefaultPeriods: integer (int32)
  Title: Default Periods

  The default number of price periods for the product.
• DefaultPrices: array Default Prices
  Title: Default Prices

  The default prices resource is used to view, create, update, and delete default prices for products.
• DefaultPriceType: string
  Title: Default Price Type

  Maximum Length: 80

  Identifies the default price type for the product, such as one-time or recurring.
• DefaultPriceTypeCode: string
  Title: Default Price Type Code

  Maximum Length: 30

  Identifies the default price type code for the product, such as one-time or recurring.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description of the product.
• DimensionUOMCode: string
  Title: Dimension Unit of Measure

  Maximum Length: 3

  The unit of measure for the dimension of the item.
• EligibilityCompatibilityRuleFlag: boolean
  Title: Eligibility Rule

  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.
• EligibleForService: string
  Title: Eligible for Service

  Default Value: Y

  Indicates whether the product is eligible for service.
• EligibleToSell: string
  Title: Meaning

  Maximum Length: 80

  Indicates whether the product is eligible to be sold.
• EligibleToSellFlag: boolean
  Title: Eligible to Sell

  Maximum Length: 1

  Default Value: true

  Indicates whether the item can be sold or not.
• EquipmentTypeFlag: boolean
  Title: Warehouse Equipment

  Maximum Length: 30

  Indicates whether the item is equipment.
• EventFlag: boolean
  Title: Event

  Maximum Length: 1

  Indicates whether the item is event.
• ExtendedDescriptionOne: string (byte)
  Title: Extended Description 1

  The first additional description of the product.
• ExtendedDescriptionTwo: string (byte)
  Title: Extended Description 2

  The second additional description of the product.
• FinancingAllowedFlag: boolean
  Title: Financing Allowed

  Maximum Length: 1

  Indicates whether a customer can finance this item.
• InternalVolume: number
  Title: Internal Volume

  The internal volume of the container or vehicle.
• InvoiceableItemFlag: boolean
  Title: Invoiced

  Maximum Length: 1

  Indicates whether to include an item on an Oracle Receivables invoice.
• InvoiceEnabledFlag: boolean
  Title: Invoice Enabled

  Maximum Length: 1

  Indicates whether to activate an item for invoicing in Oracle Receivables.
• ItemType: string
  Title: User Item Type

  Maximum Length: 30

  Indicator or classification for an item, such as finished or purchased.
• MaximumLoadWeight: number
  Title: Maximum Load Weight

  The maximum load weight of the container or vehicle.
• MinimumFillPercent: number
  Title: Minimum Fill Percent

  The minimum fill of the container or vehicle to be used.
• ModelConfigAttributes: string
  Title: Model Attributes

  Maximum Length: 4000

  The model configuration of the product.
• ModelFamily: string
  Title: Model Family

  Maximum Length: 1000

  The name of the model family associated with the Product Group.
• ModelLine: string
  Title: Model Line

  Maximum Length: 1000

  The name of the model line associated with the Product Group.
• ModelName: string
  Title: Model

  Maximum Length: 1000

  The name of the model.
• Name: string
  Title: Name

  Maximum Length: 240

  The name of the inventory item generated during product creation.
• PickComponentsFlag: boolean
  Title: Pick Components

  Maximum Length: 1

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

  The lead time for the order.
• ProductAttachments: array Product Attachments
  Title: Product Attachments

  The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.
• ProductImageAttachments: array Product Image Attachments
  Title: Product Image Attachments

  The attachment resource is used to view, create, and update image attachments of a product.
• ProductLaunchFlag: boolean
  Title: Product Launch Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the product is ready to be sold.
• ProductStatusCode: string
  Title: Launch Status

  Maximum Length: 30

  Default Value: ORA_CREATED

  The statuses to track product launch.
• ProductTranslations: array Product Translations
  Title: Product Translations

  The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.
• ProductType: string
  Title: Sales Product Type

  Maximum Length: 80

  The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription.
• ProductTypeCode: string
  Title: Sales Product Type Code

  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.
• ReplenishToOrderFlag: boolean
  Title: Assemble to Order

  Maximum Length: 1

  The final assembly work order which is created based on sales order details.
• ReturnableFlag: boolean
  Title: Returnable

  Maximum Length: 1

  Indicates whether to allow customers to return an item.
• SalesProductLookupType: object SalesProductLookupType
  The lookup type for the sales product type.
• SerialNumberControlCode: string
  Title: Serial Number Control

  Maximum Length: 30

  The number assigned to each unit of an item and used to track the item.
• ServiceDuration: number
  Title: Service Duration

  The number to indicate the service duration.
• ServiceDurationPeriodCode: string
  Title: Service Duration Period

  Maximum Length: 10

  The number to indicate the service duration period.
• ServiceDurationTypeCode: string
  Title: Service Duration Type

  Maximum Length: 3

  The type of duration applicable for a service item.
• ServiceStartDelay: number
  Title: Service Start Delay

  The attribute specifying the delay in starting a service after a milestone.
• ServiceStartTypeCode: string
  Title: Service Start Type

  Maximum Length: 3

  The type of service start rule which should be used for a service item.
• ShippableItemFlag: boolean
  Title: Shippable

  Maximum Length: 1

  Indicates whether to ship an item to a customer.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• StartAutoSerialNumber: string
  Title: Starting Serial Number

  Maximum Length: 80

  The starting number for all serial numbers for this item.
• UnitHeight: number
  Title: Height

  The height of the item.
• UnitLength: number
  Title: Length

  The length of the item.
• UnitVolume: number
  Title: Unit Volume

  The volume of one unit of item.
• UnitWeight: number
  Title: Unit Weight

  The weight of one unit of item.
• UnitWidth: number
  Title: Width

  The width of the item.
• VehicleItemFlag: boolean
  Title: Vehicle

  Maximum Length: 1

  Indicates whether vehicles are used for shipping the items.
• VolumeUOMCode: string
  Title: Volume Unit of Measure

  Maximum Length: 3

  The volume unit of measure.
• WeightUOMCode: string
  Title: Weight Unit of Measure

  Maximum Length: 3

  The weight unit of measure.
• WIPSupplyType: integer (int64)
  Title: Supply Type

  The supply type for components.

{
    "type":"object",
    "properties":{
        "MinimumFillPercent":{
            "title":"Minimum Fill Percent",
            "type":"number",
            "description":"The minimum fill of the container or vehicle to be used.",
            "nullable":true
        },
        "WeightUOMCode":{
            "title":"Weight Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The weight unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPriceType":{
            "title":"Default Price Type",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the default price type for the product, such as one-time or recurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceableItemFlag":{
            "title":"Invoiced",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to include an item on an Oracle Receivables invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ATPComponentsCode":{
            "title":"ATP Components",
            "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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemType":{
            "title":"User Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicator or classification for an item, such as finished or purchased.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExtendedDescriptionOne":{
            "title":"Extended Description 1",
            "type":"string",
            "description":"The first additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ModelLine":{
            "title":"Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model line associated with the Product Group.",
            "nullable":true
        },
        "DefaultPeriodicity":{
            "title":"Default Periodicity",
            "maxLength":"80",
            "type":"string",
            "description":"The default price periodicity such as monthly, for the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EligibilityCompatibilityRuleFlag":{
            "title":"Eligibility Rule",
            "maxLength":"1",
            "type":"boolean",
            "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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SerialNumberControlCode":{
            "title":"Serial Number Control",
            "maxLength":"30",
            "type":"string",
            "description":"The number assigned to each unit of an item and used to track the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductLaunchFlag":{
            "title":"Product Launch Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the product is ready to be sold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "EligibleToSellFlag":{
            "title":"Eligible to Sell",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item can be sold or not.",
            "nullable":true,
            "default":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the inventory item generated during product creation.",
            "nullable":false
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-item-patch-request"
            }
        },
        "BOMItemType":{
            "title":"Structure Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of bill of material the item can possess such as standard, model, planning, and other.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UnitWeight":{
            "title":"Unit Weight",
            "type":"number",
            "description":"The weight of one unit of item.",
            "nullable":true
        },
        "DefaultPeriodicityCode":{
            "title":"Default Periodicity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The default price periodicity code such as monthly, for the product.",
            "nullable":true
        },
        "AllowTerminateFlag":{
            "title":"Allow Terminate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a service can be terminated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContainerItemFlag":{
            "title":"Container",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether containers are used for Shipping the items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PickComponentsFlag":{
            "title":"Pick Components",
            "maxLength":"1",
            "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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ModelFamily":{
            "title":"Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model family associated with the Product Group.",
            "nullable":true
        },
        "InvoiceEnabledFlag":{
            "title":"Invoice Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to activate an item for invoicing in Oracle Receivables.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPrices":{
            "title":"Default Prices",
            "type":"array",
            "description":"The default prices resource is used to view, create, update, and delete default prices for products.",
            "items":{
                "$ref":"#/components/schemas/products-DefaultPrices-item-patch-request"
            }
        },
        "AssetTrackedFlag":{
            "title":"Enable Asset Tracking",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an item is tracked as an asset in installed base.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ModelName":{
            "title":"Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model.",
            "nullable":true
        },
        "CoverageScheduleId":{
            "title":"Coverage Schedule ID",
            "type":"integer",
            "description":"The template associated with the contract item type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShippableItemFlag":{
            "title":"Shippable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to ship an item to a customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductType":{
            "title":"Sales Product Type",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VolumeUOMCode":{
            "title":"Volume Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The volume unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WIPSupplyType":{
            "title":"Supply Type",
            "type":"integer",
            "description":"The supply type for components.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "InternalVolume":{
            "title":"Internal Volume",
            "type":"number",
            "description":"The internal volume of the container or vehicle.",
            "nullable":true
        },
        "ServiceDurationPeriodCode":{
            "title":"Service Duration Period",
            "maxLength":"10",
            "type":"string",
            "description":"The number to indicate the service duration period.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProductStatusCode":{
            "title":"Launch Status",
            "maxLength":"30",
            "type":"string",
            "description":"The statuses to track product launch.",
            "nullable":true,
            "default":"ORA_CREATED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPeriods":{
            "title":"Default Periods",
            "type":"integer",
            "description":"The default number of price periods for the product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "SalesProductLookupType":{
            "type":"object",
            "description":"The lookup type for the sales product type.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoSerialAlphaPrefix":{
            "title":"Starting Serial Prefix",
            "maxLength":"80",
            "type":"string",
            "description":"The starting alphabet prefix for all serial numbers which are being defined for the Item.",
            "nullable":true
        },
        "FinancingAllowedFlag":{
            "title":"Financing Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a customer can finance this item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPriceTypeCode":{
            "title":"Default Price Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the default price type code for the product, such as one-time or recurring.",
            "nullable":true
        },
        "UnitLength":{
            "title":"Length",
            "type":"number",
            "description":"The length of the item.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the product.",
            "nullable":true
        },
        "ModelConfigAttributes":{
            "title":"Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configuration of the product.",
            "nullable":true
        },
        "ProcessingDays":{
            "title":"Processing Days",
            "type":"number",
            "description":"The lead time for the order.",
            "nullable":true
        },
        "ConfigurableFlag":{
            "title":"Configurable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies whether the product is configurable at the time of quoting.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CoverageName":{
            "title":"Standard Coverage",
            "maxLength":"150",
            "type":"string",
            "description":"The name of template associated with the contract item type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ServiceStartTypeCode":{
            "title":"Service Start Type",
            "maxLength":"3",
            "type":"string",
            "description":"The type of service start rule which should be used for a service item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductTypeCode":{
            "title":"Sales Product Type Code",
            "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
        },
        "EventFlag":{
            "title":"Event",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item is event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductTranslations":{
            "title":"Product Translations",
            "type":"array",
            "description":"The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductTranslations-item-patch-request"
            }
        },
        "UnitVolume":{
            "title":"Unit Volume",
            "type":"number",
            "description":"The volume of one unit of item.",
            "nullable":true
        },
        "ProductImageAttachments":{
            "title":"Product Image Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update image attachments of a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductImageAttachments-item-patch-request"
            }
        },
        "UnitWidth":{
            "title":"Width",
            "type":"number",
            "description":"The width of the item.",
            "nullable":true
        },
        "ATPCode":{
            "title":"Check ATP",
            "maxLength":"1",
            "type":"string",
            "description":"Check available to promise and/or capable to promise information when placing demand.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowMaintenanceAssetFlag":{
            "title":"Enable Asset Maintenance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether maintainable assets can be defined for the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerOrderFlag":{
            "title":"Customer Ordered",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to allow an item to be ordered by external customers.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartAutoSerialNumber":{
            "title":"Starting Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The starting number for all serial numbers for this item.",
            "nullable":true
        },
        "ExtendedDescriptionTwo":{
            "title":"Extended Description 2",
            "type":"string",
            "description":"The second additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DimensionUOMCode":{
            "title":"Dimension Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure for the dimension of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EligibleForService":{
            "title":"Eligible for Service",
            "type":"string",
            "description":"Indicates whether the product is eligible for service.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "EquipmentTypeFlag":{
            "title":"Warehouse Equipment",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the item is equipment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaximumLoadWeight":{
            "title":"Maximum Load Weight",
            "type":"number",
            "description":"The maximum load weight of the container or vehicle.",
            "nullable":true
        },
        "CxAssetTrackedFlag":{
            "title":"Enable Customer Asset Tracking",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the products set to \"Y\" are to be displayed as customer owned assets.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "EligibleToSell":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the product is eligible to be sold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowSuspendFlag":{
            "title":"Allow Suspend",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a service can be suspended.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CSSEnabled":{
            "title":"Enable Customer Self-Service",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "default":"N"
        },
        "ServiceDurationTypeCode":{
            "title":"Service Duration Type",
            "maxLength":"3",
            "type":"string",
            "description":"The type of duration applicable for a service item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplenishToOrderFlag":{
            "title":"Assemble to Order",
            "maxLength":"1",
            "type":"boolean",
            "description":"The final assembly work order which is created based on sales order details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContainerTypeCode":{
            "title":"Container Type",
            "maxLength":"30",
            "type":"string",
            "description":"Attribute indicating the type of the Container.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ServiceStartDelay":{
            "title":"Service Start Delay",
            "type":"number",
            "description":"The attribute specifying the delay in starting a service after a milestone.",
            "nullable":true
        },
        "ProductAttachments":{
            "title":"Product Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductAttachments-item-patch-request"
            }
        },
        "CollateralFlag":{
            "title":"Collateral",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item is a collateral.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VehicleItemFlag":{
            "title":"Vehicle",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether vehicles are used for shipping the items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ServiceDuration":{
            "title":"Service Duration",
            "type":"number",
            "description":"The number to indicate the service duration.",
            "nullable":true
        },
        "ReturnableFlag":{
            "title":"Returnable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to allow customers to return an item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"ITEM_ENTITY"
        },
        "UnitHeight":{
            "title":"Height",
            "type":"number",
            "description":"The height of the item.",
            "nullable":true
        }
    }
}

Nested Schema : Default Prices

Type: array

Title: Default Prices

The default prices resource is used to view, create, update, and delete default prices for products.

Show Source

• Array of: object products-DefaultPrices-item-patch-request

{
    "title":"Default Prices",
    "type":"array",
    "description":"The default prices resource is used to view, create, update, and delete default prices for products.",
    "items":{
        "$ref":"#/components/schemas/products-DefaultPrices-item-patch-request"
    }
}

Nested Schema : Product Attachments

Type: array

Title: Product Attachments

The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.

Show Source

• Array of: object schema

{
    "title":"Product Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductAttachments-item-patch-request"
    }
}

Nested Schema : Product Image Attachments

Type: array

Title: Product Image Attachments

The attachment resource is used to view, create, and update image attachments of a product.

Show Source

• Array of: object products-ProductImageAttachments-item-patch-request

{
    "title":"Product Image Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update image attachments of a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductImageAttachments-item-patch-request"
    }
}

Nested Schema : Product Translations

Type: array

Title: Product Translations

The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.

Show Source

• Array of: object products-ProductTranslations-item-patch-request

{
    "title":"Product Translations",
    "type":"array",
    "description":"The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductTranslations-item-patch-request"
    }
}

Nested Schema : SalesProductLookupType

Type: object

The lookup type for the sales product type.

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object products-smartActions-item-patch-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-item-patch-request"
    }
}

Nested Schema : products-DefaultPrices-item-patch-request

Type: object

Show Source

• ListPrice: number
  Title: List Price

  Default Value: 0

  The List Price for the combination of product, currency and UOM.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement code of the default price.

{
    "type":"object",
    "properties":{
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The List Price for the combination of product, currency and UOM.",
            "nullable":true,
            "default":"0"
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement code of the default price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. For example, a file or a web page.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. For example, a file or a web page.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : products-ProductImageAttachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. For example, a file or a web page.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. For example, a file or a web page.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : products-ProductTranslations-item-patch-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 4000

  The long description of the product.
• ExtendedDescriptionOne: string (byte)
  Title: Extended Description 1

  The first additional description of the product.
• ExtendedDescriptionTwo: string (byte)
  Title: Extended Description 2

  The second additional description of the product.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the inventory item. This value is generated when the product is created.
• Language: string
  Maximum Length: 4

  The translated language for the translation record.
• Name: string
  Title: Name

  Maximum Length: 240

  The description of the product.
• OrganizationId: integer (int64)
  Title: Organization ID

  The unique identifier of the inventory organization associated with the product.
• SourceLang: string
  Maximum Length: 4

  The source language for the translation record.

{
    "type":"object",
    "properties":{
        "ExtendedDescriptionTwo":{
            "title":"Extended Description 2",
            "type":"string",
            "description":"The second additional description of the product.",
            "format":"byte",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The long description of the product.",
            "nullable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"The translated language for the translation record.",
            "nullable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item. This value is generated when the product is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"The source language for the translation record.",
            "nullable":false
        },
        "ExtendedDescriptionOne":{
            "title":"Extended Description 1",
            "type":"string",
            "description":"The first additional description of the product.",
            "format":"byte",
            "nullable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product.",
            "nullable":true
        }
    }
}

Nested Schema : products-smartActions-item-patch-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object products-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionNavigation-item-patch-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object schema

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object schema

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionURLBinding-item-patch-request"
    }
}

Nested Schema : products-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "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 : products-item-response

Type: object

Show Source

• AllowMaintenanceAssetFlag: boolean
  Title: Enable Asset Maintenance

  Maximum Length: 1

  Indicates whether maintainable assets can be defined for the item.
• AllowSuspendFlag: boolean
  Title: Allow Suspend

  Maximum Length: 1

  Indicates whether a service can be suspended.
• AllowTerminateFlag: boolean
  Title: Allow Terminate

  Maximum Length: 1

  Indicates whether a service can be terminated.
• ApprovalStatus: string
  Title: Approval Status

  Read Only: true

  Maximum Length: 30

  The approval status of the item.
• AssetTrackedFlag: boolean
  Title: Enable Asset Tracking

  Maximum Length: 1

  Indicates whether an item is tracked as an asset in installed base.
• ATPCode: string
  Title: Check ATP

  Maximum Length: 1

  Check available to promise and/or capable to promise information when placing demand.
• ATPComponentsCode: string
  Title: ATP Components

  Maximum Length: 1

  Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
• AttachmentEntityName: string
  Default Value: ITEM_ENTITY

  The name of the attachment entity.
• AutoSerialAlphaPrefix: string
  Title: Starting Serial Prefix

  Maximum Length: 80

  The starting alphabet prefix for all serial numbers which are being defined for the Item.
• BOMItemType: string
  Title: Structure Item Type

  Maximum Length: 30

  The type of bill of material the item can possess such as standard, model, planning, and other.
• CollateralFlag: boolean
  Title: Collateral

  Maximum Length: 1

  Indicates whether the item is a collateral.
• ConfigurableFlag: boolean
  Title: Configurable

  Maximum Length: 1

  Identifies whether the product is configurable at the time of quoting.
• ContainerItemFlag: boolean
  Title: Container

  Maximum Length: 1

  Indicates whether containers are used for Shipping the items.
• ContainerTypeCode: string
  Title: Container Type

  Maximum Length: 30

  Attribute indicating the type of the Container.
• CoverageName: string
  Title: Standard Coverage

  Maximum Length: 150

  The name of template associated with the contract item type.
• CoverageScheduleId: integer (int64)
  Title: Coverage Schedule ID

  The template associated with the contract item type.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the product record was created.
• CSSEnabled: string
  Title: Enable Customer Self-Service

  Maximum Length: 1

  Default Value: N

  Indicates if the product is enabled for customer self-service. The default value is No.
• CustomerOrderFlag: boolean
  Title: Customer Ordered

  Maximum Length: 1

  Indicates whether to allow an item to be ordered by external customers.
• CxAssetTrackedFlag: boolean
  Title: Enable Customer Asset Tracking

  Maximum Length: 1

  Default Value: false

  Indicates whether the products set to "Y" are to be displayed as customer owned assets.
• DefaultPeriodicity: string
  Title: Default Periodicity

  Maximum Length: 80

  The default price periodicity such as monthly, for the product.
• DefaultPeriodicityCode: string
  Title: Default Periodicity Code

  Maximum Length: 30

  The default price periodicity code such as monthly, for the product.
• DefaultPeriods: integer (int32)
  Title: Default Periods

  The default number of price periods for the product.
• DefaultPrices: array Default Prices
  Title: Default Prices

  The default prices resource is used to view, create, update, and delete default prices for products.
• DefaultPriceType: string
  Title: Default Price Type

  Maximum Length: 80

  Identifies the default price type for the product, such as one-time or recurring.
• DefaultPriceTypeCode: string
  Title: Default Price Type Code

  Maximum Length: 30

  Identifies the default price type code for the product, such as one-time or recurring.
• DefaultUOM: string
  Title: Default UOM

  Maximum Length: 25

  The default unit of measure (UOM) for the product.
• DefaultUOMCode: string
  Title: Default UOM Code

  Maximum Length: 3

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

  Indicates whether the product can be deleted. The default value is false.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description of the product.
• DimensionUOMCode: string
  Title: Dimension Unit of Measure

  Maximum Length: 3

  The unit of measure for the dimension of the item.
• EligibilityCompatibilityRuleFlag: boolean
  Title: Eligibility Rule

  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.
• EligibleForService: string
  Title: Eligible for Service

  Default Value: Y

  Indicates whether the product is eligible for service.
• EligibleToSell: string
  Title: Meaning

  Maximum Length: 80

  Indicates whether the product is eligible to be sold.
• EligibleToSellFlag: boolean
  Title: Eligible to Sell

  Maximum Length: 1

  Default Value: true

  Indicates whether the item can be sold or not.
• EquipmentTypeFlag: boolean
  Title: Warehouse Equipment

  Maximum Length: 30

  Indicates whether the item is equipment.
• EventFlag: boolean
  Title: Event

  Maximum Length: 1

  Indicates whether the item is event.
• ExtendedDescriptionOne: string (byte)
  Title: Extended Description 1

  The first additional description of the product.
• ExtendedDescriptionTwo: string (byte)
  Title: Extended Description 2

  The second additional description of the product.
• FinancingAllowedFlag: boolean
  Title: Financing Allowed

  Maximum Length: 1

  Indicates whether a customer can finance this item.
• InternalVolume: number
  Title: Internal Volume

  The internal volume of the container or vehicle.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the inventory item. This value is generated when the product is created.
• InventoryItemStatusCode: string
  Title: Product Status Code

  Maximum Length: 10

  Default Value: Active

  The predefined code that indicates the status of the product. The default value is active.
• InvoiceableItemFlag: boolean
  Title: Invoiced

  Maximum Length: 1

  Indicates whether to include an item on an Oracle Receivables invoice.
• InvoiceEnabledFlag: boolean
  Title: Invoice Enabled

  Maximum Length: 1

  Indicates whether to activate an item for invoicing in Oracle Receivables.
• InvOrgId: integer (int64)
  Title: Inventory Organization ID

  Read Only: true

  The unique identifier of the inventory organization.
• ItemCatalogGroupId: integer (int64)
  Title: Item Catalog Group ID

  The unique identifier of the catalog group that the product belongs to.
• ItemNumber: string
  Title: Product Number

  Maximum Length: 300

  The unique alternate identifier of the product.
• ItemType: string
  Title: User Item Type

  Maximum Length: 30

  Indicator or classification for an item, such as finished or purchased.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MaximumLoadWeight: number
  Title: Maximum Load Weight

  The maximum load weight of the container or vehicle.
• MinimumFillPercent: number
  Title: Minimum Fill Percent

  The minimum fill of the container or vehicle to be used.
• ModelConfigAttributes: string
  Title: Model Attributes

  Maximum Length: 4000

  The model configuration of the product.
• ModelFamily: string
  Title: Model Family

  Maximum Length: 1000

  The name of the model family associated with the Product Group.
• ModelLine: string
  Title: Model Line

  Maximum Length: 1000

  The name of the model line associated with the Product Group.
• ModelName: string
  Title: Model

  Maximum Length: 1000

  The name of the model.
• Name: string
  Title: Name

  Maximum Length: 240

  The name of the inventory item generated during product creation.
• OrganizationCode: string
  Title: Organization Code

  Read Only: true

  Maximum Length: 18

  The code that uniquely identifies the organization. This value is derived from the ItemOrganizationId.
• OrganizationId: integer (int64)
  Title: Organization ID

  The unique identifier of the inventory organization associated with the product.
• PickComponentsFlag: boolean
  Title: Pick Components

  Maximum Length: 1

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

  The lead time for the order.
• ProductAttachments: array Product Attachments
  Title: Product Attachments

  The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.
• ProductImageAttachments: array Product Image Attachments
  Title: Product Image Attachments

  The attachment resource is used to view, create, and update image attachments of a product.
• ProductLaunchFlag: boolean
  Title: Product Launch Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the product is ready to be sold.
• ProductStatusCode: string
  Title: Launch Status

  Maximum Length: 30

  Default Value: ORA_CREATED

  The statuses to track product launch.
• ProductTranslations: array Product Translations
  Title: Product Translations

  The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.
• ProductType: string
  Title: Sales Product Type

  Maximum Length: 80

  The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription.
• ProductTypeCode: string
  Title: Sales Product Type Code

  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.
• ReplenishToOrderFlag: boolean
  Title: Assemble to Order

  Maximum Length: 1

  The final assembly work order which is created based on sales order details.
• ReturnableFlag: boolean
  Title: Returnable

  Maximum Length: 1

  Indicates whether to allow customers to return an item.
• SalesProductLookupType: object SalesProductLookupType
  The lookup type for the sales product type.
• SerialNumberControlCode: string
  Title: Serial Number Control

  Maximum Length: 30

  The number assigned to each unit of an item and used to track the item.
• ServiceDuration: number
  Title: Service Duration

  The number to indicate the service duration.
• ServiceDurationPeriodCode: string
  Title: Service Duration Period

  Maximum Length: 10

  The number to indicate the service duration period.
• ServiceDurationTypeCode: string
  Title: Service Duration Type

  Maximum Length: 3

  The type of duration applicable for a service item.
• ServiceStartDelay: number
  Title: Service Start Delay

  The attribute specifying the delay in starting a service after a milestone.
• ServiceStartTypeCode: string
  Title: Service Start Type

  Maximum Length: 3

  The type of service start rule which should be used for a service item.
• ShippableItemFlag: boolean
  Title: Shippable

  Maximum Length: 1

  Indicates whether to ship an item to a customer.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• StartAutoSerialNumber: string
  Title: Starting Serial Number

  Maximum Length: 80

  The starting number for all serial numbers for this item.
• TemplateName: string
  Title: Product Template

  Maximum Length: 960

  The name of the template.
• UnitHeight: number
  Title: Height

  The height of the item.
• UnitLength: number
  Title: Length

  The length of the item.
• UnitVolume: number
  Title: Unit Volume

  The volume of one unit of item.
• UnitWeight: number
  Title: Unit Weight

  The weight of one unit of item.
• UnitWidth: number
  Title: Width

  The width of the item.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the product can be updated. The default value is true.
• VehicleItemFlag: boolean
  Title: Vehicle

  Maximum Length: 1

  Indicates whether vehicles are used for shipping the items.
• VolumeUOMCode: string
  Title: Volume Unit of Measure

  Maximum Length: 3

  The volume unit of measure.
• WeightUOMCode: string
  Title: Weight Unit of Measure

  Maximum Length: 3

  The weight unit of measure.
• WIPSupplyType: integer (int64)
  Title: Supply Type

  The supply type for components.

{
    "type":"object",
    "properties":{
        "MinimumFillPercent":{
            "title":"Minimum Fill Percent",
            "type":"number",
            "description":"The minimum fill of the container or vehicle to be used.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the product record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WeightUOMCode":{
            "title":"Weight Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The weight unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPriceType":{
            "title":"Default Price Type",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the default price type for the product, such as one-time or recurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceableItemFlag":{
            "title":"Invoiced",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to include an item on an Oracle Receivables invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ATPComponentsCode":{
            "title":"ATP Components",
            "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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemType":{
            "title":"User Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicator or classification for an item, such as finished or purchased.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExtendedDescriptionOne":{
            "title":"Extended Description 1",
            "type":"string",
            "description":"The first additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ModelLine":{
            "title":"Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model line associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPeriodicity":{
            "title":"Default Periodicity",
            "maxLength":"80",
            "type":"string",
            "description":"The default price periodicity such as monthly, for the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibilityCompatibilityRuleFlag":{
            "title":"Eligibility Rule",
            "maxLength":"1",
            "type":"boolean",
            "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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "title":"Serial Number Control",
            "maxLength":"30",
            "type":"string",
            "description":"The number assigned to each unit of an item and used to track the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductLaunchFlag":{
            "title":"Product Launch Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the product is ready to be sold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ApprovalStatus":{
            "title":"Approval Status",
            "maxLength":"30",
            "type":"string",
            "description":"The approval status of the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibleToSellFlag":{
            "title":"Eligible to Sell",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item can be sold or not.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the inventory item generated during product creation.",
            "nullable":false,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-item-response"
            }
        },
        "BOMItemType":{
            "title":"Structure Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of bill of material the item can possess such as standard, model, planning, and other.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitWeight":{
            "title":"Unit Weight",
            "type":"number",
            "description":"The weight of one unit of item.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPeriodicityCode":{
            "title":"Default Periodicity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The default price periodicity code such as monthly, for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowTerminateFlag":{
            "title":"Allow Terminate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a service can be terminated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContainerItemFlag":{
            "title":"Container",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether containers are used for Shipping the items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PickComponentsFlag":{
            "title":"Pick Components",
            "maxLength":"1",
            "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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultUOMCode":{
            "title":"Default UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"The default unit of measure (UOM) code for the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ModelFamily":{
            "title":"Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model family associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceEnabledFlag":{
            "title":"Invoice Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to activate an item for invoicing in Oracle Receivables.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPrices":{
            "title":"Default Prices",
            "type":"array",
            "description":"The default prices resource is used to view, create, update, and delete default prices for products.",
            "items":{
                "$ref":"#/components/schemas/products-DefaultPrices-item-response"
            }
        },
        "AssetTrackedFlag":{
            "title":"Enable Asset Tracking",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an item is tracked as an asset in installed base.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelName":{
            "title":"Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageScheduleId":{
            "title":"Coverage Schedule ID",
            "type":"integer",
            "description":"The template associated with the contract item type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShippableItemFlag":{
            "title":"Shippable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to ship an item to a customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item. This value is generated when the product is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Sales Product Type",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VolumeUOMCode":{
            "title":"Volume Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The volume unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the product can be deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WIPSupplyType":{
            "title":"Supply Type",
            "type":"integer",
            "description":"The supply type for components.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalVolume":{
            "title":"Internal Volume",
            "type":"number",
            "description":"The internal volume of the container or vehicle.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceDurationPeriodCode":{
            "title":"Service Duration Period",
            "maxLength":"10",
            "type":"string",
            "description":"The number to indicate the service duration period.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProductStatusCode":{
            "title":"Launch Status",
            "maxLength":"30",
            "type":"string",
            "description":"The statuses to track product launch.",
            "nullable":true,
            "default":"ORA_CREATED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPeriods":{
            "title":"Default Periods",
            "type":"integer",
            "description":"The default number of price periods for the product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SalesProductLookupType":{
            "type":"object",
            "description":"The lookup type for the sales product type.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoSerialAlphaPrefix":{
            "title":"Starting Serial Prefix",
            "maxLength":"80",
            "type":"string",
            "description":"The starting alphabet prefix for all serial numbers which are being defined for the Item.",
            "nullable":true,
            "x-queryable":true
        },
        "FinancingAllowedFlag":{
            "title":"Financing Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a customer can finance this item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPriceTypeCode":{
            "title":"Default Price Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the default price type code for the product, such as one-time or recurring.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the product record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitLength":{
            "title":"Length",
            "type":"number",
            "description":"The length of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "title":"Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configuration of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingDays":{
            "title":"Processing Days",
            "type":"number",
            "description":"The lead time for the order.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigurableFlag":{
            "title":"Configurable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies whether the product is configurable at the time of quoting.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Standard Coverage",
            "maxLength":"150",
            "type":"string",
            "description":"The name of template associated with the contract item type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ServiceStartTypeCode":{
            "title":"Service Start Type",
            "maxLength":"3",
            "type":"string",
            "description":"The type of service start rule which should be used for a service item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductTypeCode":{
            "title":"Sales Product Type Code",
            "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,
            "x-queryable":true
        },
        "EventFlag":{
            "title":"Event",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item is event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the product can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductTranslations":{
            "title":"Product Translations",
            "type":"array",
            "description":"The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductTranslations-item-response"
            }
        },
        "UnitVolume":{
            "title":"Unit Volume",
            "type":"number",
            "description":"The volume of one unit of item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductImageAttachments":{
            "title":"Product Image Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update image attachments of a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductImageAttachments-item-response"
            }
        },
        "UnitWidth":{
            "title":"Width",
            "type":"number",
            "description":"The width of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"The code that uniquely identifies the organization. This value is derived from the ItemOrganizationId.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateName":{
            "title":"Product Template",
            "maxLength":"960",
            "type":"string",
            "description":"The name of the template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ATPCode":{
            "title":"Check ATP",
            "maxLength":"1",
            "type":"string",
            "description":"Check available to promise and/or capable to promise information when placing demand.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowMaintenanceAssetFlag":{
            "title":"Enable Asset Maintenance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether maintainable assets can be defined for the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CustomerOrderFlag":{
            "title":"Customer Ordered",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to allow an item to be ordered by external customers.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartAutoSerialNumber":{
            "title":"Starting Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The starting number for all serial numbers for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedDescriptionTwo":{
            "title":"Extended Description 2",
            "type":"string",
            "description":"The second additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DimensionUOMCode":{
            "title":"Dimension Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure for the dimension of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibleForService":{
            "title":"Eligible for Service",
            "type":"string",
            "description":"Indicates whether the product is eligible for service.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "EquipmentTypeFlag":{
            "title":"Warehouse Equipment",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the item is equipment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaximumLoadWeight":{
            "title":"Maximum Load Weight",
            "type":"number",
            "description":"The maximum load weight of the container or vehicle.",
            "nullable":true,
            "x-queryable":true
        },
        "CxAssetTrackedFlag":{
            "title":"Enable Customer Asset Tracking",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the products set to \"Y\" are to be displayed as customer owned assets.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "EligibleToSell":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the product is eligible to be sold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowSuspendFlag":{
            "title":"Allow Suspend",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a service can be suspended.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CSSEnabled":{
            "title":"Enable Customer Self-Service",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ItemCatalogGroupId":{
            "title":"Item Catalog Group ID",
            "type":"integer",
            "description":"The unique identifier of the catalog group that the product belongs to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ServiceDurationTypeCode":{
            "title":"Service Duration Type",
            "maxLength":"3",
            "type":"string",
            "description":"The type of duration applicable for a service item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplenishToOrderFlag":{
            "title":"Assemble to Order",
            "maxLength":"1",
            "type":"boolean",
            "description":"The final assembly work order which is created based on sales order details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContainerTypeCode":{
            "title":"Container Type",
            "maxLength":"30",
            "type":"string",
            "description":"Attribute indicating the type of the Container.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryItemStatusCode":{
            "title":"Product Status Code",
            "maxLength":"10",
            "type":"string",
            "description":"The predefined code that indicates the status of the product. The default value is active.",
            "nullable":true,
            "default":"Active",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ServiceStartDelay":{
            "title":"Service Start Delay",
            "type":"number",
            "description":"The attribute specifying the delay in starting a service after a milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductAttachments":{
            "title":"Product Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.",
            "items":{
                "$ref":"#/components/schemas/products-ProductAttachments-item-response"
            }
        },
        "CollateralFlag":{
            "title":"Collateral",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item is a collateral.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VehicleItemFlag":{
            "title":"Vehicle",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether vehicles are used for shipping the items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultUOM":{
            "title":"Default UOM",
            "maxLength":"25",
            "type":"string",
            "description":"The default unit of measure (UOM) for the product.",
            "nullable":false,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ServiceDuration":{
            "title":"Service Duration",
            "type":"number",
            "description":"The number to indicate the service duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnableFlag":{
            "title":"Returnable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to allow customers to return an item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"ITEM_ENTITY",
            "x-queryable":true
        },
        "UnitHeight":{
            "title":"Height",
            "type":"number",
            "description":"The height of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the product record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Default Prices

Type: array

Title: Default Prices

The default prices resource is used to view, create, update, and delete default prices for products.

Show Source

• Array of: object products-DefaultPrices-item-response

{
    "title":"Default Prices",
    "type":"array",
    "description":"The default prices resource is used to view, create, update, and delete default prices for products.",
    "items":{
        "$ref":"#/components/schemas/products-DefaultPrices-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 : Product Attachments

Type: array

Title: Product Attachments

The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.

Show Source

• Array of: object products-ProductAttachments-item-response

{
    "title":"Product Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductAttachments-item-response"
    }
}

Nested Schema : Product Image Attachments

Type: array

Title: Product Image Attachments

The attachment resource is used to view, create, and update image attachments of a product.

Show Source

• Array of: object products-ProductImageAttachments-item-response

{
    "title":"Product Image Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update image attachments of a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductImageAttachments-item-response"
    }
}

Nested Schema : Product Translations

Type: array

Title: Product Translations

The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.

Show Source

• Array of: object products-ProductTranslations-item-response

{
    "title":"Product Translations",
    "type":"array",
    "description":"The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.",
    "items":{
        "$ref":"#/components/schemas/products-ProductTranslations-item-response"
    }
}

Nested Schema : SalesProductLookupType

Type: object

The lookup type for the sales product type.

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object products-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-item-response"
    }
}

Nested Schema : products-DefaultPrices-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the default price was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The code for the Currency of the default price.
• DefaultPriceId: integer (int64)
  Read Only: true

  The unique identifier of the default price. This value is generated when the default price is created.
• InvItemId: integer (int64)
  Title: Inventory Item ID

  Read Only: true

  The unique identifier of the inventory item associated with the default price
• InvOrgId: integer (int64)
  Read Only: true

  The unique identifier of the inventory organization associated with the default price.
• ItemNumber: string
  Title: Product Number

  Maximum Length: 300

  The unique alternate identifier of the product.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the default price was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

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

  Default Value: 0

  The List Price for the combination of product, currency and UOM.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PricebookId: integer (int64)
  The unique identifier of the price book associated with the default price
• PriceBookName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the Price book associated with the Default Price.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement code of the default price.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the default price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the default price was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the default price.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the default price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the Price book associated with the Default Price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The List Price for the combination of product, currency and UOM.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "DefaultPriceId":{
            "type":"integer",
            "description":"The unique identifier of the default price. This value is generated when the default price is created.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code for the Currency of the default price.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement code of the default price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item associated with the default price",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the default price 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 default price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book associated with the default price",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : products-ProductAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached image document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the picture attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. For example, a file or a web page.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the picture attachment.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached image document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. For example, a file or a web page.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : products-ProductImageAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached image document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the picture attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. For example, a file or a web page.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the picture attachment.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached image document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. For example, a file or a web page.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : products-ProductTranslations-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the product record was created.
• Description: string
  Title: Description

  Maximum Length: 4000

  The long description of the product.
• ExtendedDescriptionOne: string (byte)
  Title: Extended Description 1

  The first additional description of the product.
• ExtendedDescriptionTwo: string (byte)
  Title: Extended Description 2

  The second additional description of the product.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the inventory item. This value is generated when the product is created.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  The unique alternate identifier of the product.
• Language: string
  Maximum Length: 4

  The translated language for the translation record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

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

  Maximum Length: 240

  The description of the product.
• OrganizationId: integer (int64)
  Title: Organization ID

  The unique identifier of the inventory organization associated with the product.
• SourceLang: string
  Maximum Length: 4

  The source language for the translation record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the product record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtendedDescriptionTwo":{
            "title":"Extended Description 2",
            "type":"string",
            "description":"The second additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The long description of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item. This value is generated when the product is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"The source language for the translation record.",
            "nullable":false,
            "x-queryable":true
        },
        "ExtendedDescriptionOne":{
            "title":"Extended Description 1",
            "type":"string",
            "description":"The first additional description of the product.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"The translated language for the translation record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the product record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the 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 : products-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/products-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object products-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object products-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object products-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/products-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : products-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "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 : products-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":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 : products-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

ApprovalStatusLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_APPROVAL_STATUS

The lookups resource is used to view standard lookup codes.

AssetTrackedFlagLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_EGP_ASSET_TRACKING

The lookups resource is used to view standard lookup codes.

AtpLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_ORDATPCHECKVS_TYPE

The lookups resource is used to view standard lookup codes.

BomItemTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_BOM_ITEM_TYPE

The lookups resource is used to view standard lookup codes.

ContainerTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DINV_CONTAINER_TYPE

The lookups resource is used to view standard lookup codes.

CoverageLovVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders

The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.

DefaultPeriodicityLookupLovVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DMOO_RECURRING_FREQUENCY

The lookups resource is used to view standard lookup codes.

DefaultPriceTypeLookupLovVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCA_SO_LINE_PRICE_TYPE

The lookups resource is used to view standard lookup codes.

DefaultPrices

Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices

Parameters:

• InventoryItemId: $request.path.InventoryItemId

The default prices resource is used to view, create, update, and delete default prices for products.

EligibleToSellLookupPVOLovVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

EquipmentTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_COMMON_YES_NO_NUM

The lookups resource is used to view standard lookup codes.

ItemStatusVA

Operation: /crmRestApi/resources/11.13.18.05/productStatuses

The product statuses resource is used to view all statuses that can be assigned to a product.

ItemTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_ITEM_TYPE

The lookups resource is used to view standard lookup codes.

ProductAttachments

Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments

Parameters:

• InventoryItemId: $request.path.InventoryItemId

The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.

ProductImageAttachments

Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments

Parameters:

• InventoryItemId: $request.path.InventoryItemId

The attachment resource is used to view, create, and update image attachments of a product.

ProductStatusLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PRODUCT_STATUS

The lookups resource is used to view standard lookup codes.

ProductTranslations

Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations

Parameters:

• InventoryItemId: $request.path.InventoryItemId

The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.

ProductTypeLovVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE

The lookups resource is used to view standard lookup codes.

SerialNumberControlLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERIAL_NUMBER_CONTROL_TYPE

The lookups resource is used to view standard lookup codes.

ServiceDurationPeriodLovVA

Operation: /crmRestApi/resources/11.13.18.05/productUnitOfMeasures

The Units of Measure resource gets the units of measure that an application, system, or service can use with the transaction.

ServiceDurationTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERV_DUR_TYPE_CODE

The lookups resource is used to view standard lookup codes.

ServiceStartTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERV_START_TYPE_CODE

The lookups resource is used to view standard lookup codes.

SpimTemplatesVO1

Operation: /crmRestApi/resources/11.13.18.05/mappedProductTemplates

The mapped product template resource is used to view the templates available to create a product.

UnitOfMeasureVVOLovVA

Operation: /crmRestApi/resources/11.13.18.05/productUnitOfMeasures

The Units of Measure resource gets the units of measure that an application, system, or service can use with the transaction.

WipSupplyTypeLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_WIP_SUP_TYPE

The lookups resource is used to view standard lookup codes.

YesNoLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_COMMON_YES_NO_CHAR

The lookups resource is used to view standard lookup codes.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions

Parameters:

• InventoryItemId: $request.path.InventoryItemId

This VO stores the endpoint and security details for every user action.

Back to Top

Examples

The following example shows how to update a product by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/products/300100072708232

Example of Request Body

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

{
 "Name": "Updated Test Product Name",
 "Description" : "Updated test Product Name REST long description REST"
}

Example of Response Body

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

{
 InventoryItemId: 300100072708232
 InventoryItemStatusCode: "Active"
 ItemCatalogGroupId: 100000011369001
 ItemNumber: "testItemRest120201"
 LastUpdateDate: "2015-11-13T02:46:03-08:00"
 LastUpdateLogin: "24697F5C75755F75E0535B50F00AE009"
 LastUpdatedBy: "SALES_ADMIN"
 Description: "Updated test Product Name REST long description REST"
 ObjectVersionNumber: 2
 OrganizationId: 204
 CreatedBy: "SALES_ADMIN"
 CreationDate: "2015-10-26T12:43:14-08:00"
 Name: "Updated Test Product Name"
 ...
}

Back to Top