Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Arguments

​
pagination
required
Pagination parameters to control the fetching of data, such as specifying the number of items before or after a cursor.
​
filter
Filter parameters to narrow down the search based on specific merchant attributes, such as domain.

​
Returns

​
ExperimentalAffiliateMerchantsConnection.*
required
Returns an ExperimentalAffiliateMerchantsConnection object, which includes a list of affiliate merchants matching the specified criteria along with pagination information.

​
Example - request

Query arguments
{
    "pagination": {
        "last": 10,
        "after": "217"
    }
}
GraphQL
query ($pagination: CursorPaginationInput, $filter: ExperimentalAffiliateMerchantsFilterInput) {
    experimentalAffiliateMerchantsConnection(pagination: $pagination, filter: $filter) {
        pageInfo {
            endCursor
            hasNextPage
            hasPreviousPage
            startCursor
        }
        edges {
            cursor
            node {
                id
                name
                domains {
                    name
                    canonicalDomain
                }
                description
                specialConditions
                categories {
                    id
                    name
                }
                logoUrl
                averageCommissionRate {
                    rate
                }
                minimumCommissionRate {
                    ... on ExperimentalAffiliateCommissionRatePercentage {
                        rate
                    }
                    ... on ExperimentalAffiliateCommissionRateFixed {
                        amountCents
                        currency
                    }
                }
                maximumCommissionRate {
                    ... on ExperimentalAffiliateCommissionRatePercentage {
                        rate
                    }
                    ... on ExperimentalAffiliateCommissionRateFixed {
                        amountCents
                        currency
                    }
                }
                averageDailySales
                averageOrderValue {
                    value
                    displayValue
                    currency
                }
            }
        }
    }
}

​
Example - response

Response
{
    "data": {
        "experimentalAffiliateMerchantsConnection": {
            "pageInfo": {
                "endCursor": "217",
                "hasNextPage": true,
                "hasPreviousPage": false,
                "startCursor": "217"
            },
            "edges": [
                {
                    "cursor": "217",
                    "node": {
                        "id": "217",
                        "name": "Alen",
                        "domains": [
                            {
                                "name": "alencorp-2.myshopify.com",
                                "canonicalDomain": "alencorp-2.myshopify.com"
                            },
                            {
                                "name": "alen.com",
                                "canonicalDomain": "alencorp-2.myshopify.com"
                            }
                        ],
                        "description": "Alen is an innovator of trusted and top-rated True HEPA air purification products. We're looking to establish long-term affiliate relationships with quality partners by offering access to a variety of creative, promotions, and content.",
                        "specialConditions": "",
                        "categories": [
                            {
                                "id": "32",
                                "name": "Appliances"
                            }
                        ],
                        "logoUrl": "https://static.skimlinks.com/images/merchant_logos/mid0_1681315224.jpg",
                        "averageCommissionRate": {
                            "rate": 14.0846
                        },
                        "minimumCommissionRate": {
                            "rate": 0
                        },
                        "maximumCommissionRate": {
                            "rate": 20
                        },
                        "averageDailySales": 0.133333,
                        "averageOrderValue": {
                            "value": 38731,
                            "displayValue": "$387.313",
                            "currency": "USD"
                        }
                    }
                }
            ]
        }
    }
}