Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430193167.6 KB

Retrieves the details for a partnership, based on the partner and profile IDs specified. 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.GetPartnership

Headers

X-Amz-Target'B2BI.GetPartnership' required

Request body

partnershipIdstring required

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

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 the display name of 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 identifier for the partner for this partnership.

createdAtstring date-time required

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

modifiedAtstring date-time

Returns a timestamp that identifies the most recent date and time that the partnership was modified.