Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Products

Get Term By Id for a Product

Retrieves the specific term and condition for a product by its unique identifier.

get/programs/{programCode}/products/{productCode}/terms/{brandAgreementIdentifier}

Path parameters

productCodestring required

The code of the product for which terms and conditions are requested.

programCodestring required

The code of the program to which the product belongs.

brandAgreementIdentifierstring uuid required

The unique identifier of the brand agreement (term and condition) to retrieve.

Headers

X-GD-RequestIdstring required

The unique request identifier provided in the request header. Used for tracking and logging.

X-GD-RPC-Formatstring

The RPC format specifier from the request header, used to control the response format.

Response

OK

brandAgreementTypeIdentifierstring nullable

Gets or sets the unique identifier for the type of brand agreement.

brandAgreementTypeNamestring nullable

Gets or sets the name of the brand agreement type.

descriptionstring nullable

Gets or sets the description of the brand agreement.

productCodestring nullable

Gets or sets the code of the product associated with the brand agreement.

brandAgreementVersioninteger

Gets or sets the version number of the brand agreement.

brandAgreementEffectiveDatestring date-time

Gets or sets the effective date of the brand agreement. Indicates when the agreement becomes valid.

brandAgreementFormatstring nullable

Gets or sets the format of the brand agreement (e.g., "PDF", "HTML", "Text").

brandAgreementContentsstring nullable

Gets or sets the contents of the brand agreement, typically the full text or HTML of the agreement.

brandAgreementIdentifierstring uuid

Gets or sets the unique identifier for the brand agreement.