Create a product relationship

post

/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/productRelationships

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products to get the hash key.
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    Value that indicates the type of the competitor trading partner item in the item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Cross Reference
    Maximum Length: 1020
    Value that uniquely identifies the cross-reference of an item.
  • Maximum Length: 255
    Value that indicates the type of cross-reference relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: End Date
    Date and time when the item relationship ends or is no longer active.
  • Title: EPC or GTIN Serial
    Value that uniquely identifies the electronic product code (EPC) or global trade item number (GTIN) identifier for the GTIN item relationship.
  • Title: Item
    Maximum Length: 820
    Name or number of the item from which the relationship is created.
  • Value that uniquely identifies the product relationship row in staging.
  • Title: Type
    Maximum Length: 30
    Value that indicates the type of trading partner item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Master Organization
    Maximum Length: 18
    Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Master Organization
    Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Default Organization
    Maximum Length: 18
    Abbreviation that identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Organization
    Value that uniquely identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Organization Independent
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item relationship is applicable across all organizations. If false, then the item relationship is not applicable across all organizations. This attribute does not have a default value.
  • Title: Planning Enabled
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then planning is enabled for related item. If false, then planning is not enabled for related item. This attribute does not have a default value.
  • Title: Rank
    Number that indicates the rank of the trading partner item relationship.
  • Title: Spoke Item
    Maximum Length: 255
    Name or number of the spoke part, item, product, or service.
  • Title: Reciprocal
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a reciprocal relationship exists in the item relationship. If false, then a reciprocal relationship does not exists in the item relationship. This attribute does not have a default value.
  • Rank of the related item relationship.
  • Title: Relationship Description
    Maximum Length: 200
    Description of the item relationship.
  • Maximum Length: 30
    Abbreviation that uniquely identifies the status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
  • Status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
  • Value that indicates the type of related item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Maximum Length: 255
    Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
  • Title: Spoke System ID
    Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
  • Title: Start Date
    Date and time when the item relationship begins or becomes active.
  • Title: Type
    Maximum Length: 100
    Abbreviation that identifies the party type of the GTIN in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Value that indicates the party type of the global trade item number (GTIN) in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
  • Title: Supplier
    Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
  • Title: To Item
    Maximum Length: 820
    Name or number of the item for which the relationship is created.
  • Title: Trading Partner Item
    Maximum Length: 150
    Name or number of the item from a trading partner.
  • Title: Trading Partner Number
    Maximum Length: 30
    Number that identifies the trading partner.
  • Value that identifies the product row in the staging interface.
  • Title: Transaction Type
    Maximum Length: 10
    Type of action to be taken when importing a record. Valid values include SYNC and DELETE.
  • Title: UOM
    Maximum Length: 72
    Unit of measure code of the global trade item number (GTIN) relationship.
  • Maximum Length: 255
    Unit of measure of the global trade item number (GTIN) relationship.
  • Title: UOM
    Maximum Length: 25
    Unit of measure name of the global trade item number (GTIN) relationship.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : supplierProducts-productRelationships-item-response
Type: object
Show Source
  • Maximum Length: 255
    Value that indicates the type of the competitor trading partner item in the item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Read Only: true
    Maximum Length: 64
    User who created the product relationship.
  • Read Only: true
    Date and time when the application created the product relationship.
  • Title: Cross Reference
    Maximum Length: 1020
    Value that uniquely identifies the cross-reference of an item.
  • Maximum Length: 255
    Value that indicates the type of cross-reference relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: End Date
    Date and time when the item relationship ends or is no longer active.
  • Title: EPC or GTIN Serial
    Value that uniquely identifies the electronic product code (EPC) or global trade item number (GTIN) identifier for the GTIN item relationship.
  • Title: Item
    Maximum Length: 820
    Name or number of the item from which the relationship is created.
  • Value that uniquely identifies the product relationship row in staging.
  • Title: Type
    Maximum Length: 30
    Value that indicates the type of trading partner item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Read Only: true
    Date and time when the product relationship was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the product relationship.
  • Links
  • Title: Master Organization
    Maximum Length: 18
    Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Master Organization
    Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Default Organization
    Maximum Length: 18
    Abbreviation that identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Organization
    Value that uniquely identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
  • Title: Organization Independent
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item relationship is applicable across all organizations. If false, then the item relationship is not applicable across all organizations. This attribute does not have a default value.
  • Title: Planning Enabled
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then planning is enabled for related item. If false, then planning is not enabled for related item. This attribute does not have a default value.
  • Title: Rank
    Number that indicates the rank of the trading partner item relationship.
  • Title: Spoke Item
    Maximum Length: 255
    Name or number of the spoke part, item, product, or service.
  • Title: Reciprocal
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a reciprocal relationship exists in the item relationship. If false, then a reciprocal relationship does not exists in the item relationship. This attribute does not have a default value.
  • Rank of the related item relationship.
  • Title: Relationship Description
    Maximum Length: 200
    Description of the item relationship.
  • Maximum Length: 30
    Abbreviation that uniquely identifies the status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
  • Status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
  • Value that indicates the type of related item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Maximum Length: 255
    Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
  • Title: Spoke System ID
    Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
  • Title: Start Date
    Date and time when the item relationship begins or becomes active.
  • Title: Type
    Maximum Length: 100
    Abbreviation that identifies the party type of the GTIN in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Value that indicates the party type of the global trade item number (GTIN) in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
  • Title: Supplier
    Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
  • Title: To Item
    Maximum Length: 820
    Name or number of the item for which the relationship is created.
  • Title: Trading Partner Item
    Maximum Length: 150
    Name or number of the item from a trading partner.
  • Title: Trading Partner Number
    Maximum Length: 30
    Number that identifies the trading partner.
  • Value that identifies the product row in the staging interface.
  • Title: Transaction Type
    Maximum Length: 10
    Type of action to be taken when importing a record. Valid values include SYNC and DELETE.
  • Title: UOM
    Maximum Length: 72
    Unit of measure code of the global trade item number (GTIN) relationship.
  • Maximum Length: 255
    Unit of measure of the global trade item number (GTIN) relationship.
  • Title: UOM
    Maximum Length: 25
    Unit of measure name of the global trade item number (GTIN) relationship.
Back to Top