# Details about a retailer/e-commerce platform (merchant).

Get information about a specific retailer/e-commerce platform (merchant).


Args:

    request: the complete request.
    playout_id: The playout identifier (aka tenant identifier).
    episode_id: The episode identifier
    merchant_id: The merchant identifier (shop source).

Returns:

    ResultResponse[PlayoutMerchant]: Result response contains the merchant details.

Raises:

    ApiHttpException: If the episode, merchant list, or specific merchant are not found (404).

Endpoint: GET /playouts/{playoutId}/episodes/{episodeId}/companies/merchants/{merchantId}
Version: 2025-09-02

## Path parameters:

  - `playoutId` (string, required)
    The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

  - `episodeId` (string, required)
    The episode identifier.

  - `merchantId` (string, required)
    The shop identifier.

## Header parameters:

  - `X-API-Key` (string, required)
    API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

  - `X-JAY-TRACKING` (string)
    Tracking session header for user tracking and analytics. This is set by the /playouts/{playout_id}/tracking/session endpoint.
    Example: "eyJzZXNzaW9uX2lkIjoiZXhhbXBsZS1zZXNzaW9uLWlkLTEyMzQiLCJzdGFydF90aW1lIjoiMjAyNS0wMS0wMVQxMjowMDowMC4wMDAwMDAiLCJzb3VyY2UiOiJqYXkuYXBpLnBsYXlvdXQuZXhhbXBsZSJ9"

## Response 200 fields (application/json):

  - `data` (object)
    The response data.
    Example: {"id":"string","name":"string","description":"string","url":"string","logoUrl":"string","termsOfUseUrl":"string","privacyStatementUrl":"string"}

  - `data.id` (string)
    The shop identifier of this merchant
    Example: "string"

  - `data.name` (string)
    The name of this merchant
    Example: "string"

  - `data.description` (string)
    The description of this merchant
    Example: "string"

  - `data.url` (string)
    The url of this merchant
    Example: "string"

  - `data.logoUrl` (string)
    The logo url of this merchant
    Example: "string"

  - `data.termsOfUseUrl` (string)
    The terms-of-use url of this merchant
    Example: "string"

  - `data.privacyStatementUrl` (string)
    The privacy statement url of this merchant
    Example: "string"

  - `nextToken` (string)
    The token, which can be used to retrieve the next page of data.

  - `error` (object)
    Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error.

  - `error.code` (integer, required)
    The API error code
    Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503

  - `error.message` (string, required)
    The API error message.

  - `error.details` (any)
    The HTTP error details.

## Response 404 fields (application/json):

  - `data` (object)
    The response data.
    Example: {"id":"string","name":"string","description":"string","url":"string","logoUrl":"string","termsOfUseUrl":"string","privacyStatementUrl":"string"}

  - `data.id` (string)
    The shop identifier of this merchant
    Example: "string"

  - `data.name` (string)
    The name of this merchant
    Example: "string"

  - `data.description` (string)
    The description of this merchant
    Example: "string"

  - `data.url` (string)
    The url of this merchant
    Example: "string"

  - `data.logoUrl` (string)
    The logo url of this merchant
    Example: "string"

  - `data.termsOfUseUrl` (string)
    The terms-of-use url of this merchant
    Example: "string"

  - `data.privacyStatementUrl` (string)
    The privacy statement url of this merchant
    Example: "string"

  - `nextToken` (string)
    The token, which can be used to retrieve the next page of data.

  - `error` (object)
    Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error.

  - `error.code` (integer, required)
    The API error code
    Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503

  - `error.message` (string, required)
    The API error message.

  - `error.details` (any)
    The HTTP error details.

## Response 422 fields (application/json):

  - `data` (object)
    The response data.
    Example: {"id":"string","name":"string","description":"string","url":"string","logoUrl":"string","termsOfUseUrl":"string","privacyStatementUrl":"string"}

  - `data.id` (string)
    The shop identifier of this merchant
    Example: "string"

  - `data.name` (string)
    The name of this merchant
    Example: "string"

  - `data.description` (string)
    The description of this merchant
    Example: "string"

  - `data.url` (string)
    The url of this merchant
    Example: "string"

  - `data.logoUrl` (string)
    The logo url of this merchant
    Example: "string"

  - `data.termsOfUseUrl` (string)
    The terms-of-use url of this merchant
    Example: "string"

  - `data.privacyStatementUrl` (string)
    The privacy statement url of this merchant
    Example: "string"

  - `nextToken` (string)
    The token, which can be used to retrieve the next page of data.

  - `error` (object)
    Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error.

  - `error.code` (integer, required)
    The API error code
    Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503

  - `error.message` (string, required)
    The API error message.

  - `error.details` (any)
    The HTTP error details.