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

​
orderId
required
The unique identifier of the order for which the commission status is being queried.

​
Returns

​
ExperimentalAffiliateCommission.*
required
Returns an object implementing the ExperimentalAffiliateCommission interface, which provides details about the affiliate commission associated with the given order ID.

​
Example - request

Query arguments
{
    "orderId": "{{order-id}}"
}
GraphQL
query ($orderId: ID!) {
    experimentalAffiliateCommission(orderId: $orderId) {
        ... on ExperimentalAffiliateCommissionPending {
            __typename
            updatedAt
        }
        ... on ExperimentalAffiliateCommissionUnconfirmed {
            __typename
            updatedAt
        }
        ... on ExperimentalAffiliateCommissionConfirmed {
            __typename
            updatedAt
            orderAmount {
                value
                displayValue
                currency
            }
            commissionAmount {
                value
                displayValue
                currency
            }
        }
        ... on ExperimentalAffiliateCommissionUpdated {
            __typename
            updatedAt
            orderAmount {
                value
                displayValue
                currency
            }
            commissionAmount {
                value
                displayValue
                currency
            }
        }
        ... on ExperimentalAffiliateCommissionFinalized {
            __typename
            updatedAt
            orderAmount {
                value
                displayValue
                currency
            }
            commissionAmount {
                value
                displayValue
                currency
            }
        }
    }
}

​
Example - response

Response
{
    "data": {
        "experimentalAffiliateCommission": {
            "__typename": "ExperimentalAffiliateCommissionConfirmed",
            "updatedAt": "2024-04-18T15:48:47.472Z",
            "orderAmount": {
                "value": 200,
                "displayValue": "$2.00",
                "currency": "USD"
            },
            "commissionAmount": {
                "value": 75,
                "displayValue": "$0.75",
                "currency": "USD"
            }
        }
    }
}