1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Vendor-Managed Inventory Relationships

Create relationships

post

/fscmRestApi/resources/11.13.18.05/vmiRelationships

Request

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
  • Value that uniquely identifies the inventory item in the relationship.
  • Number that identifies the item.
  • Maximum Length: 255
    Identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include Supplier or Enterprise.
  • Maximum Length: 255
    Abbreviation that identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include ORA_VCS_MIN_MAX_ORIGIN_SUP or ORA_VCS_MIN_MAX_ORIGIN_ENT.
  • Abbreviation that identifies the organization that receives the item.
  • Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
  • Value that uniquely identifies the relationship.
  • Title: Relationship
    Maximum Length: 9
    Number that identifies the relationship.
  • Value that uniquely identifies the requisition requester for the relationship.
  • Maximum Length: 255
    Login that the user used when requesting the requisition for the relationship.
  • Maximum Length: 255
    Value that indicates the level at which the replenishment process is managed. Values include Organization and Subinventory.
  • Title: Scope
    Maximum Length: 30
    Default Value: ORA_VCS_SCOPE_SHIP_TO_ORG
    Abbreviation that indicates the level at which the replenishment process is managed. Values include ORA_VCS_SCOPE_SHIP_TO_ORG and ORA_VCS_SCOPE_SHIP_TO_SUB. A list of accepted values is defined in the lookup type
    ORA_VCS_VMI_RELATIONSHIP_SCOPE.
  • Maximum Length: 255
    Value that identifies the current state of the vendor-managed inventory relationship. Values include Active or Inactive.
  • Title: Status
    Maximum Length: 30
    Default Value: ORA_VCS_STATUS_VMI_RL_ACTIVE
    Abbreviation that Identifies the current state of the vendor-managed inventory relationship. Values include ORA_VCS_STATUS_VMI_REL_ACTIVE or ORA_VCS_STATUS_VMI_REL_INACTIVE. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_STATUS.
  • Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
  • Name of the supplier that ships the item.
  • Maximum Length: 255
    Number of the supplier that ships the item.
  • Subinventory Relationships
    Title: Subinventory Relationships
    The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Nested Schema : Subinventory Relationships
Type: array
Title: Subinventory Relationships
The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Show Source
Nested Schema : vmiRelationships-vmiSubinventories-item-post-request
Type: object
Show Source
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 : vmiRelationships-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the vendor-managed inventory relationship.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the vendor-managed inventory relationship.
  • Value that uniquely identifies the inventory item in the relationship.
  • Read Only: true
    Maximum Length: 255
    Value that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. Valid values include Supplier, Enterprise, or Unresolved planning owner.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. A list of accepted values is defined in the lookup type ORA_VCS_VMI_INV_PLAN_OWNER.
  • Read Only: true
    Maximum Length: 2400
    Category that the application assigns to the item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item.
  • Number that identifies the item.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the vendor-managed inventory relationship.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login of the user who most recently updated the vendor-managed inventory relationship.
  • Links
  • Maximum Length: 255
    Identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include Supplier or Enterprise.
  • Maximum Length: 255
    Abbreviation that identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include ORA_VCS_MIN_MAX_ORIGIN_SUP or ORA_VCS_MIN_MAX_ORIGIN_ENT.
  • Abbreviation that identifies the organization that receives the item.
  • Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
  • Read Only: true
    Maximum Length: 240
    Name of the organization that receives the item.
  • Value that uniquely identifies the relationship.
  • Title: Relationship
    Maximum Length: 9
    Number that identifies the relationship.
  • Value that uniquely identifies the requisition requester for the relationship.
  • Maximum Length: 255
    Login that the user used when requesting the requisition for the relationship.
  • Maximum Length: 255
    Value that indicates the level at which the replenishment process is managed. Values include Organization and Subinventory.
  • Title: Scope
    Maximum Length: 30
    Default Value: ORA_VCS_SCOPE_SHIP_TO_ORG
    Abbreviation that indicates the level at which the replenishment process is managed. Values include ORA_VCS_SCOPE_SHIP_TO_ORG and ORA_VCS_SCOPE_SHIP_TO_SUB. A list of accepted values is defined in the lookup type
    ORA_VCS_VMI_RELATIONSHIP_SCOPE.
  • Maximum Length: 255
    Value that identifies the current state of the vendor-managed inventory relationship. Values include Active or Inactive.
  • Title: Status
    Maximum Length: 30
    Default Value: ORA_VCS_STATUS_VMI_RL_ACTIVE
    Abbreviation that Identifies the current state of the vendor-managed inventory relationship. Values include ORA_VCS_STATUS_VMI_REL_ACTIVE or ORA_VCS_STATUS_VMI_REL_INACTIVE. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_STATUS.
  • Read Only: true
    Alternate name of the supplier that ships the item.
  • Read Only: true
    Maximum Length: 30
    Data universal numbering system of the supplier who ships the item.
  • Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
  • Name of the supplier that ships the item.
  • Maximum Length: 255
    Number of the supplier that ships the item.
  • Subinventory Relationships
    Title: Subinventory Relationships
    The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Nested Schema : Subinventory Relationships
Type: array
Title: Subinventory Relationships
The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Show Source
Nested Schema : vmiRelationships-vmiSubinventories-item-response
Type: object
Show Source
Links
vmiSubinventories
Parameters:
  • vmiRelationshipsUniqID: $request.path.vmiRelationshipsUniqID
The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Back to Top

Examples

This example describes how to create relationships.

Example cURL Command

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

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

Example Request Body

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

{
    "SupplierName": "CV_SuppD05",
    "OrganizationCode": "VMIMFG3",
    "ItemNumber": "VMI-P100",
    "ScopeCode":  "ORA_VCS_SCOPE_SHIP_TO_ORG",
    "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_SUP",
    "RequisitionRequesterUserName": "VMI_MANAGER"
}

Example Response Body

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

{
    "RelationshipId": 300100176272361,
    "RelationshipNumber": "44001",
    "SupplierId": 100000012050255,
    "SupplierName": null,
    "SupplierNumber": null,
    "SupplierDUNS": null,
    "SupplierAlternateName": null,
    "OrganizationId": 300100152267719,
    "OrganizationCode": null,
    "OrganizationName": null,
    "InventoryItemId": 300100173318060,
    "ItemNumber": null,
    "ItemDescription": null,
    "ItemCategory": null,
    "Scope": "Organization",
    "ScopeCode": "ORA_VCS_SCOPE_SHIP_TO_ORG",
    "Status": null,
    "StatusCode": "ORA_VCS_STATUS_VMI_RL_ACTIVE",
    "InventoryPlanningOwner": null,
    "InventoryPlanningOwnerCode": null,
    "MinMaxQuantitySource": "Supplier",
    "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_SUP",
    "RequisitionRequesterPersonId": 300100073936640,
    "RequisitionRequesterUserName": "VMI_MANAGER",
    "CreatedBy": "SCC_MANAGER",
    "CreationDate": "2018-10-24T17:10:00+00:00",
    "LastUpdatedBy": "SCC_MANAGER",
    "LastUpdateDate": "2018-10-24T17:10:06.154+00:00",
    "links": [
        {
           ...
        },
        {
           ...
        },
        {
           ...
        }
    ]
}
Back to Top