v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430193167.6 KB

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

post/#X-Amz-Target=B2BI.CreatePartnership

Headers

X-Amz-Target'B2BI.CreatePartnership' required

Request body

profileIdstring required

Specifies the unique, system-generated identifier for the profile connected to this partnership.

namestring required

Specifies a descriptive name for the partnership.

emailstring password required

Specifies the email address associated with this trading partner.

phonestring password

Specifies the phone number associated with the partnership.

capabilitiesCapabilityId[] required

Specifies a list of the capabilities associated with this partnership.

clientTokenstring

Reserved for future use.

Response

Success

profileIdstring required

Returns the unique, system-generated identifier for the profile connected to this partnership.

partnershipIdstring required

Returns the unique, system-generated identifier for a partnership.

partnershipArnstring required

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

namestring

Returns a descriptive name for the partnership.

emailstring password

Returns the email address associated with this trading partner.

phonestring password

Returns the phone number associated with the partnership.

capabilitiesCapabilityId[]

Returns one or more capabilities associated with this partnership.

tradingPartnerIdstring

Returns the unique, system-generated identifier for a trading partner.

createdAtstring date-time required

Returns a timestamp for creation date and time of the partnership.