Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - TradingPartnerComponent

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

TradingPartnerComponent

The Trading Partner Component object allows users to retrieve, query, create, update, and delete Trading Partner components through the Platform API.

Note: Due to the large number of fields and options for this object, Boomi recommends that you use the Platform and Partner API connectors to create Trading Partner components through the API. For detailed information about the fields, refer to the Trading Partner component information or the help provided for the Trading Partner component within the user interface.

For more details about the partner componets object structure, refer to Trading partner components.

Required Privileges

Read and Write access

  • API — Use the Boomi Platform API to access account data.

Creates a TradingPartnerComponent object

  • This operation creates a Trading Partner Component object with a specified component name.
  • The request body requires the standard, classification, and componentName fields. If you omit the folderName field, you must use the folderId field — and vice versa. If you omit the componentID field and the IDs of any certificates you want to create, their values are assigned when you create the components. If you leave off the folderID field when creating a component, it assigns a value.
  • Includes the organizationId field only if the trading partner is to reference an Organization component, in which case the field value is the ID of the Organization component. A request specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component.
Authorizations:
basicAuth
Request Body schema:
optional
required
object (ContactInfo)
required
object (PartnerCommunication)
required
object (PartnerDocumentTypes)
required
object (PartnerInfo)
PartnerCommunicationTypes
Array of strings
branchId
string
branchName
string
classification
string
Enum: "tradingpartner" "mycompany"
componentId
string
componentName
string
deleted
boolean
description
string
folderId
integer <int64>
folderName
string
identifier
string
organizationId
string
standard
string
Enum: "x12" "edifact" "hl7" "custom" "rosettanet" "tradacoms" "odette"

Responses

Response Schema:
required
object (ContactInfo)
required
object (PartnerCommunication)
required
object (PartnerDocumentTypes)
required
object (PartnerInfo)
PartnerCommunicationTypes
Array of strings
branchId
string
branchName
string
classification
string
Enum: "tradingpartner" "mycompany"
componentId
string
componentName
string
deleted
boolean
description
string
folderId
integer <int64>
folderName
string
identifier
string
organizationId
string
standard
string
Enum: "x12" "edifact" "hl7" "custom" "rosettanet" "tradacoms" "odette"

Request samples

Content type
{
  • "PartnerCommunication": {
    • "FTPCommunicationOptions": {
      }
    },
  • "PartnerInfo": {
    • "X12PartnerInfo": {
      }
    },
  • "ContactInfo": {
    • "contactName": "Tom Miller",
    • "address1": "127 Comstock Ave.",
    • "address2": "",
    • "city": "Philadelphia",
    • "state": "PA",
    • "postalcode": "19100",
    • "country": "US",
    • "email": "tom@bestwholesaling.biz",
    • "phone": "311 555-3579",
    • "fax": "311 555-9753"
    },
  • "PartnerDocumentTypes": {
    • "@type": "PartnerDocumentTypes",
    • "PartnerDocumentType": [
      ]
    },
  • "classification": "tradingpartner",
  • "standard": "x12",
  • "componentName": "Best Wholesaling",
  • "folderName": "Home:TPs",
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1"
}

Response samples

Content type
{
  • "@type": "TradingPartnerComponent",
  • "folderName": "Home:TPs",
  • "componentName": "Best Wholesaling",
  • "standard": "x12",
  • "classification": "tradingpartner",
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1",
  • "ContactInfo": {
    • "contactName": "Tom Miller",
    • "address1": "127 Comstock Ave.",
    • "address2": null,
    • "city": "Philadelphia",
    • "state": "PA",
    • "postalcode": "19100",
    • "country": "US",
    • "email": "tombestwholesaling.biz",
    • "phone": "311 555-3579",
    • "fax": "311 555-9753"
    },
  • "PartnerInfo": {
    • "X12PartnerInfo": {
      }
    },
  • "PartnerCommunication": {
    • "FTPCommunicationOptions": {
      }
    },
  • "PartnerDocumentTypes": {
    • "PartnerDocumentType": [
      ]
    }
}

Retrieves an instance of a TradingPartnerComponent object

The ordinary GET operation returns a single Trading Partner Component object based on the supplied ID. A GET operation specifying the ID of a deleted Trading Partner component retrieves the component. In the component, the deleted field’s value is true.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
required
object (ContactInfo)
required
object (PartnerCommunication)
required
object (PartnerDocumentTypes)
required
object (PartnerInfo)
PartnerCommunicationTypes
Array of strings
branchId
string
branchName
string
classification
string
Enum: "tradingpartner" "mycompany"
componentId
string
componentName
string
deleted
boolean
description
string
folderId
integer <int64>
folderName
string
identifier
string
organizationId
string
standard
string
Enum: "x12" "edifact" "hl7" "custom" "rosettanet" "tradacoms" "odette"

Response samples

Content type
{
  • "@type": "TradingPartnerComponent",
  • "ContactInfo": {
    • "@type": "ContactInfo",
    • "contactName": "Tom Miller",
    • "address1": "127 Comstock Ave.",
    • "address2": "",
    • "city": "Philadelphia",
    • "state": "PA",
    • "postalcode": "19100",
    • "country": "US",
    • "email": "tom@bestwholesaling.biz",
    • "phone": "311 555-3579",
    • "fax": "311 555-9753"
    },
  • "PartnerInfo": {
    • "X12PartnerInfo": {
      }
    },
  • "PartnerCommunication": {
    • "@type": "PartnerCommunication",
    • "FTPCommunicationOptions": {
      }
    },
  • "PartnerDocumentTypes": {
    • "@type": "PartnerDocumentTypes",
    • "PartnerDocumentType": [
      ]
    },
  • "classification": "tradingpartner",
  • "standard": "x12",
  • "componentName": "Best Wholesaling",
  • "componentId": "12345678-9abc-def0-1234-56789abcdef0",
  • "folderName": "Home:TPs",
  • "folderId": 11356,
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1"
}

Modifies or updates a TradingPartnerComponent object

This operation overwrites the Trading Partner Component object with the specified component ID except as described:

  • If the fields are empty, an UPDATE operation specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component. However, if those fields have values, they are not overwritten. An UPDATE operation specifying the ID of a deleted Trading Partner component restores the component to a non-deleted state, assuming the request is otherwise valid.
Authorizations:
basicAuth
path Parameters
id
required
string
Request Body schema:
optional
required
object (ContactInfo)
required
object (PartnerCommunication)
required
object (PartnerDocumentTypes)
required
object (PartnerInfo)
PartnerCommunicationTypes
Array of strings
branchId
string
branchName
string
classification
string
Enum: "tradingpartner" "mycompany"
componentId
string
componentName
string
deleted
boolean
description
string
folderId
integer <int64>
folderName
string
identifier
string
organizationId
string
standard
string
Enum: "x12" "edifact" "hl7" "custom" "rosettanet" "tradacoms" "odette"

Responses

Response Schema:
required
object (ContactInfo)
required
object (PartnerCommunication)
required
object (PartnerDocumentTypes)
required
object (PartnerInfo)
PartnerCommunicationTypes
Array of strings
branchId
string
branchName
string
classification
string
Enum: "tradingpartner" "mycompany"
componentId
string
componentName
string
deleted
boolean
description
string
folderId
integer <int64>
folderName
string
identifier
string
organizationId
string
standard
string
Enum: "x12" "edifact" "hl7" "custom" "rosettanet" "tradacoms" "odette"

Request samples

Content type
{
  • "PartnerCommunication": {
    • "FTPCommunicationOptions": {
      }
    },
  • "PartnerInfo": {
    • "X12PartnerInfo": {
      }
    },
  • "ContactInfo": {
    • "contactName": "Rachel Lewis",
    • "address1": "127 Comstock Ave.",
    • "address2": "",
    • "city": "Philadelphia",
    • "state": "PA",
    • "postalcode": "19100",
    • "country": "US",
    • "email": "rachel@bestwholesaling.biz",
    • "phone": "311 555-2468",
    • "fax": "311 555-8642"
    },
  • "PartnerDocumentTypes": {
    • "@type": "PartnerDocumentTypes",
    • "PartnerDocumentType": [
      ]
    },
  • "classification": "tradingpartner",
  • "standard": "x12",
  • "componentName": "Best Wholesaling",
  • "componentId": "12345678-9abc-def0-1234-56789abcdef0",
  • "folderName": "Home:TPs",
  • "folderId": 11356,
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1"
}

Response samples

Content type
{
  • "@type": "TradingPartnerComponent",
  • "folderId": "11356",
  • "folderName": "Home:TPs",
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1",
  • "componentId": "12345678-9abc-def0-1234-56789abcdef0",
  • "componentName": "Best Wholesaling",
  • "standard": "x12",
  • "classification": "tradingpartner",
  • "ContactInfo": {
    • "contactName": "Rachel Lewis",
    • "address1": "127 Comstock Ave.",
    • "address2": null,
    • "city": "Philadelphia",
    • "state": "PA",
    • "postalcode": "19100",
    • "country": "US",
    • "email": "rachelbestwholesaling.biz",
    • "phone": "311 555-2468",
    • "fax": "311 555-8642"
    },
  • "PartnerInfo": {
    • "X12PartnerInfo": {
      }
    },
  • "PartnerCommunication": {
    • "FTPCommunicationOptions": {
      }
    },
  • "PartnerDocumentTypes": {
    • "PartnerDocumentType": [
      ]
    }
}

Deletes a TradingPartnerComponent object

The DELETE operation deletes the Trading Partner Component object with a specific component ID. A DELETE operation specifying the ID of a deleted Trading Partner component returns a false response.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "message": "Access denied due to insufficient permissions."
}

Retrieves multiple TradingPartnerComponent objects by identifier

The bulk GET operation returns multiple Trading Partner Component objects based on the supplied IDs, to a maximum of 100.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (TradingPartnerComponent)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a TradingPartnerComponent object(s)

The QUERY operation returns each Trading Partner component that meets the specified filtering criteria.

  • The name field in a QUERY filter represents the object’s componentName field.
  • Only the LIKE operator is allowed with a name filter. Likewise, you can only use the EQUALS operator with a classification, standard, identifier filter, or a communication method filter (as2, disk, ftp, http, mllp, sftp). Filtering on a communication method field requests Trading Partner components by defining the communication method.
  • If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator. The QUERY request does not support the logical OR operator.
  • The QUERY results omit the folderName field.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: name, classification, standard, identifier, as2, disk, ftp, mllp, sftp, http, oftp

required
object
required
TradingPartnerComponentSimpleExpression (object) or TradingPartnerComponentGroupingExpression (object) (TradingPartnerComponentExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "name" "classification" "standard" "identifier" "as2" "disk" "ftp" "mllp" "sftp" "http" "oftp"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (TradingPartnerComponent)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}

Retrieves additional results for a TradingPartnerComponent query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (TradingPartnerComponent)

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}