1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. B2B Trading Partners

Create trading partners

post

/fscmRestApi/resources/11.13.18.05/b2bTradingPartners

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
Nested Schema : B2B Service Providers
Type: array
Title: B2B Service Providers
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers.
Show Source
Nested Schema : Confirmation Codes
Type: array
Title: Confirmation Codes
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing.
Show Source
Nested Schema : Delivery Methods
Type: array
Title: Delivery Methods
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
Show Source
Nested Schema : Trading Partner Documents
Type: array
Title: Trading Partner Documents
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
Show Source
Nested Schema : Inbound Collaboration Messages
Type: array
Title: Inbound Collaboration Messages
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : Outbound Collaboration Messages
Type: array
Title: Outbound Collaboration Messages
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : b2bTradingPartners-b2bServiceProviders-item-post-request
Type: object
Show Source
  • Title: Provider ID
    Maximum Length: 100
    Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner for a service provider.
  • Maximum Length: 100
    Value that uniquely identifies the type of trading partner.
  • Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.
  • Maximum Length: 256
    Name of the service provider.
Nested Schema : b2bTradingPartners-confirmationCodes-item-post-request
Type: object
Show Source
  • Maximum Length: 100
    Value that specifies the status of the collaboration message.
  • Value that uniquely identifies the confirmation code. It is a primary key that the application generates when it creates a confirmation code record. This attribute is required.
  • Maximum Length: 256
    Value that specifies the status of confirmation of the trading partner.
Nested Schema : b2bTradingPartners-deliveryMethods-item-post-request
Type: object
Show Source
  • Title: Attach Payload
    Maximum Length: 10
    Contains one of the following values: true or false. If true, then the transformed payload is sent along with the email as attachment. If false, then the transformed payload is not sent along with the email as attachment. The default value is false.
  • Title: B2B Routing Enabled
    Maximum Length: 10
    Default Value: false
    Contains one of the following values: true or false. If true, then the messages to the service provider are routed through the internal B2B gateway. If false, then the messages to the service provider are not routed through the internal B2B gateway. The default value is false.
  • Value that stores the password in the credential store.
  • Value that stores the username in the credential store.
  • Value that uniquely identifies the delivery method. It is a primary key that the application generates when it creates a delivery method record. This attribute is required.
  • Title: Name
    Maximum Length: 256
    Name of the delivery method. This attribute is required.
  • Maximum Length: 100
    Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.
  • Maximum Length: 10
    Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
  • Maximum Length: 256
    Value that identifies the file that is being delivered using SFTP.
  • Title: Recipient Email ID
    Maximum Length: 256
    Value that uniquely identifies the email to which the outbound message is sent.
  • Maximum Length: 2000
    Value that identifies the directory where outbound messages are delivered using SFTP.
  • Title: Security Policy
    Maximum Length: 256
    Value that indicates the security policy used with the delivery method.
  • Title: Service Name
    Maximum Length: 256
    Value that identifies the external service of the delivery method.
  • Value that specifies the meaning of the service.
  • Value that specifies the service endpoint stored in topology manager.
  • Value that identifies the host name for outbound message delivery using SFTP.
  • Maximum Length: 255
    Value that identifies the port for outbound message delivery using SFTP.
  • Title: Repository Account
    Maximum Length: 1024
    Value that specifies the location from where files are picked for outbound process.
Nested Schema : b2bTradingPartners-documents-item-post-request
Type: object
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-documents-messageProcessingRules-item-post-request
Type: object
Show Source
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-item-post-request
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-item-post-request
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-post-request
Type: object
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-post-request
Type: object
Show Source
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
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 : b2bTradingPartners-item-response
Type: object
Show Source
Nested Schema : B2B Service Providers
Type: array
Title: B2B Service Providers
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers.
Show Source
Nested Schema : Confirmation Codes
Type: array
Title: Confirmation Codes
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing.
Show Source
Nested Schema : Delivery Methods
Type: array
Title: Delivery Methods
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
Show Source
Nested Schema : Trading Partner Documents
Type: array
Title: Trading Partner Documents
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
Show Source
Nested Schema : Inbound Collaboration Messages
Type: array
Title: Inbound Collaboration Messages
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : Outbound Collaboration Messages
Type: array
Title: Outbound Collaboration Messages
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : b2bTradingPartners-b2bServiceProviders-item-response
Type: object
Show Source
Nested Schema : b2bTradingPartners-confirmationCodes-item-response
Type: object
Show Source
Nested Schema : b2bTradingPartners-deliveryMethods-item-response
Type: object
Show Source
  • Title: Attach Payload
    Maximum Length: 10
    Contains one of the following values: true or false. If true, then the transformed payload is sent along with the email as attachment. If false, then the transformed payload is not sent along with the email as attachment. The default value is false.
  • Title: B2B Routing Enabled
    Maximum Length: 10
    Default Value: false
    Contains one of the following values: true or false. If true, then the messages to the service provider are routed through the internal B2B gateway. If false, then the messages to the service provider are not routed through the internal B2B gateway. The default value is false.
  • Read Only: true
    Date when the user created the delivery method that the trading partner uses to send outbound messages.
  • Value that stores the password in the credential store.
  • Value that stores the username in the credential store.
  • Value that uniquely identifies the delivery method. It is a primary key that the application generates when it creates a delivery method record. This attribute is required.
  • Title: Name
    Maximum Length: 256
    Name of the delivery method. This attribute is required.
  • Maximum Length: 100
    Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.
  • Maximum Length: 10
    Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
  • Maximum Length: 256
    Value that identifies the file that is being delivered using SFTP.
  • Read Only: true
    Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages.
  • Links
  • Title: Recipient Email ID
    Maximum Length: 256
    Value that uniquely identifies the email to which the outbound message is sent.
  • Maximum Length: 2000
    Value that identifies the directory where outbound messages are delivered using SFTP.
  • Title: Security Policy
    Maximum Length: 256
    Value that indicates the security policy used with the delivery method.
  • Title: Service Name
    Maximum Length: 256
    Value that identifies the external service of the delivery method.
  • Value that specifies the meaning of the service.
  • Value that specifies the service endpoint stored in topology manager.
  • Value that identifies the host name for outbound message delivery using SFTP.
  • Maximum Length: 255
    Value that identifies the port for outbound message delivery using SFTP.
  • Title: Repository Account
    Maximum Length: 1024
    Value that specifies the location from where files are picked for outbound process.
Nested Schema : b2bTradingPartners-documents-item-response
Type: object
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-documents-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-item-response
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the domain value map associated with the trading partner's predefined message definition.
  • Read Only: true
    Maximum Length: 256
    Name of the domain value map defined in the SOA composer.
  • Read Only: true
    Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition.
  • Links
  • Read Only: true
    Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required.
  • Read Only: true
    Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
  • Read Only: true
    Name of the collaboration message.
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-item-response
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the domain value map associated with the trading partner's predefined message definition.
  • Read Only: true
    Maximum Length: 256
    Name of the domain value map defined in the SOA composer.
  • Read Only: true
    Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition.
  • Links
  • Read Only: true
    Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required.
  • Read Only: true
    Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
  • Read Only: true
    Name of the collaboration message.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Links
b2bServiceProviders
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers.
confirmationCodes
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing.
deliveryMethods
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
documents
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
inboundCollaborationMessages
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
outboundCollaborationMessages
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
Back to Top

Examples

This example describes how to create trading partners.

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/b2bTradingPartners"

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. 

{ 
  "TradingPartner": "JK_NEW_TEST",
  "TradingPartnerIdType": "ORA_DUNS",
  "ManualEntryIndicator": "Yes"
}

Example Response Body

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

{
  "TradingPartnerId" : 300100113040917,
  "TradingPartner" : "JK_NEW_TEST",
  "TradingPartnerIdType" : "ORA_DUNS",
  "ManualEntryIndicator" : "Yes",
  "ServiceProviderId" : 50055,
  "ServiceProviderName" : "None",
  "FromPartnerIdTag" : null,
  "FromPartnerIdTypeTag" : null,
  "ToPartnerIdTag" : null,
  "ToPartnerIdTypeTag" : null,
  "ExternalMessageTypeTag" : null,
  "ExternalMessageVersionTag" : null,
  "ExternalMessageStandardTag" : null,
}
Back to Top