# GraphQL Examples (Full) # GraphQL Examples ## Using curl Set your endpoint and token once; reuse for all examples. ```bash ENDPOINT="https://your.api/graphql" TOKEN="" curl -s -X POST "$ENDPOINT" \ + -H "Authorization: Bearer $TOKEN" \ + -H "Content-Type: application/json" \ + -d @- << PAYLOAD { "query": "query Example { __typename }", "variables": {} } PAYLOAD ``` ## Table of contents - [Queries](#queries) - [Mutations](#mutations) ## Queries ### account Retrieve an account by ID Arguments: - id: ID! (required) - Unique identifier of the account Signature: ```graphql account(id: ID!): Account ``` ```graphql query account($id: ID!) { account(id: $id) { id name status externalId countryCode } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "account": { "id": "123", "creditMemos": { "totalCount": 1, "pageInfo": {}, "nodes": {}, "userErrors": {} }, "name": "example", "status": {}, "accessTypes": {} } } } ``` ### accountAssociations Retrieve list of account associations Arguments: - resellerAccountId: ID (optional) - Reseller account ID. This field is required if you do not include the Customer account ID - customerAccountId: ID (optional) - Customer account ID. This field is required if you do not include the Reseller account ID - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - filter: AccountAssociationFilter (optional) - Filter for account associations list - orderBy: AccountAssociationOrderBy (optional) - The property and direction to sort account associations by Signature: ```graphql accountAssociations(resellerAccountId: ID, customerAccountId: ID, first: Int, after: String, before: String, last: Int, filter: AccountAssociationFilter, orderBy: AccountAssociationOrderBy): AccountAssociationConnection! ``` ```graphql query accountAssociations($resellerAccountId: ID, $customerAccountId: ID, $first: Int, $after: String, $before: String, $last: Int, $filter: AccountAssociationFilter, $orderBy: AccountAssociationOrderBy) { accountAssociations(resellerAccountId: $resellerAccountId, customerAccountId: $customerAccountId, first: $first, after: $after, before: $before, last: $last, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "resellerAccountId": "123", "customerAccountId": "123", "first": 10, "after": "cursor", "before": "example", "last": 1, "filter": { "searchText": "example", "createdAfter": null }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "accountAssociations": { "totalCount": 1, "nodes": { "id": "123", "createdOn": {}, "resellerAccount": {}, "customerAccount": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### accountByExternalId Retrieve an account by external ID Arguments: - externalId: String! (required) - Unique external identifier of the account Signature: ```graphql accountByExternalId(externalId: String!): Account ``` ```graphql query accountByExternalId($externalId: String!) { accountByExternalId(externalId: $externalId) { id name status externalId countryCode } } ``` Variables: ```json { "externalId": "example" } ``` Sample response: ```json { "data": { "accountByExternalId": { "id": "123", "creditMemos": { "totalCount": 1, "pageInfo": {}, "nodes": {}, "userErrors": {} }, "name": "example", "status": {}, "accessTypes": {} } } } ``` ### accountMembership Retrieve an account membership by account ID and user ID Arguments: - accountId: ID! (required) - Unique identifier of the account - userId: ID! (required) - Unique identifier of the user Signature: ```graphql accountMembership(accountId: ID!, userId: ID!): AccountMembership ``` ```graphql query accountMembership($accountId: ID!, $userId: ID!) { accountMembership(accountId: $accountId, userId: $userId) { status isLastUsed user account feedResources } } ``` Variables: ```json { "accountId": "123", "userId": "123" } ``` Sample response: ```json { "data": { "accountMembership": { "user": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" }, "account": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "feedResources": { "nodes": {}, "pageInfo": {}, "totalCount": 1 }, "creditMemos": { "totalCount": 1, "pageInfo": {}, "nodes": {}, "userErrors": {} }, "isLastUsed": true } } } ``` ### accountMemberships Retrieve list of account memberships by account ID Arguments: - accountId: ID! (required) - Unique identifier of the account - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - filter: AccountMembershipFilter (optional) - Filter for account membership list - orderBy: AccountMembershipOrderBy (optional) - The property and direction to sort account memberships by Signature: ```graphql accountMemberships(accountId: ID!, first: Int, after: String, before: String, last: Int, filter: AccountMembershipFilter, orderBy: AccountMembershipOrderBy): AccountMembershipConnection! ``` ```graphql query accountMemberships($accountId: ID!, $first: Int, $after: String, $before: String, $last: Int, $filter: AccountMembershipFilter, $orderBy: AccountMembershipOrderBy) { accountMemberships(accountId: $accountId, first: $first, after: $after, before: $before, last: $last, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "accountId": "123", "first": 10, "after": "cursor", "before": "example", "last": 1, "filter": { "groupId": "123", "role": null }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "accountMemberships": { "totalCount": 1, "nodes": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### accountMembershipsByAccessType Arguments: - userId: ID (optional) - Unique identifier of the user - accountId: ID (optional) - Unique identifier of the account - accessTypes: [AccountAccessType!]! (required) - Filter for access type - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - orderBy: AccountMembershipOrderBy (optional) - The property and direction to sort account memberships by Signature: ```graphql accountMembershipsByAccessType(userId: ID, accountId: ID, accessTypes: [AccountAccessType!]!, first: Int, after: String, before: String, last: Int, orderBy: AccountMembershipOrderBy): AccountMembershipConnection! ``` ```graphql query accountMembershipsByAccessType($userId: ID, $accountId: ID, $accessTypes: [AccountAccessType!]!, $first: Int, $after: String, $before: String, $last: Int, $orderBy: AccountMembershipOrderBy) { accountMembershipsByAccessType(userId: $userId, accountId: $accountId, accessTypes: $accessTypes, first: $first, after: $after, before: $before, last: $last, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "userId": "123", "accountId": "123", "accessTypes": [ "value" ], "first": 10, "after": "cursor", "before": "example", "last": 1, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "accountMembershipsByAccessType": { "totalCount": 1, "nodes": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### accountMembershipsByAccountIdAndUserIdPairs Retrieve a list of account IDs and user IDs Arguments: - accountUserPairs: [AccountUserIdPair!]! (required) - List of account and user ID pairs Signature: ```graphql accountMembershipsByAccountIdAndUserIdPairs(accountUserPairs: [AccountUserIdPair!]!): [AccountMembershipByAccountId!]! ``` ```graphql query accountMembershipsByAccountIdAndUserIdPairs($accountUserPairs: [AccountUserIdPair!]!) { accountMembershipsByAccountIdAndUserIdPairs(accountUserPairs: $accountUserPairs) { accountId accountMembership userErrors } } ``` Variables: ```json { "accountUserPairs": [ { "accountId": "123", "userId": "123" } ] } ``` Sample response: ```json { "data": { "accountMembershipsByAccountIdAndUserIdPairs": { "accountId": "123", "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "userErrors": { "__typename": "AccountMembershipNotFoundError" } } } } ``` ### accountMembershipsForLinkedReseller Retrieve list of account memberships by reseller account ID and associated customer user ID Arguments: - resellerAccountId: ID! (required) - Unique identifier of the reseller account - userId: ID (optional) - Unique identifier of the customer user that belongs to at least one company associated to the reseller - accountId: ID (optional) - Unique identifier of the customer account associated to the reseller - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - orderBy: AccountMembershipOrderBy (optional) - The property and direction to sort account memberships by Signature: ```graphql accountMembershipsForLinkedReseller(resellerAccountId: ID!, userId: ID, accountId: ID, first: Int, after: String, before: String, last: Int, orderBy: AccountMembershipOrderBy): AccountMembershipConnection! ``` ```graphql query accountMembershipsForLinkedReseller($resellerAccountId: ID!, $userId: ID, $accountId: ID, $first: Int, $after: String, $before: String, $last: Int, $orderBy: AccountMembershipOrderBy) { accountMembershipsForLinkedReseller(resellerAccountId: $resellerAccountId, userId: $userId, accountId: $accountId, first: $first, after: $after, before: $before, last: $last, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "resellerAccountId": "123", "userId": "123", "accountId": "123", "first": 10, "after": "cursor", "before": "example", "last": 1, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "accountMembershipsForLinkedReseller": { "totalCount": 1, "nodes": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### accounts Retrieve a list of accounts Arguments: - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - filter: AccountsFilter (optional) - Account name by which to filter the list - orderBy: AccountOrderBy (optional) Signature: ```graphql accounts(first: Int, after: String, before: String, last: Int, filter: AccountsFilter, orderBy: AccountOrderBy): AccountConnection! ``` ```graphql query accounts($first: Int, $after: String, $before: String, $last: Int, $filter: AccountsFilter, $orderBy: AccountOrderBy) { accounts(first: $first, after: $after, before: $before, last: $last, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "last": 1, "filter": { "name": "example", "searchText": "example" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "accounts": { "totalCount": 1, "nodes": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### activeCart Retrieves the active cart for the current user Arguments: - locale: Locale (optional) - Preferred locale for the response (e.g., en-US, de, en-AU). If not provided, user's current locale will be used - isPreviewCheckout: Boolean (optional) - Indicates if the cart is in checkout preview mode Signature: ```graphql activeCart(locale: Locale, isPreviewCheckout: Boolean): Cart ``` ```graphql query activeCart($locale: Locale, $isPreviewCheckout: Boolean) { activeCart(locale: $locale, isPreviewCheckout: $isPreviewCheckout) { id status buyerUser buyerAccount currency } } ``` Variables: ```json { "locale": "value", "isPreviewCheckout": true } ``` Sample response: ```json { "data": { "activeCart": { "id": "123", "buyerUser": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" }, "buyerAccount": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "currency": {}, "status": {} } } } ``` ### activeCartOfUser Retrieves the active cart for a specific user Arguments: - input: ActiveCartOfUserInput! (required) Signature: ```graphql activeCartOfUser(input: ActiveCartOfUserInput!): Cart ``` ```graphql query activeCartOfUser($input: ActiveCartOfUserInput!) { activeCartOfUser(input: $input) { id status buyerUser buyerAccount currency } } ``` Variables: ```json { "input": { "userId": "123", "accountId": "123" } } ``` Sample response: ```json { "data": { "activeCartOfUser": { "id": "123", "buyerUser": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" }, "buyerAccount": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "currency": {}, "status": {} } } } ``` ### allocation Query the last created allocation (Effective one) Arguments: - input: SubscriptionAllocationInput! (required) Signature: ```graphql allocation(input: SubscriptionAllocationInput!): [SubscriptionAllocation]! ``` ```graphql query allocation($input: SubscriptionAllocationInput!) { allocation(input: $input) { uuid chargeId subscriptionId allocations } } ``` Variables: ```json { "input": { "date": "2024-01-01", "subscriptionIds": "123" } } ``` Sample response: ```json { "data": { "allocation": { "uuid": "example", "chargeId": "example", "subscriptionId": "example", "allocations": { "companyId": "example", "unitAllocations": {} } } } } ``` ### analyzeIndexDeltaStatus Signature: ```graphql analyzeIndexDeltaStatus: [SearchIndexDeltaStatus!]! ``` ```graphql query analyzeIndexDeltaStatus { analyzeIndexDeltaStatus { index mappings settings } } ``` Sample response: ```json { "data": { "analyzeIndexDeltaStatus": { "index": "example", "mappings": { "diff": {}, "warnings": {} }, "settings": { "diff": {}, "warnings": {} } } } } ``` ### attestationStatusByCompany Arguments: - companyUuid: String! (required) Signature: ```graphql attestationStatusByCompany(companyUuid: String!): AttestationResponse! ``` ```graphql query attestationStatusByCompany($companyUuid: String!) { attestationStatusByCompany(companyUuid: $companyUuid) { signatoryFirstName signatoryLastName status attestationId companyUuid } } ``` Variables: ```json { "companyUuid": "example" } ``` Sample response: ```json { "data": { "attestationStatusByCompany": { "attestationId": "example", "status": {}, "companyUuid": "example", "partner": "example", "signatoryFirstName": "example" } } } ``` ### billingChargeAllocations Query the last created allocation for a purchaseOrder Arguments: - input: BillingChargeAllocationInput! (required) Signature: ```graphql billingChargeAllocations(input: BillingChargeAllocationInput!): [SubscriptionAllocation]! ``` ```graphql query billingChargeAllocations($input: BillingChargeAllocationInput!) { billingChargeAllocations(input: $input) { uuid chargeId subscriptionId allocations } } ``` Variables: ```json { "input": { "charges": null } } ``` Sample response: ```json { "data": { "billingChargeAllocations": { "uuid": "example", "chargeId": "example", "subscriptionId": "example", "allocations": { "companyId": "example", "unitAllocations": {} } } } } ``` ### billingRelationship Read specific billing relationship for tenant Arguments: - id: ID! (required) - locale: Locale! (required) Signature: ```graphql billingRelationship(id: ID!, locale: Locale!): BillingRelationship! ``` ```graphql query billingRelationship($id: ID!, $locale: Locale!) { billingRelationship(id: $id, locale: $locale) { id status tenant label description } } ``` Variables: ```json { "id": "123", "locale": "value" } ``` Sample response: ```json { "data": { "billingRelationship": { "id": "123", "tenant": "example", "relationships": { "buyer": {}, "merchantOfRecord": {}, "payer": {}, "owner": {} }, "status": {}, "label": "example" } } } ``` ### billingRelationships Read all billing relationships Arguments: - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) - locale: Locale! (required) - orderBy: BillingRelationshipOrderBy (optional) Signature: ```graphql billingRelationships(first: Int, after: String, last: Int, before: String, locale: Locale!, orderBy: BillingRelationshipOrderBy): BillingRelationshipConnection ``` ```graphql query billingRelationships($first: Int, $after: String, $last: Int, $before: String, $locale: Locale!, $orderBy: BillingRelationshipOrderBy) { billingRelationships(first: $first, after: $after, last: $last, before: $before, locale: $locale, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "locale": "value", "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "billingRelationships": { "nodes": { "id": "123", "tenant": "example", "relationships": {}, "status": {}, "label": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### bootstrapMarketplaceProductSearchIndexesStatus Query the status of a search index bootstrap process. Arguments: - id: ID! (required) - Bootstrap ID Signature: ```graphql bootstrapMarketplaceProductSearchIndexesStatus(id: ID!): BootstrapMarketplaceProductSearchIndexesStatus! ``` ```graphql query bootstrapMarketplaceProductSearchIndexesStatus($id: ID!) { bootstrapMarketplaceProductSearchIndexesStatus(id: $id) { status bootstrapId partnerCount productCount requestsSent } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "bootstrapMarketplaceProductSearchIndexesStatus": { "bootstrapId": "123", "partnerCount": 1, "productCount": 1, "requestsSent": 1, "requestsSendErrors": 1 } } } ``` ### cartFields Retrieves form fields for a specific cart Arguments: - cartId: ID! (required) - Unique identifier of the cart - locale: Locale! (required) - Preferred locale for the response (e.g., en-US, de, en-AU) - filter: CartFieldsFilter (optional) - Optional filters to refine the response Signature: ```graphql cartFields(cartId: ID!, locale: Locale!, filter: CartFieldsFilter): CartFieldsPayload ``` ```graphql query cartFields($cartId: ID!, $locale: Locale!, $filter: CartFieldsFilter) { cartFields(cartId: $cartId, locale: $locale, filter: $filter) { productFields subscriptionCustomAttributes purchaseCustomAttributes } } ``` Variables: ```json { "cartId": "123", "locale": "value", "filter": { "itemIds": "123" } } ``` Sample response: ```json { "data": { "cartFields": { "productFields": { "forms": {}, "itemId": "123" }, "subscriptionCustomAttributes": { "inputCode": "example", "inputTitle": "example", "subTitle": "example", "tooltip": "example", "value": "example" }, "purchaseCustomAttributes": { "inputCode": "example", "inputTitle": "example", "subTitle": "example", "tooltip": "example", "value": "example" } } } } ``` ### cartValidation Validates the items in a cart Arguments: - input: CartValidationRequest! (required) Signature: ```graphql cartValidation(input: CartValidationRequest!): CartValidation ``` ```graphql query cartValidation($input: CartValidationRequest!) { cartValidation(input: $input) { id pendingValidations blockingErrors createdOn warnings } } ``` Variables: ```json { "input": { "cartId": "123", "level": null } } ``` Sample response: ```json { "data": { "cartValidation": { "id": "123", "blockingErrors": { "code": "example", "itemId": "123", "message": "example", "messageParameters": {} }, "createdOn": {}, "pendingValidations": "example", "warnings": { "code": "example", "itemId": "123", "message": "example", "messageParameters": {} } } } } ``` ### checkoutSettings Retrieves marketplace settings used during the checkout process Signature: ```graphql checkoutSettings: CheckoutSettings ``` ```graphql query checkoutSettings { checkoutSettings { tenant marketplaceBaseUrl supportPhone marketplaceLogoUrl marketplaceFaviconUrl } } ``` Sample response: ```json { "data": { "checkoutSettings": { "tenant": "example", "marketplaceBaseUrl": "https://example.com", "supportEmail": { "locale": {}, "value": {} }, "supportPhone": "example", "supportedLocales": {} } } } ``` ### commissionCycleExecutions Returns a list of commission event entities found for the filters provided Arguments: - cycle: String! (required) Signature: ```graphql commissionCycleExecutions(cycle: String!): CommissionCycleExecutionsConnection! ``` ```graphql query commissionCycleExecutions($cycle: String!) { commissionCycleExecutions(cycle: $cycle) { importing retrying cancelling } } ``` Variables: ```json { "cycle": "example" } ``` Sample response: ```json { "data": { "commissionCycleExecutions": { "importing": {}, "retrying": {}, "cancelling": {} } } } ``` ### commissionCyclesByYear Retrieve a list of cycles by year, each holding event batch information for a month of the year Arguments: - year: Int! (required) - partner: String (optional) Signature: ```graphql commissionCyclesByYear(year: Int!, partner: String): [CommissionCycle!] ``` ```graphql query commissionCyclesByYear($year: Int!, $partner: String) { commissionCyclesByYear(year: $year, partner: $partner) { status month lastUpdatedOn commissionEventsSummary } } ``` Variables: ```json { "year": 1, "partner": "example" } ``` Sample response: ```json { "data": { "commissionCyclesByYear": { "month": 1, "status": {}, "lastUpdatedOn": {}, "commissionEventsSummary": { "totalEvents": 1, "eventsExpected": 1, "eventsReady": 1, "eventsImported": 1, "eventsOnError": 1 } } } } ``` ### commissionEvent Returns a list of commission event entities found for the filters provided Arguments: - cycle: String! (required) - filter: CommissionEventFilter (optional) - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) Signature: ```graphql commissionEvent(cycle: String!, filter: CommissionEventFilter, first: Int, after: String, last: Int, before: String): CommissionEventConnection! ``` ```graphql query commissionEvent($cycle: String!, $filter: CommissionEventFilter, $first: Int, $after: String, $last: Int, $before: String) { commissionEvent(cycle: $cycle, filter: $filter, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "cycle": "example", "filter": { "batchId": "example", "status": null }, "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "commissionEvent": { "nodes": { "id": "123", "batchId": "example", "status": {}, "agentUuid": "example", "providerName": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### commissionEventReport Returns a list of commission events found with the status required Arguments: - cycle: String! (required) - status: EventStatus! (required) - totalEvents: Int (optional) - sortOrder: String (optional) Signature: ```graphql commissionEventReport(cycle: String!, status: EventStatus!, totalEvents: Int, sortOrder: String): CommissionEventReport! ``` ```graphql query commissionEventReport($cycle: String!, $status: EventStatus!, $totalEvents: Int, $sortOrder: String) { commissionEventReport(cycle: $cycle, status: $status, totalEvents: $totalEvents, sortOrder: $sortOrder) { reportUrl } } ``` Variables: ```json { "cycle": "example", "status": "value", "totalEvents": 1, "sortOrder": "example" } ``` Sample response: ```json { "data": { "commissionEventReport": { "reportUrl": "example" } } } ``` ### creditMemo Retrieve a Credit Memo by id Arguments: - id: ID! (required) - Credit Memo UUID - locale: String (optional) - Locale Signature: ```graphql creditMemo(id: ID!, locale: String): CreditMemo! ``` ```graphql query creditMemo($id: ID!, $locale: String) { creditMemo(id: $id, locale: $locale) { id initialStatus status balanceStatus creditMemoNumber } } ``` Variables: ```json { "id": "123", "locale": "example" } ``` Sample response: ```json { "data": { "creditMemo": { "id": "123", "amountAvailable": {}, "amountUsed": {}, "creditMemoAppliedDate": {}, "creditMemoCreationDate": {} } } } ``` ### creditMemos Retrieve Credit Memos Arguments: - filter: CreditMemoFilter! (required) - Filters applied to the credit memo query - orderBy: [CreditMemoOrderBy] (optional) - Ordering applied to the credit memo query - first: Int (optional) - Number or elements to return (page size) - after: String (optional) - Returns elements after specified cursor, mutually exclusive with before - last: Int (optional) - Number or elements to return (page size) - before: String (optional) - Returns elements before specified cursor, mutually exclusive with after Signature: ```graphql creditMemos(filter: CreditMemoFilter!, orderBy: [CreditMemoOrderBy], first: Int, after: String, last: Int, before: String): CreditMemoAccountConnection! ``` ```graphql query creditMemos($filter: CreditMemoFilter!, $orderBy: [CreditMemoOrderBy], $first: Int, $after: String, $last: Int, $before: String) { creditMemos(filter: $filter, orderBy: $orderBy, first: $first, after: $after, last: $last, before: $before) { totalCount pageInfo nodes userErrors } } ``` Variables: ```json { "filter": { "creditMemoDateRange": "example", "creditMemoStatus": "example" }, "orderBy": [ { "field": null, "direction": null } ], "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "creditMemos": { "totalCount": 1, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "nodes": { "id": "123", "amountAvailable": {}, "amountUsed": {}, "creditMemoAppliedDate": {}, "creditMemoCreationDate": {} }, "userErrors": { "__typename": "InvalidScopeError" } } } } ``` ### curatedCompanyCatalog Arguments: - input: CuratedCompanyCatalogInput! (required) Signature: ```graphql curatedCompanyCatalog(input: CuratedCompanyCatalogInput!): CuratedCompanyCatalog! ``` ```graphql query curatedCompanyCatalog($input: CuratedCompanyCatalogInput!) { curatedCompanyCatalog(input: $input) { productIds } } ``` Variables: ```json { "input": { "companyId": "123" } } ``` Sample response: ```json { "data": { "curatedCompanyCatalog": { "productIds": "123" } } } ``` ### customer Retrieve a customer with the latest or all balance by id Arguments: - id: ID! (required) Signature: ```graphql customer(id: ID!): BalanceCustomer ``` ```graphql query customer($id: ID!) { customer(id: $id) { id createdOn payer merchantOfRecord balanceLedgers } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "customer": { "id": "123", "createdOn": {}, "payer": { "id": "123", "createdOn": {}, "user": {}, "account": {} }, "merchantOfRecord": { "id": "123", "createdOn": {}, "reference": "example", "type": "example" }, "balanceLedgers": { "id": "123", "createdOn": {}, "balance": {}, "transaction": {} } } } } ``` ### customerByUserAndAccountAndMerchant Retrieve a customer with the latest or all balance by user Id, account Id and Merchant of Record Arguments: - userId: ID (optional) - accountId: ID! (required) - merchantReference: String! (required) Signature: ```graphql customerByUserAndAccountAndMerchant(userId: ID, accountId: ID!, merchantReference: String!): BalanceCustomer ``` ```graphql query customerByUserAndAccountAndMerchant($userId: ID, $accountId: ID!, $merchantReference: String!) { customerByUserAndAccountAndMerchant(userId: $userId, accountId: $accountId, merchantReference: $merchantReference) { id createdOn payer merchantOfRecord balanceLedgers } } ``` Variables: ```json { "userId": "123", "accountId": "123", "merchantReference": "example" } ``` Sample response: ```json { "data": { "customerByUserAndAccountAndMerchant": { "id": "123", "createdOn": {}, "payer": { "id": "123", "createdOn": {}, "user": {}, "account": {} }, "merchantOfRecord": { "id": "123", "createdOn": {}, "reference": "example", "type": "example" }, "balanceLedgers": { "id": "123", "createdOn": {}, "balance": {}, "transaction": {} } } } } ``` ### customerDetailsByJobRunId Query to fetch information of IaaS job for specific count from RawUsages Signature: ```graphql customerDetailsByJobRunId: CustomerDetailsResponse ``` ```graphql query customerDetailsByJobRunId { customerDetailsByJobRunId { customerDetails } } ``` Sample response: ```json { "data": { "customerDetailsByJobRunId": { "customerDetails": { "accountId": "example", "totalUsages": 1, "estimatedCost": 1, "currency": "example", "domain": "example" } } } } ``` ### customersForMerchantOfRecord Retrieve all customer with the latest balance by Merchant of Record Arguments: - reference: String! (required) - first: Int (optional) - after: String (optional) - before: String (optional) Signature: ```graphql customersForMerchantOfRecord(reference: String!, first: Int, after: String, before: String): BalanceCustomerConnection! ``` ```graphql query customersForMerchantOfRecord($reference: String!, $first: Int, $after: String, $before: String) { customersForMerchantOfRecord(reference: $reference, first: $first, after: $after, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "reference": "example", "first": 10, "after": "cursor", "before": "example" } ``` Sample response: ```json { "data": { "customersForMerchantOfRecord": { "totalCount": 1, "nodes": { "id": "123", "createdOn": {}, "payer": {}, "merchantOfRecord": {}, "balanceLedgers": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### customerTotalBalanceByAccountAndMerchant Retrieves a ledger with the total balance for account Id and Merchant of Record This is a query only for powering the UI and should not be used for any other purpose as some field might not be populated. Arguments: - accountId: ID! (required) - merchantReference: String! (required) Signature: ```graphql customerTotalBalanceByAccountAndMerchant(accountId: ID!, merchantReference: String!): CustomerBalanceLedger ``` ```graphql query customerTotalBalanceByAccountAndMerchant($accountId: ID!, $merchantReference: String!) { customerTotalBalanceByAccountAndMerchant(accountId: $accountId, merchantReference: $merchantReference) { id createdOn balance transaction } } ``` Variables: ```json { "accountId": "123", "merchantReference": "example" } ``` Sample response: ```json { "data": { "customerTotalBalanceByAccountAndMerchant": { "id": "123", "createdOn": {}, "balance": {}, "transaction": { "id": "123", "createdOn": {}, "type": "example", "amount": {}, "target": {} } } } } ``` ### defaultBillingRelationship Read default billing relationship for tenant Arguments: - locale: Locale! (required) Signature: ```graphql defaultBillingRelationship(locale: Locale!): BillingRelationship! ``` ```graphql query defaultBillingRelationship($locale: Locale!) { defaultBillingRelationship(locale: $locale) { id status tenant label description } } ``` Variables: ```json { "locale": "value" } ``` Sample response: ```json { "data": { "defaultBillingRelationship": { "id": "123", "tenant": "example", "relationships": { "buyer": {}, "merchantOfRecord": {}, "payer": {}, "owner": {} }, "status": {}, "label": "example" } } } ``` ### distributorAccount Distributor Account Details Arguments: - accountId: String! (required) - Marketplace Account(company) id - distributorId: DistributorId! (required) Signature: ```graphql distributorAccount(accountId: String!, distributorId: DistributorId!): DistributorAccount ``` ```graphql query distributorAccount($accountId: String!, $distributorId: DistributorId!) { distributorAccount(accountId: $accountId, distributorId: $distributorId) { id sftpUserName connectionStatus userId accountId } } ``` Variables: ```json { "accountId": "example", "distributorId": "value" } ``` Sample response: ```json { "data": { "distributorAccount": { "id": "123", "createdOn": {}, "lastModifiedOn": {}, "userId": "example", "accountId": "example" } } } ``` ### distributorProductImports Fetch import product details Arguments: - first: Int (optional) - Number of results to fetch forwards - after: String (optional) - Cursor after which to fetch forwards - last: Int (optional) - Number of results to fetch backwards - before: String (optional) - Cursor before which to fetch backwards - filter: DistributorProductImportsFilter (optional) - Filter for imported product - orderBy: DistributorsProductsImportsOrderByInput (optional) - Sort filter Signature: ```graphql distributorProductImports(first: Int, after: String, last: Int, before: String, filter: DistributorProductImportsFilter, orderBy: DistributorsProductsImportsOrderByInput): DistributorProductImportsConnection ``` ```graphql query distributorProductImports($first: Int, $after: String, $last: Int, $before: String, $filter: DistributorProductImportsFilter, $orderBy: DistributorsProductsImportsOrderByInput) { distributorProductImports(first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount pageInfo nodes } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "distributorIds": null, "distributorDetails": null }, "orderBy": { "field": "example", "direction": null } } ``` Sample response: ```json { "data": { "distributorProductImports": { "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "nodes": { "id": "123", "distributorAccountId": "example", "distributorId": {}, "distributorMarket": {}, "distributorProductId": "example" } } } } ``` ### distributors Distributors' details Signature: ```graphql distributors: [Distributor!] ``` ```graphql query distributors { distributors { id name website logo defaultPriceType } } ``` Sample response: ```json { "data": { "distributors": { "id": "123", "name": "example", "website": "https://example.com", "logo": "https://example.com", "defaultPriceType": "example" } } } ``` ### distributorsProducts Paginated list of productDetail Arguments: - first: Int (optional) - Number of results to fetch forwards - after: String (optional) - Cursor after which to fetch forwards - last: Int (optional) - Number of results to fetch backwards - before: String (optional) - Cursor before which to fetch backwards - filter: DistributorsProductsFilter (optional) - Filter for listingData - orderBy: DistributorsProductsOrderByInput (optional) - Sort filter Signature: ```graphql distributorsProducts(first: Int, after: String, last: Int, before: String, filter: DistributorsProductsFilter, orderBy: DistributorsProductsOrderByInput): DistributorsProductsConnection ``` ```graphql query distributorsProducts($first: Int, $after: String, $last: Int, $before: String, $filter: DistributorsProductsFilter, $orderBy: DistributorsProductsOrderByInput) { distributorsProducts(first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount pageInfo nodes } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "ids": "123", "productSkuIds": "example" }, "orderBy": { "field": "example", "direction": null } } ``` Sample response: ```json { "data": { "distributorsProducts": { "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "nodes": { "id": "123", "distributorId": {}, "distributorMarket": {}, "type": {}, "createdOn": {} } } } } ``` ### distributorsProductsFiltersData Distributor Product List Filter Data Arguments: - distributorDetails: DistributorDetailsInput (optional) - distributorId Signature: ```graphql distributorsProductsFiltersData(distributorDetails: DistributorDetailsInput): DistributorsProductsFiltersData ``` ```graphql query distributorsProductsFiltersData($distributorDetails: DistributorDetailsInput) { distributorsProductsFiltersData(distributorDetails: $distributorDetails) { categories vendors } } ``` Variables: ```json { "distributorDetails": { "id": null, "markets": null } } ``` Sample response: ```json { "data": { "distributorsProductsFiltersData": { "categories": { "id": "example", "name": "example", "taggedProductsCount": 1, "subCategories": {} }, "vendors": { "id": "example", "name": "example", "taggedProductsCount": 1 } } } } ``` ### domainAvailability Arguments: - domain: String! (required) - country: String! (required) - resellerDomain: String (optional) Signature: ```graphql domainAvailability(domain: String!, country: String!, resellerDomain: String): DomainAvailabilityResponse! ``` ```graphql query domainAvailability($domain: String!, $country: String!, $resellerDomain: String) { domainAvailability(domain: $domain, country: $country, resellerDomain: $resellerDomain) { available } } ``` Variables: ```json { "domain": "example", "country": "example", "resellerDomain": "example" } ``` Sample response: ```json { "data": { "domainAvailability": { "available": true } } } ``` ### errorSummaryByCycle Returns a list of error descriptions and the number of commission event entities found with that value Arguments: - cycle: String! (required) Signature: ```graphql errorSummaryByCycle(cycle: String!): [CommissionEventErrorSummary!] ``` ```graphql query errorSummaryByCycle($cycle: String!) { errorSummaryByCycle(cycle: $cycle) { description totalEvents } } ``` Variables: ```json { "cycle": "example" } ``` Sample response: ```json { "data": { "errorSummaryByCycle": { "description": "example", "totalEvents": 1 } } } ``` ### eventsMissingByCycle Returns a list of missing commission event sequence ids found for the cycle provided Arguments: - cycle: String! (required) Signature: ```graphql eventsMissingByCycle(cycle: String!): [BatchMissingEvents]! ``` ```graphql query eventsMissingByCycle($cycle: String!) { eventsMissingByCycle(cycle: $cycle) { batchId totalEvents sequenceId } } ``` Variables: ```json { "cycle": "example" } ``` Sample response: ```json { "data": { "eventsMissingByCycle": { "batchId": "example", "totalEvents": 1, "sequenceId": "example" } } } ``` ### exchangeRate Returns requested exchange rate Arguments: - input: ExchangeRateInput! (required) Signature: ```graphql exchangeRate(input: ExchangeRateInput!): ExchangeRate ``` ```graphql query exchangeRate($input: ExchangeRateInput!) { exchangeRate(input: $input) { exchangeRate baseCurrency targetCurrency dateTime } } ``` Variables: ```json { "input": { "baseCurrency": null, "targetCurrency": null } } ``` Sample response: ```json { "data": { "exchangeRate": { "exchangeRate": {}, "baseCurrency": {}, "targetCurrency": {}, "dateTime": {} } } } ``` ### exportSearchIndexDocuments Arguments: - locale: Locale! (required) - tenant: String! (required) Signature: ```graphql exportSearchIndexDocuments(locale: Locale!, tenant: String!): ExportSearchIndexDocumentsResult! ``` ```graphql query exportSearchIndexDocuments($locale: Locale!, $tenant: String!) { exportSearchIndexDocuments(locale: $locale, tenant: $tenant) { exportLines } } ``` Variables: ```json { "locale": "value", "tenant": "example" } ``` Sample response: ```json { "data": { "exportSearchIndexDocuments": { "exportLines": {} } } } ``` ### failedInvoices Retrieve failed invoices Arguments: - first: Int (optional) - Denotes Page size - after: String (optional) - failed items after this cursor - before: String (optional) - failed items before this cursor, ignore if after is provided - sort: OrderDirection! (required) - Sort order - sortBy: FailedInvoiceOrderField! (required) - Sorting on field - searchText: String (optional) - Text filter to search by invoice number or failure reason - filter: FailedInvoiceFilter (optional) - Filtering based on the input Signature: ```graphql failedInvoices(first: Int, after: String, before: String, sort: OrderDirection!, sortBy: FailedInvoiceOrderField!, searchText: String, filter: FailedInvoiceFilter): FailedInvoiceConnection! ``` ```graphql query failedInvoices($first: Int, $after: String, $before: String, $sort: OrderDirection!, $sortBy: FailedInvoiceOrderField!, $searchText: String, $filter: FailedInvoiceFilter) { failedInvoices(first: $first, after: $after, before: $before, sort: $sort, sortBy: $sortBy, searchText: $searchText, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "sort": "value", "sortBy": "value", "searchText": "example", "filter": { "failedInvoiceDateRange": "example" } } ``` Sample response: ```json { "data": { "failedInvoices": { "totalCount": {}, "nodes": { "id": "123", "failureTimestamp": "2024-01-01", "failureReason": "example", "retryAttempts": {}, "lastRetryTimestamp": "2024-01-01" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### failedUsages Arguments: - jobId: String! (required) - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) Signature: ```graphql failedUsages(jobId: String!, first: Int, after: String, last: Int, before: String): FailedMeteredUsageConnection! ``` ```graphql query failedUsages($jobId: String!, $first: Int, $after: String, $last: Int, $before: String) { failedUsages(jobId: $jobId, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "jobId": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "failedUsages": { "nodes": { "requestGroupId": "example", "usageItemId": "example", "subscriptionId": "example", "developerId": "example", "description": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### fetchEligibleOffersForCustomer Arguments: - customerId: String! (required) - companyUuid: String! (required) Signature: ```graphql fetchEligibleOffersForCustomer(customerId: String!, companyUuid: String!): EligibleOfferResponse! ``` ```graphql query fetchEligibleOffersForCustomer($customerId: String!, $companyUuid: String!) { fetchEligibleOffersForCustomer(customerId: $customerId, companyUuid: $companyUuid) { statusCode eligibleOfferProductEntitlementDetails message } } ``` Variables: ```json { "customerId": "example", "companyUuid": "example" } ``` Sample response: ```json { "data": { "fetchEligibleOffersForCustomer": { "eligibleOfferProductEntitlementDetails": { "companyUuid": "example", "applicationUuid": "example", "productId": "example", "productName": "example", "editionLevelDetails": {} }, "statusCode": "example", "message": "example" } } } ``` ### fetchProductRecommendations Arguments: - input: AdobeRecommendationInput! (required) Signature: ```graphql fetchProductRecommendations(input: AdobeRecommendationInput!): AdobeProductRecommendationResponse ``` ```graphql query fetchProductRecommendations($input: AdobeRecommendationInput!) { fetchProductRecommendations(input: $input) { recommendationTrackerId productRecommendations } } ``` Variables: ```json { "input": { "companyUuid": "123", "currencyCode": "example" } } ``` Sample response: ```json { "data": { "fetchProductRecommendations": { "productRecommendations": { "upsells": {}, "crossSells": {}, "addOns": {} }, "recommendationTrackerId": "example" } } } ``` ### filteredUsageDetailsByJobRunId Query to fetch accountId, rawUsageId and iaasProvider of IaaS job for jobRunId from IaasUsageStatus Signature: ```graphql filteredUsageDetailsByJobRunId: FilteredUsageDetailsResponse ``` ```graphql query filteredUsageDetailsByJobRunId { filteredUsageDetailsByJobRunId { getFilteredUsageDetails } } ``` Sample response: ```json { "data": { "filteredUsageDetailsByJobRunId": { "getFilteredUsageDetails": "example" } } } ``` ### findPaginatedSubscriptionSyncRequests Arguments: - page: Int (optional) - size: Int (optional) - subscriptionUuid: String (optional) - microsoftSubscriptionUuid: String (optional) - companyName: String (optional) - status: String (optional) - startDate: Date (optional) - endDate: Date (optional) Signature: ```graphql findPaginatedSubscriptionSyncRequests(page: Int, size: Int, subscriptionUuid: String, microsoftSubscriptionUuid: String, companyName: String, status: String, startDate: Date, endDate: Date): MicrosoftSubscriptionSyncResponsePage ``` ```graphql query findPaginatedSubscriptionSyncRequests($page: Int, $size: Int, $subscriptionUuid: String, $microsoftSubscriptionUuid: String, $companyName: String, $status: String, $startDate: Date, $endDate: Date) { findPaginatedSubscriptionSyncRequests(page: $page, size: $size, subscriptionUuid: $subscriptionUuid, microsoftSubscriptionUuid: $microsoftSubscriptionUuid, companyName: $companyName, status: $status, startDate: $startDate, endDate: $endDate) { totalCount nodes pageMeta } } ``` Variables: ```json { "page": 1, "size": 1, "subscriptionUuid": "example", "microsoftSubscriptionUuid": "example", "companyName": "example", "status": "example", "startDate": "2024-01-01", "endDate": "2024-01-01" } ``` Sample response: ```json { "data": { "findPaginatedSubscriptionSyncRequests": { "totalCount": 1, "nodes": { "requestUuid": "example", "status": "example", "partner": "example", "country": "example", "tenantId": "example" }, "pageMeta": { "pageSize": 1, "hasNextPage": true, "offset": 1, "hasPreviousPage": true } } } } ``` ### function Function by id. Arguments: - id: ID! (required) Signature: ```graphql function(id: ID!): Function! ``` ```graphql query function($id: ID!) { function(id: $id) { id name status tenant active } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "function": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "name": "example" } } } ``` ### functions Paginated list of functions for a tenant. Arguments: - filter: FunctionsFilter (optional) - Filter to apply to list of functions. - orderBy: FunctionsOrderBy (optional) - Sorting order for the result. - first: Int (optional) - Number of results to fetch forwards. - after: String (optional) - Cursor after which to fetch forwards. - last: Int (optional) - Number of results to fetch backwards. - before: String (optional) - Cursor before which to fetch backwards. Signature: ```graphql functions(filter: FunctionsFilter, orderBy: FunctionsOrderBy, first: Int, after: String, last: Int, before: String): FunctionConnection! ``` ```graphql query functions($filter: FunctionsFilter, $orderBy: FunctionsOrderBy, $first: Int, $after: String, $last: Int, $before: String) { functions(filter: $filter, orderBy: $orderBy, first: $first, after: $after, last: $last, before: $before) { totalCount pageInfo nodes } } ``` Variables: ```json { "filter": { "tenant": "example", "active": true }, "orderBy": { "direction": null, "field": null }, "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "functions": { "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "nodes": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "name": "example" } } } } ``` ### getSubscriptionAndSkuDetails Fetch Subscription Details along with Edition Code and Renewal Mapping Arguments: - subscriptionId: String (optional) Signature: ```graphql getSubscriptionAndSkuDetails(subscriptionId: String): SubscriptionRenewalDetailsResponse ``` ```graphql query getSubscriptionAndSkuDetails($subscriptionId: String) { getSubscriptionAndSkuDetails(subscriptionId: $subscriptionId) { planName statusCode message renewalDate subscription } } ``` Variables: ```json { "subscriptionId": "example" } ``` Sample response: ```json { "data": { "getSubscriptionAndSkuDetails": { "subscription": { "customerId": "example", "renewalSettings": {}, "seats": {}, "skuId": "example", "skuName": "example" }, "renewalPricingEdition": { "renewalSetting": "example", "editionCode": "example", "pricingPlanId": "example" }, "statusCode": "example", "message": "example", "planName": "example" } } } ``` ### gmvBalance Returns the GMV balance amount for a given tenant and currency, between two dates Arguments: - tenant: String! (required) - dateFrom: Date! (required) - dateTo: Date! (required) - currency: String! (required) Signature: ```graphql gmvBalance(tenant: String!, dateFrom: Date!, dateTo: Date!, currency: String!): GmvBalanceResponse! ``` ```graphql query gmvBalance($tenant: String!, $dateFrom: Date!, $dateTo: Date!, $currency: String!) { gmvBalance(tenant: $tenant, dateFrom: $dateFrom, dateTo: $dateTo, currency: $currency) { accrualBalance cashBalance dateFrom dateTo currency } } ``` Variables: ```json { "tenant": "example", "dateFrom": "2024-01-01", "dateTo": "2024-01-01", "currency": "example" } ``` Sample response: ```json { "data": { "gmvBalance": { "accrualBalance": 1, "cashBalance": 1, "dateFrom": "2024-01-01", "dateTo": "2024-01-01", "currency": "example" } } } ``` ### iaasJobDetailsWithJobRunParameters Fetch JobRunDetails by JobRunId from MySql Signature: ```graphql iaasJobDetailsWithJobRunParameters: IAASJobDetailsWithJobRunParameters ``` ```graphql query iaasJobDetailsWithJobRunParameters { iaasJobDetailsWithJobRunParameters { azureIaaSJobDetailsWithJobRunParameters } } ``` Sample response: ```json { "data": { "iaasJobDetailsWithJobRunParameters": { "azureIaaSJobDetailsWithJobRunParameters": { "jobRunId": "123", "partner": "example", "isv": "example", "connectorStatus": "example", "jobParameters": "example" } } } } ``` ### iaasJobs Query to fetch all IaaSJobs Signature: ```graphql iaasJobs: IAASJobs ``` ```graphql query iaasJobs { iaasJobs { azureIaaSJobs gcpIaaSJobs } } ``` Sample response: ```json { "data": { "iaasJobs": { "azureIaaSJobs": { "nodes": {}, "pageInfo": {}, "totalCount": 1 }, "gcpIaaSJobs": { "nodes": {}, "pageInfo": {}, "totalCount": 1 } } } } ``` ### inventory Query to fetch inventory by ID Arguments: - id: ID! (required) - Inventory record ID Signature: ```graphql inventory(id: ID!): Inventory ``` ```graphql query inventory($id: ID!) { inventory(id: $id) { id editionCode sku stock vendorId } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "inventory": { "id": "123", "editionCode": "example", "sku": "example", "stock": 1, "vendorId": "123" } } } ``` ### inventoryByEditionCode Query to fetch inventory by edition code Arguments: - editionCode: String! (required) - Product edition code - vendorId: ID! (required) - Product vendor id Signature: ```graphql inventoryByEditionCode(editionCode: String!, vendorId: ID!): Inventory ``` ```graphql query inventoryByEditionCode($editionCode: String!, $vendorId: ID!) { inventoryByEditionCode(editionCode: $editionCode, vendorId: $vendorId) { id editionCode sku stock vendorId } } ``` Variables: ```json { "editionCode": "example", "vendorId": "123" } ``` Sample response: ```json { "data": { "inventoryByEditionCode": { "id": "123", "editionCode": "example", "sku": "example", "stock": 1, "vendorId": "123" } } } ``` ### inventoryRulesConfiguration Query to fetch inventory rule configuration Signature: ```graphql inventoryRulesConfiguration: InventoryRulesConfiguration ``` ```graphql query inventoryRulesConfiguration { inventoryRulesConfiguration { shouldValidateInventory shouldDisplayStockCount } } ``` Sample response: ```json { "data": { "inventoryRulesConfiguration": { "shouldValidateInventory": true, "shouldDisplayStockCount": true } } } ``` ### invoice Retrieve an invoice by id Arguments: - id: ID! (required) - locale: Locale (optional) Signature: ```graphql invoice(id: ID!, locale: Locale): Invoice! ``` ```graphql query invoice($id: ID!, $locale: Locale) { invoice(id: $id, locale: $locale) { id status balanceStatus localized displayTaxBreakdown } } ``` Variables: ```json { "id": "123", "locale": "value" } ``` Sample response: ```json { "data": { "invoice": { "id": "123", "locale": {}, "localized": true, "displayTaxBreakdown": true, "invoiceNumber": "example" } } } ``` ### invoices Retrieve invoices Arguments: - scope: String! (required) - The scope of the requested invoices. One of CLUSTER, MARKETPLACE, COMPANY, USER, RESELLER - filter: InvoiceFilter (optional) - Filters applied to the invoice query - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, mutually exclusive with before - before: String (optional) - Returns elements before specified cursor, mutually exclusive with after - sort: InvoiceSort (optional) - Sorting criteria for the invoices Signature: ```graphql invoices(scope: String!, filter: InvoiceFilter, first: Int, after: String, before: String, sort: InvoiceSort): InvoiceConnection! ``` ```graphql query invoices($scope: String!, $filter: InvoiceFilter, $first: Int, $after: String, $before: String, $sort: InvoiceSort) { invoices(scope: $scope, filter: $filter, first: $first, after: $after, before: $before, sort: $sort) { totalCount nodes pageInfo } } ``` Variables: ```json { "scope": "example", "filter": { "onlyOverdueInvoices": true, "status": "example" }, "first": 10, "after": "cursor", "before": "example", "sort": { "fields": "example" } } ``` Sample response: ```json { "data": { "invoices": { "totalCount": 1, "nodes": { "id": "123", "locale": {}, "localized": true, "displayTaxBreakdown": true, "invoiceNumber": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### jobDetailsByJobId Query to fetch job details by jobId Signature: ```graphql jobDetailsByJobId: IAASJobResponse ``` ```graphql query jobDetailsByJobId { jobDetailsByJobId { azureIaaSJob gcpIaaSJob } } ``` Sample response: ```json { "data": { "jobDetailsByJobId": { "azureIaaSJob": { "jobId": "123", "partner": "example", "isv": "example", "connectorStatus": "example", "usagesRead": 1 }, "gcpIaaSJob": { "jobId": "123", "partner": "example", "isv": "example", "connectorStatus": "example", "usagesRead": 1 } } } } ``` ### jobDetailsByJobIdStatusPartner Query to fetch information of IaaS job for specific jobRunId and status and partner Signature: ```graphql jobDetailsByJobIdStatusPartner: IAASJobRunDetailsResponse ``` ```graphql query jobDetailsByJobIdStatusPartner { jobDetailsByJobIdStatusPartner { azureIaaSJobRunDetails } } ``` Sample response: ```json { "data": { "jobDetailsByJobIdStatusPartner": { "azureIaaSJobRunDetails": { "jobRunId": "123", "usageMonth": "example", "partner": "example", "status": "example", "createdOn": {} } } } } ``` ### jobDetailsByJobRunId Fetch JobRunDetails by JobRunId from jobRun Collection Signature: ```graphql jobDetailsByJobRunId: IAASJobDetailsByJobRunId ``` ```graphql query jobDetailsByJobRunId { jobDetailsByJobRunId { azureIaaSJobRunDetailsByJobRunId } } ``` Sample response: ```json { "data": { "jobDetailsByJobRunId": { "azureIaaSJobRunDetailsByJobRunId": { "jobRunId": "123", "usageMonth": "example", "partner": "example", "status": "example", "createdOn": {} } } } } ``` ### jobDetailsResponseByJobExecutionId Query to hold information of IaaS job for specific JobExecutionId Signature: ```graphql jobDetailsResponseByJobExecutionId: IAASJobDetailsResponse ``` ```graphql query jobDetailsResponseByJobExecutionId { jobDetailsResponseByJobExecutionId { azureIaaSJobDetails } } ``` Sample response: ```json { "data": { "jobDetailsResponseByJobExecutionId": { "azureIaaSJobDetails": { "jobRunId": "123", "jobExecutionId": "123", "batchJobDetails": {}, "fileTypeCount": {}, "statusCount": {} } } } } ``` ### jobStatusByJobId Query to fetch information of IaaS job for specific jobRunId and status Signature: ```graphql jobStatusByJobId: IAASStatusDataResponse ``` ```graphql query jobStatusByJobId { jobStatusByJobId { azureIaaSJobStatus } } ``` Sample response: ```json { "data": { "jobStatusByJobId": { "azureIaaSJobStatus": { "jobRunId": "123", "customerDetails": {}, "status": "example", "totalUsageCount": 1, "totalAccountCount": 1 } } } } ``` ### marketplaceProduct Query a marketplace product Arguments: - id: ID! (required) - Product ID - version: String! (required) - Product version to query for - currency: Currency (optional) - Currency used for externalSourcePrices Signature: ```graphql marketplaceProduct(id: ID!, version: String!, currency: Currency): MarketplaceProduct! ``` ```graphql query marketplaceProduct($id: ID!, $version: String!, $currency: Currency) { marketplaceProduct(id: $id, version: $version, currency: $currency) { id name version supplierId externalSource } } ``` Variables: ```json { "id": "123", "version": "example", "currency": "value" } ``` Sample response: ```json { "data": { "marketplaceProduct": { "id": "123", "variantOptions": { "code": "example", "name": "example", "values": {}, "defaultValue": {}, "inputType": {} }, "variants": { "id": "123", "version": "example", "editionId": "123", "configuration": {}, "isEnabled": true }, "version": "example", "name": "example" } } } ``` ### me Retrieve details of currently logged-in user Signature: ```graphql me: User ``` ```graphql query me { me { id firstName lastName username title } } ``` Sample response: ```json { "data": { "me": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" } } } ``` ### microsoftSubscriptionSyncStatus Arguments: - subscriptionUuid: String! (required) Signature: ```graphql microsoftSubscriptionSyncStatus(subscriptionUuid: String!): [MicrosoftSubscriptionSyncResponse] ``` ```graphql query microsoftSubscriptionSyncStatus($subscriptionUuid: String!) { microsoftSubscriptionSyncStatus(subscriptionUuid: $subscriptionUuid) { offerName companyName status requestUuid partner } } ``` Variables: ```json { "subscriptionUuid": "example" } ``` Sample response: ```json { "data": { "microsoftSubscriptionSyncStatus": { "requestUuid": "example", "status": "example", "partner": "example", "country": "example", "tenantId": "example" } } } ``` ### notificationOptOutsByMethodAndTarget Returns paginated list of opted out notifications for given notification delivery method and target Arguments: - method: NotificationDeliveryMethod! (required) - Method used for notification Delivery can be EMAIL or SMS - target: String! (required) - Target can be an email address for EMAIL delivery method or phone number for SMS delivery method - first: Int (optional) - Number of elements to return from start of a cursor - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return before a cursor or end - before: String (optional) - Returns elements before specified cursor Signature: ```graphql notificationOptOutsByMethodAndTarget(method: NotificationDeliveryMethod!, target: String!, first: Int, after: String, last: Int, before: String): NotificationOptOutsByMethodAndTargetConnection! ``` ```graphql query notificationOptOutsByMethodAndTarget($method: NotificationDeliveryMethod!, $target: String!, $first: Int, $after: String, $last: Int, $before: String) { notificationOptOutsByMethodAndTarget(method: $method, target: $target, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "method": "value", "target": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "notificationOptOutsByMethodAndTarget": { "nodes": { "method": {}, "type": {}, "target": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### notificationOptOutsByMethodAndType Returns paginated list of opted out notifications for given notification delivery method and notification type Arguments: - method: NotificationDeliveryMethod! (required) - Method used for notification Delivery can be EMAIL or SMS - type: NotificationType! (required) - Type of the Notification for which opt outs to be listed - first: Int (optional) - Number of elements to return from start of a cursor - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return before a cursor or end - before: String (optional) - Returns elements before specified cursor Signature: ```graphql notificationOptOutsByMethodAndType(method: NotificationDeliveryMethod!, type: NotificationType!, first: Int, after: String, last: Int, before: String): NotificationOptOutsByMethodAndTypeConnection! ``` ```graphql query notificationOptOutsByMethodAndType($method: NotificationDeliveryMethod!, $type: NotificationType!, $first: Int, $after: String, $last: Int, $before: String) { notificationOptOutsByMethodAndType(method: $method, type: $type, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "method": "value", "type": "value", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "notificationOptOutsByMethodAndType": { "nodes": { "method": {}, "type": {}, "target": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### notificationOptOutSettings Returns opted out notification for given notification delivery method, notification type and target Arguments: - method: NotificationDeliveryMethod! (required) - Method used for notification Delivery can be EMAIL or SMS - type: NotificationType! (required) - Type of the Notification for which opt outs to be listed - target: String! (required) - Target can be an email address for EMAIL delivery method or phone number for SMS delivery method Signature: ```graphql notificationOptOutSettings(method: NotificationDeliveryMethod!, type: NotificationType!, target: String!): NotificationOptOutSettings! ``` ```graphql query notificationOptOutSettings($method: NotificationDeliveryMethod!, $type: NotificationType!, $target: String!) { notificationOptOutSettings(method: $method, type: $type, target: $target) { isOptedOut optOut } } ``` Variables: ```json { "method": "value", "type": "value", "target": "example" } ``` Sample response: ```json { "data": { "notificationOptOutSettings": { "isOptedOut": true, "optOut": { "method": {}, "type": {}, "target": "example" } } } } ``` ### notificationTemplatesByType Returns a list of notification templates for a given notification delivery method and type. Arguments: - method: NotificationDeliveryMethod! (required) - The method used to deliver the notification: EMAIL or SMS. - type: NotificationType! (required) - The type of notification (this generally corresponds to an event). Signature: ```graphql notificationTemplatesByType(method: NotificationDeliveryMethod!, type: NotificationType!): NotificationTemplatesByType! ``` ```graphql query notificationTemplatesByType($method: NotificationDeliveryMethod!, $type: NotificationType!) { notificationTemplatesByType(method: $method, type: $type) { templates } } ``` Variables: ```json { "method": "value", "type": "value" } ``` Sample response: ```json { "data": { "notificationTemplatesByType": { "templates": { "id": "123", "name": "example", "subject": "example", "content": "example", "locale": "example" } } } } ``` ### payment Retrieve a payment by id Arguments: - id: ID! (required) - The payment uuid Signature: ```graphql payment(id: ID!): Payment ``` ```graphql query payment($id: ID!) { payment(id: $id) { id status balanceStatus paymentNumber jbillingPaymentId } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "payment": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} } } } ``` ### paymentByPaymentNumber Retrieve a payment by payment number Arguments: - paymentNumber: String! (required) - The payment number Signature: ```graphql paymentByPaymentNumber(paymentNumber: String!): Payment ``` ```graphql query paymentByPaymentNumber($paymentNumber: String!) { paymentByPaymentNumber(paymentNumber: $paymentNumber) { id status balanceStatus paymentNumber jbillingPaymentId } } ``` Variables: ```json { "paymentNumber": "example" } ``` Sample response: ```json { "data": { "paymentByPaymentNumber": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} } } } ``` ### paymentMethods Retrieve payment methods by party type, party id, company uuid, user uuid Arguments: - partyType: String! (required) - The party type (COMPANY or USER) - partyId: String! (required) - The party id - companyUuid: String (optional) - The company uuid - userUuid: String (optional) - The user uuid Signature: ```graphql paymentMethods(partyType: String!, partyId: String!, companyUuid: String, userUuid: String): [PaymentMethod] ``` ```graphql query paymentMethods($partyType: String!, $partyId: String!, $companyUuid: String, $userUuid: String) { paymentMethods(partyType: $partyType, partyId: $partyId, companyUuid: $companyUuid, userUuid: $userUuid) { id status paymentMethodType accountDisplay isDefault } } ``` Variables: ```json { "partyType": "example", "partyId": "example", "companyUuid": "example", "userUuid": "example" } ``` Sample response: ```json { "data": { "paymentMethods": { "id": "123", "paymentMethodType": "example", "accountDisplay": "example", "isDefault": true, "billingAddress": { "city": "example", "country": "example", "state": "example", "phone": "example", "street1": "example" } } } } ``` ### payments Retrieve list of payments by marketplace Arguments: - first: Int (optional) - Number or elements to return (page size) - after: String (optional) - Returns elements after specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - orderBy: [PaymentOrderBy] (optional) - Specifies the field by which to order by and the direction. - filter: PaymentsFilter (optional) - Filter data based on the different criteria(Search, Status, Date, Amount). Signature: ```graphql payments(first: Int, after: String, before: String, orderBy: [PaymentOrderBy], filter: PaymentsFilter): PaymentConnection! ``` ```graphql query payments($first: Int, $after: String, $before: String, $orderBy: [PaymentOrderBy], $filter: PaymentsFilter) { payments(first: $first, after: $after, before: $before, orderBy: $orderBy, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "orderBy": [ { "field": null, "direction": null } ], "filter": { "search": "example", "status": null } } ``` Sample response: ```json { "data": { "payments": { "totalCount": 1, "nodes": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### paymentsByCompanyId Retrieve list of payments by companyId Arguments: - first: Int (optional) - Number or elements to return (page size) - after: String (optional) - Returns elements after specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - companyId: ID! (required) - Company identifier - orderBy: [PaymentOrderBy] (optional) - Specifies the field by which to order by and the direction. - filter: PaymentsFilter (optional) - Filter data based on the different criteria(Search, Status, Date, Amount). Signature: ```graphql paymentsByCompanyId(first: Int, after: String, before: String, companyId: ID!, orderBy: [PaymentOrderBy], filter: PaymentsFilter): PaymentConnection! ``` ```graphql query paymentsByCompanyId($first: Int, $after: String, $before: String, $companyId: ID!, $orderBy: [PaymentOrderBy], $filter: PaymentsFilter) { paymentsByCompanyId(first: $first, after: $after, before: $before, companyId: $companyId, orderBy: $orderBy, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "companyId": "123", "orderBy": [ { "field": null, "direction": null } ], "filter": { "search": "example", "status": null } } ``` Sample response: ```json { "data": { "paymentsByCompanyId": { "totalCount": 1, "nodes": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### paymentsByUserAndCompanyId Retrieve list of payments by companyId and userId Arguments: - first: Int (optional) - Number or elements to return (page size) - after: String (optional) - Returns elements after specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor. eg bnVtYmVyPTAmc2l6ZT0xMA== - companyId: ID! (required) - Company identifier - userId: ID! (required) - User identifier - orderBy: [PaymentOrderBy] (optional) - Specifies the field by which to order by and the direction. - filter: PaymentsFilter (optional) - Filter data based on the different criteria(Search, Status, Date, Amount). Signature: ```graphql paymentsByUserAndCompanyId(first: Int, after: String, before: String, companyId: ID!, userId: ID!, orderBy: [PaymentOrderBy], filter: PaymentsFilter): PaymentConnection! ``` ```graphql query paymentsByUserAndCompanyId($first: Int, $after: String, $before: String, $companyId: ID!, $userId: ID!, $orderBy: [PaymentOrderBy], $filter: PaymentsFilter) { paymentsByUserAndCompanyId(first: $first, after: $after, before: $before, companyId: $companyId, userId: $userId, orderBy: $orderBy, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "companyId": "123", "userId": "123", "orderBy": [ { "field": null, "direction": null } ], "filter": { "search": "example", "status": null } } ``` Sample response: ```json { "data": { "paymentsByUserAndCompanyId": { "totalCount": 1, "nodes": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### product Query a product Arguments: - id: ID! (required) - Product ID - version: String! (required) - Product version to query for Signature: ```graphql product(id: ID!, version: String!): Product ``` ```graphql query product($id: ID!, $version: String!) { product(id: $id, version: $version) { id name vendorName version vendorId } } ``` Variables: ```json { "id": "123", "version": "example" } ``` Sample response: ```json { "data": { "product": { "id": "123", "version": "example", "vendor": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "type": {}, "name": { "locale": {}, "value": "example" } } } } ``` ### productDeletionProcess Query the deletion process of a product Arguments: - id: ID! (required) - Process id Signature: ```graphql productDeletionProcess(id: ID!): ProductDeletionProcess ``` ```graphql query productDeletionProcess($id: ID!) { productDeletionProcess(id: $id) { id status productId triggeredOn startedOn } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "productDeletionProcess": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } ``` ### productEditionAssociations List all associations for a marketplace Arguments: - tenant: String (optional) - The tenant for the marketplace - first: Int (optional) - The number of items to return after the given after cursor. Defaults to 10 if both first and last are not specified. - after: String (optional) - Cursor from connection. Defaults to beginning of list if not specified in combination with first. - last: Int (optional) - The number of items to return before the given before cursor - before: String (optional) - Cursor from connection. Defaults to end of list if not specified in combination with last. Signature: ```graphql productEditionAssociations(tenant: String, first: Int, after: String, last: Int, before: String): ProductEditionAssociationConnection! ``` ```graphql query productEditionAssociations($tenant: String, $first: Int, $after: String, $last: Int, $before: String) { productEditionAssociations(tenant: $tenant, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "tenant": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "productEditionAssociations": { "nodes": { "id": "123", "productEdition": {}, "requiresAllOf": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### productIntegration Query product integrations by integration ref ID and version. Arguments: - id: ID! (required) - Unique identifier of the product integration. - version: String! (required) - Product integration version. Signature: ```graphql productIntegration(id: ID!, version: String!): ProductIntegration ``` ```graphql query productIntegration($id: ID!, $version: String!) { productIntegration(id: $id, version: $version) { id name eventStatusUrl version partner } } ``` Variables: ```json { "id": "123", "version": "example" } ``` Sample response: ```json { "data": { "productIntegration": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} } } } ``` ### productIntegrationsByVendorId Query product integrations by vendor identifier. Arguments: - vendorId: ID (optional) - Unique identifier of the product vendor. - version: String! (required) - Product integration version. - first: Int (optional) - Number of results to return (page size) after the specified *after* cursor. - after: String (optional) - Return results after this cursor. If null, return results starting at the beginning of the collection. - last: Int (optional) - Number of results to return (page size) before the specified *before* cursor. - before: String (optional) - Return results before this cursor. If null, return results starting at the end of the collection. Signature: ```graphql productIntegrationsByVendorId(vendorId: ID, version: String!, first: Int, after: String, last: Int, before: String): ProductIntegrationConnection ``` ```graphql query productIntegrationsByVendorId($vendorId: ID, $version: String!, $first: Int, $after: String, $last: Int, $before: String) { productIntegrationsByVendorId(vendorId: $vendorId, version: $version, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "vendorId": "123", "version": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "productIntegrationsByVendorId": { "totalCount": 1, "nodes": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### productPublicationProcess Query the publication process of a product Arguments: - id: ID! (required) - Process id Signature: ```graphql productPublicationProcess(id: ID!): ProductPublicationProcess ``` ```graphql query productPublicationProcess($id: ID!) { productPublicationProcess(id: $id) { id status productId triggeredOn startedOn } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "productPublicationProcess": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } ``` ### productRecommendations Retrieves the product recommendations Arguments: - input: ProductRecommendationsInput! (required) Signature: ```graphql productRecommendations(input: ProductRecommendationsInput!): [ProductRecommendation!]! ``` ```graphql query productRecommendations($input: ProductRecommendationsInput!) { productRecommendations(input: $input) { category product reviewStats pricing source } } ``` Variables: ```json { "input": { "locale": null, "context": null } } ``` Sample response: ```json { "data": { "productRecommendations": { "category": {}, "product": { "id": "123", "type": {}, "name": "example", "vendor": {}, "vendorName": "example" }, "reviewStats": { "reviewCount": 1, "averageRating": 1 }, "pricing": { "startingPrice": {} }, "source": {} } } } ``` ### products Query products by tenant Arguments: - tenant: String (optional) - tenant - version: String! (required) - Product version to query for - first: Int (optional) - Number of results to return - after: String (optional) - Paginated result - After this point - last: Int (optional) - Number of items to return before the given before cursor - before: String (optional) - Paginated result - Before this point Signature: ```graphql products(tenant: String, version: String!, first: Int, after: String, last: Int, before: String): ProductConnection ``` ```graphql query products($tenant: String, $version: String!, $first: Int, $after: String, $last: Int, $before: String) { products(tenant: $tenant, version: $version, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "tenant": "example", "version": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "products": { "totalCount": 1, "nodes": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### productsByVendorId Query products by vendor ID Arguments: - vendorId: ID (optional) - Vendor ID - version: String! (required) - Product version to query for - first: Int (optional) - Number of results to return - after: String (optional) - Paginated result - After this point - last: Int (optional) - Number of items to return before the given before cursor - before: String (optional) - Paginated result - Before this point Signature: ```graphql productsByVendorId(vendorId: ID, version: String!, first: Int, after: String, last: Int, before: String): ProductConnection! ``` ```graphql query productsByVendorId($vendorId: ID, $version: String!, $first: Int, $after: String, $last: Int, $before: String) { productsByVendorId(vendorId: $vendorId, version: $version, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "vendorId": "123", "version": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "productsByVendorId": { "totalCount": 1, "nodes": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### productSearchSettings Arguments: - useProductionVersion: Boolean! (required) Signature: ```graphql productSearchSettings(useProductionVersion: Boolean!): ProductSearchSettings! ``` ```graphql query productSearchSettings($useProductionVersion: Boolean!) { productSearchSettings(useProductionVersion: $useProductionVersion) { fields lastPublished algorithmVersion } } ``` Variables: ```json { "useProductionVersion": true } ``` Sample response: ```json { "data": { "productSearchSettings": { "fields": { "name": "example", "boostValue": 1, "description": "example", "status": {} }, "lastPublished": {}, "algorithmVersion": {} } } } ``` ### productUnpublicationProcess Query the unpublication process of a product Arguments: - id: ID! (required) - Process id Signature: ```graphql productUnpublicationProcess(id: ID!): ProductUnpublicationProcess ``` ```graphql query productUnpublicationProcess($id: ID!) { productUnpublicationProcess(id: $id) { id status productId triggeredOn startedOn } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "productUnpublicationProcess": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } ``` ### productVariantsCreationProcess Query the variants creation process Arguments: - id: ID! (required) - The process id Signature: ```graphql productVariantsCreationProcess(id: ID!): ProductVariantsCreationProcess! ``` ```graphql query productVariantsCreationProcess($id: ID!) { productVariantsCreationProcess(id: $id) { id triggeredOn startedOn completedOn product } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "productVariantsCreationProcess": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} } } } } ``` ### productVariantsCreationProcessByProductRefId Query the variants creation process by product ref id Arguments: - productRefId: ID! (required) - The product ref id Signature: ```graphql productVariantsCreationProcessByProductRefId(productRefId: ID!): ProductVariantsCreationProcess! ``` ```graphql query productVariantsCreationProcessByProductRefId($productRefId: ID!) { productVariantsCreationProcessByProductRefId(productRefId: $productRefId) { id triggeredOn startedOn completedOn product } } ``` Variables: ```json { "productRefId": "123" } ``` Sample response: ```json { "data": { "productVariantsCreationProcessByProductRefId": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} } } } } ``` ### program Arguments: - type: String! (required) Signature: ```graphql program(type: String!): Program! ``` ```graphql query program($type: String!) { program(type: $type) { status description type settings questionnaire } } ``` Variables: ```json { "type": "example" } ``` Sample response: ```json { "data": { "program": { "type": {}, "status": "example", "description": "example", "settings": { "__typename": "DeveloperProgramSettings" }, "questionnaire": { "steps": {}, "fields": {} } } } } ``` ### programApplicants Arguments: - filter: ProgramApplicantFilter (optional) - orderBy: ProgramApplicantOrderBy (optional) - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) - searchTerm: String (optional) Signature: ```graphql programApplicants(filter: ProgramApplicantFilter, orderBy: ProgramApplicantOrderBy, first: Int, after: String, last: Int, before: String, searchTerm: String): ProgramApplicantConnection! ``` ```graphql query programApplicants($filter: ProgramApplicantFilter, $orderBy: ProgramApplicantOrderBy, $first: Int, $after: String, $last: Int, $before: String, $searchTerm: String) { programApplicants(filter: $filter, orderBy: $orderBy, first: $first, after: $after, last: $last, before: $before, searchTerm: $searchTerm) { totalCount nodes pageInfo } } ``` Variables: ```json { "filter": { "programType": "example" }, "orderBy": { "field": null, "direction": null }, "first": 10, "after": "cursor", "last": 1, "before": "example", "searchTerm": "example" } ``` Sample response: ```json { "data": { "programApplicants": { "nodes": { "id": "123", "programType": {}, "answers": {}, "status": {}, "appliedOn": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### psaAgreementsByCompanyId Arguments: - psaCompanyId: ID! (required) - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) Signature: ```graphql psaAgreementsByCompanyId(psaCompanyId: ID!, connectorType: PsaConnectorType, mor: PsaMorInput!): [PsaAgreement]! ``` ```graphql query psaAgreementsByCompanyId($psaCompanyId: ID!, $connectorType: PsaConnectorType, $mor: PsaMorInput!) { psaAgreementsByCompanyId(psaCompanyId: $psaCompanyId, connectorType: $connectorType, mor: $mor) { id name } } ``` Variables: ```json { "psaCompanyId": "123", "connectorType": "value", "mor": { "type": null, "identifier": "example" } } ``` Sample response: ```json { "data": { "psaAgreementsByCompanyId": { "id": "123", "name": "example" } } } ``` ### psaCompaniesByName Get psa companies by psa company name Arguments: - name: String! (required) - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) Signature: ```graphql psaCompaniesByName(name: String!, connectorType: PsaConnectorType, mor: PsaMorInput!): [PsaCompany]! ``` ```graphql query psaCompaniesByName($name: String!, $connectorType: PsaConnectorType, $mor: PsaMorInput!) { psaCompaniesByName(name: $name, connectorType: $connectorType, mor: $mor) { id name } } ``` Variables: ```json { "name": "example", "connectorType": "value", "mor": { "type": null, "identifier": "example" } } ``` Sample response: ```json { "data": { "psaCompaniesByName": { "id": "123", "name": "example" } } } ``` ### psaCompanyMappings Read all available company mapping Arguments: - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) - first: Int (optional) - Number of elements to return (page size) in forward direction. Default is 10 - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return (page size) in backward direction. Default is 10 - before: String (optional) - Returns elements before specified cursor - filter: PsaCompanyMappingsFilter (optional) - Criteria to filter company mappings - orderBy: PsaCompanyMappingsOrderBy (optional) - Criteria to sort company mappings Signature: ```graphql psaCompanyMappings(connectorType: PsaConnectorType, mor: PsaMorInput!, first: Int, after: String, last: Int, before: String, filter: PsaCompanyMappingsFilter, orderBy: PsaCompanyMappingsOrderBy): PsaCompanyMappingsConnection! ``` ```graphql query psaCompanyMappings($connectorType: PsaConnectorType, $mor: PsaMorInput!, $first: Int, $after: String, $last: Int, $before: String, $filter: PsaCompanyMappingsFilter, $orderBy: PsaCompanyMappingsOrderBy) { psaCompanyMappings(connectorType: $connectorType, mor: $mor, first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "connectorType": "value", "mor": { "type": null, "identifier": "example" }, "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "companyName": "example", "psaCompanyName": "example" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "psaCompanyMappings": { "totalCount": 1, "nodes": { "id": "123", "accountId": "123", "mor": {}, "tenant": "example", "connectorType": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### psaConnectorConfiguration Read all the connector configurations for a connector Arguments: - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) Signature: ```graphql psaConnectorConfiguration(connectorType: PsaConnectorType, mor: PsaMorInput!): PsaConnectorConfigurationResult! ``` ```graphql query psaConnectorConfiguration($connectorType: PsaConnectorType, $mor: PsaMorInput!) { psaConnectorConfiguration(connectorType: $connectorType, mor: $mor) { connectorConfiguration userErrors } } ``` Variables: ```json { "connectorType": "value", "mor": { "type": null, "identifier": "example" } } ``` Sample response: ```json { "data": { "psaConnectorConfiguration": { "connectorConfiguration": { "id": "123", "connectorId": "123", "mor": {}, "configuration": {}, "credentials": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### psaConnectors Read all the connectors for a tenant Signature: ```graphql psaConnectors: [PsaConnector!] ``` ```graphql query psaConnectors { psaConnectors { id name type configuration credentials } } ``` Sample response: ```json { "data": { "psaConnectors": { "id": "123", "name": "example", "type": {}, "configuration": { "key": "example", "values": "example" }, "credentials": { "key": "example", "values": "example" } } } } ``` ### psaProductMappings Read all available product mapping Arguments: - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) - first: Int (optional) - Number of elements to return (page size) in forward direction. Default is 10 - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return (page size) in backward direction. Default is 10 - before: String (optional) - Returns elements before specified cursor - filter: PsaProductMappingsFilter (optional) - Criteria to filter product mappings - orderBy: PsaProductMappingsOrderBy (optional) - Criteria to sort product mappings Signature: ```graphql psaProductMappings(connectorType: PsaConnectorType, mor: PsaMorInput!, first: Int, after: String, last: Int, before: String, filter: PsaProductMappingsFilter, orderBy: PsaProductMappingsOrderBy): PsaProductMappingConnection! ``` ```graphql query psaProductMappings($connectorType: PsaConnectorType, $mor: PsaMorInput!, $first: Int, $after: String, $last: Int, $before: String, $filter: PsaProductMappingsFilter, $orderBy: PsaProductMappingsOrderBy) { psaProductMappings(connectorType: $connectorType, mor: $mor, first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "connectorType": "value", "mor": { "type": null, "identifier": "example" }, "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "productId": "123", "psaProductName": "example" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "psaProductMappings": { "totalCount": 1, "nodes": { "id": "123", "connectorType": {}, "mor": {}, "product": {}, "productName": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### psaProductsByName Get psa companies by psa company name Arguments: - name: String! (required) - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) Signature: ```graphql psaProductsByName(name: String!, connectorType: PsaConnectorType, mor: PsaMorInput!): [PsaProduct]! ``` ```graphql query psaProductsByName($name: String!, $connectorType: PsaConnectorType, $mor: PsaMorInput!) { psaProductsByName(name: $name, connectorType: $connectorType, mor: $mor) { id name } } ``` Variables: ```json { "name": "example", "connectorType": "value", "mor": { "type": null, "identifier": "example" } } ``` Sample response: ```json { "data": { "psaProductsByName": { "id": "123", "name": "example" } } } ``` ### psaSyncedSubscriptions Get all subscriptions Arguments: - mor: PsaMorInput! (required) - first: Int (optional) - Number of elements to return (page size) in forward direction. Default is 10 - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return (page size) in backward direction. Default is 10 - before: String (optional) - Returns elements before specified cursor - filter: PsaSyncedSubscriptionsFilter (optional) - Criteria to filter synced subscriptions - orderBy: PsaSyncedSubscriptionsOrderBy (optional) - Criteria to sort synced subscriptions Signature: ```graphql psaSyncedSubscriptions(mor: PsaMorInput!, first: Int, after: String, last: Int, before: String, filter: PsaSyncedSubscriptionsFilter, orderBy: PsaSyncedSubscriptionsOrderBy): PsaSyncedSubscriptionsConnection! ``` ```graphql query psaSyncedSubscriptions($mor: PsaMorInput!, $first: Int, $after: String, $last: Int, $before: String, $filter: PsaSyncedSubscriptionsFilter, $orderBy: PsaSyncedSubscriptionsOrderBy) { psaSyncedSubscriptions(mor: $mor, first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "mor": { "type": null, "identifier": "example" }, "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "syncStatus": null, "userCompanyId": "123" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "psaSyncedSubscriptions": { "totalCount": 1, "nodes": { "id": "123", "subscriptionId": "123", "mor": {}, "syncStatus": {}, "companyName": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### publishedProductsSearch Returns a paginated list of published products that match the queryString, partner, locale and filters provided. Arguments: - queryString: String (optional) - locale: Locale! (required) - explainScore: Boolean (optional) - pageRequest: PublishedProductSearchPageableRequest (optional) - sort: PublishedProductSearchSort (optional) - filter: PublishedProductSearchFilters (optional) - useProductionVersion: Boolean (optional) - tailMatch: Boolean (optional) Signature: ```graphql publishedProductsSearch(queryString: String, locale: Locale!, explainScore: Boolean, pageRequest: PublishedProductSearchPageableRequest, sort: PublishedProductSearchSort, filter: PublishedProductSearchFilters, useProductionVersion: Boolean, tailMatch: Boolean): PublishedProductSearchResult ``` ```graphql query publishedProductsSearch($queryString: String, $locale: Locale!, $explainScore: Boolean, $pageRequest: PublishedProductSearchPageableRequest, $sort: PublishedProductSearchSort, $filter: PublishedProductSearchFilters, $useProductionVersion: Boolean, $tailMatch: Boolean) { publishedProductsSearch(queryString: $queryString, locale: $locale, explainScore: $explainScore, pageRequest: $pageRequest, sort: $sort, filter: $filter, useProductionVersion: $useProductionVersion, tailMatch: $tailMatch) { success totalCount errors hits facets } } ``` Variables: ```json { "queryString": "example", "locale": "value", "explainScore": true, "pageRequest": { "first": 1, "after": "example" }, "sort": { "field": null, "order": null }, "filter": { "distributedAppsAttributeFilter": null, "distributedAppsAttributeFilters": null }, "useProductionVersion": true, "tailMatch": true } ``` Sample response: ```json { "data": { "publishedProductsSearch": { "success": true, "errors": { "code": "example", "message": "example", "path": "example" }, "hits": { "documentId": "123", "documentScore": {}, "documentScoreExplanation": {}, "productId": "123", "productUuid": "123" }, "facets": { "platform": {}, "categories": {}, "subCategories": {}, "attributes": {}, "attributeOptions": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### publishedProductsSearchTesting Returns a paginated list of published products that match the queryString, partner, locale and filters provided. Arguments: - queryString: String (optional) - locale: Locale! (required) - explainScore: Boolean (optional) - pageRequest: PublishedProductSearchPageableRequest (optional) - sort: PublishedProductSearchSort (optional) - filter: PublishedProductSearchFilters (optional) - useProductionVersion: Boolean (optional) - tailMatch: Boolean (optional) - forceDefaultProductSearchFields: Boolean (optional) - tenantSettings: PublishedProductSearchChannelSettingsTesting (optional) Signature: ```graphql publishedProductsSearchTesting(queryString: String, locale: Locale!, explainScore: Boolean, pageRequest: PublishedProductSearchPageableRequest, sort: PublishedProductSearchSort, filter: PublishedProductSearchFilters, useProductionVersion: Boolean, tailMatch: Boolean, forceDefaultProductSearchFields: Boolean, tenantSettings: PublishedProductSearchChannelSettingsTesting): PublishedProductSearchResultTesting ``` ```graphql query publishedProductsSearchTesting($queryString: String, $locale: Locale!, $explainScore: Boolean, $pageRequest: PublishedProductSearchPageableRequest, $sort: PublishedProductSearchSort, $filter: PublishedProductSearchFilters, $useProductionVersion: Boolean, $tailMatch: Boolean, $forceDefaultProductSearchFields: Boolean, $tenantSettings: PublishedProductSearchChannelSettingsTesting) { publishedProductsSearchTesting(queryString: $queryString, locale: $locale, explainScore: $explainScore, pageRequest: $pageRequest, sort: $sort, filter: $filter, useProductionVersion: $useProductionVersion, tailMatch: $tailMatch, forceDefaultProductSearchFields: $forceDefaultProductSearchFields, tenantSettings: $tenantSettings) { success totalCount errors hits facets } } ``` Variables: ```json { "queryString": "example", "locale": "value", "explainScore": true, "pageRequest": { "first": 1, "after": "example" }, "sort": { "field": null, "order": null }, "filter": { "distributedAppsAttributeFilter": null, "distributedAppsAttributeFilters": null }, "useProductionVersion": true, "tailMatch": true, "forceDefaultProductSearchFields": true, "tenantSettings": { "isAnonymousUserCanViewSegmentedProducts": true, "isHidePaidProducts": true } } ``` Sample response: ```json { "data": { "publishedProductsSearchTesting": { "success": true, "errors": { "code": "example", "message": "example", "path": "example" }, "hits": { "documentId": "123", "documentScore": {}, "documentScoreExplanation": {}, "productId": "123", "productUuid": "123" }, "facets": { "platform": {}, "categories": {}, "subCategories": {}, "attributes": {}, "attributeOptions": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### rawUsageCountByJobId Query to fetch information of IaaS job for specific count from RawUsages Signature: ```graphql rawUsageCountByJobId: RawUsagesCountDataResponse ``` ```graphql query rawUsageCountByJobId { rawUsageCountByJobId { rawUsagesFileTypeCount } } ``` Sample response: ```json { "data": { "rawUsageCountByJobId": { "rawUsagesFileTypeCount": { "JobRunId": "123", "fileTypeCount": {}, "TotalCount": 1 } } } } ``` ### rawUsageItem Arguments: - id: ID! (required) Signature: ```graphql rawUsageItem(id: ID!): RawUsageItem ``` ```graphql query rawUsageItem($id: ID!) { rawUsageItem(id: $id) { id statusCode status jobId partner } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "rawUsageItem": { "id": "123", "jobId": "example", "partner": "example", "status": {}, "statusCode": "example" } } } ``` ### rawUsageItemsByJobId Arguments: - jobId: String! (required) - status: String (optional) - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) Signature: ```graphql rawUsageItemsByJobId(jobId: String!, status: String, first: Int, after: String, last: Int, before: String): IAASRawUsageConnection! ``` ```graphql query rawUsageItemsByJobId($jobId: String!, $status: String, $first: Int, $after: String, $last: Int, $before: String) { rawUsageItemsByJobId(jobId: $jobId, status: $status, first: $first, after: $after, last: $last, before: $before) { totalCount currentPageNumber totalPages nodes pageInfo } } ``` Variables: ```json { "jobId": "example", "status": "example", "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "rawUsageItemsByJobId": { "nodes": { "id": "123", "jobId": "example", "partner": "example", "status": {}, "statusCode": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "currentPageNumber": 1, "totalPages": 1 } } } ``` ### readCompanyMappingByAccountIdAndOrPsaAccountId Read a company mapping Arguments: - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) - accountId: String (optional) - psaAccountId: String (optional) Signature: ```graphql readCompanyMappingByAccountIdAndOrPsaAccountId(connectorType: PsaConnectorType, mor: PsaMorInput!, accountId: String, psaAccountId: String): ReadPsaCompanyPayload! ``` ```graphql query readCompanyMappingByAccountIdAndOrPsaAccountId($connectorType: PsaConnectorType, $mor: PsaMorInput!, $accountId: String, $psaAccountId: String) { readCompanyMappingByAccountIdAndOrPsaAccountId(connectorType: $connectorType, mor: $mor, accountId: $accountId, psaAccountId: $psaAccountId) { mapping userErrors } } ``` Variables: ```json { "connectorType": "value", "mor": { "type": null, "identifier": "example" }, "accountId": "example", "psaAccountId": "example" } ``` Sample response: ```json { "data": { "readCompanyMappingByAccountIdAndOrPsaAccountId": { "mapping": { "id": "123", "accountId": "123", "mor": {}, "tenant": "example", "connectorType": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### readPsaProductMappingByItemIdsOrPsaProductId Read product mappings Arguments: - connectorType: PsaConnectorType (optional) - mor: PsaMorInput! (required) - psaProductId: String (optional) - Product Id on connectwise side - itemIds: [String] (optional) - Edition pricing item id on AppDirect side Signature: ```graphql readPsaProductMappingByItemIdsOrPsaProductId(connectorType: PsaConnectorType, mor: PsaMorInput!, psaProductId: String, itemIds: [String]): ReadPsaProductMappingPayload! ``` ```graphql query readPsaProductMappingByItemIdsOrPsaProductId($connectorType: PsaConnectorType, $mor: PsaMorInput!, $psaProductId: String, $itemIds: [String]) { readPsaProductMappingByItemIdsOrPsaProductId(connectorType: $connectorType, mor: $mor, psaProductId: $psaProductId, itemIds: $itemIds) { mapping userErrors } } ``` Variables: ```json { "connectorType": "value", "mor": { "type": null, "identifier": "example" }, "psaProductId": "example", "itemIds": [ "example" ] } ``` Sample response: ```json { "data": { "readPsaProductMappingByItemIdsOrPsaProductId": { "mapping": { "id": "123", "connectorType": {}, "mor": {}, "product": {}, "productName": "example" }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### relationshipRequestByCompany Arguments: - companyUuid: String! (required) Signature: ```graphql relationshipRequestByCompany(companyUuid: String!): RelationshipResponse ``` ```graphql query relationshipRequestByCompany($companyUuid: String!) { relationshipRequestByCompany(companyUuid: $companyUuid) { id requestStatus lastModified createdAt companyUuid } } ``` Variables: ```json { "companyUuid": "example" } ``` Sample response: ```json { "data": { "relationshipRequestByCompany": { "id": {}, "lastModified": "example", "createdAt": "example", "companyUuid": "example", "customerTenantId": "example" } } } ``` ### relationshipRequestByDomain Arguments: - domain: String! (required) Signature: ```graphql relationshipRequestByDomain(domain: String!): RelationshipResponse ``` ```graphql query relationshipRequestByDomain($domain: String!) { relationshipRequestByDomain(domain: $domain) { id requestStatus lastModified createdAt companyUuid } } ``` Variables: ```json { "domain": "example" } ``` Sample response: ```json { "data": { "relationshipRequestByDomain": { "id": {}, "lastModified": "example", "createdAt": "example", "companyUuid": "example", "customerTenantId": "example" } } } ``` ### reprocessByJobRunId Signature: ```graphql reprocessByJobRunId: JobScheduleResponse ``` ```graphql query reprocessByJobRunId { reprocessByJobRunId { createReprocessScheduleJob } } ``` Sample response: ```json { "data": { "reprocessByJobRunId": { "createReprocessScheduleJob": "example" } } } ``` ### resellerPublishedProductsSearch Returns a paginated list of published products for a given Reseller that match the queryString, partner, locale and filters provided. Arguments: - resellerId: String! (required) - queryString: String (optional) - locale: Locale! (required) - pageRequest: PublishedProductSearchPageableRequest (optional) - sort: PublishedProductSearchSort (optional) - filter: ResellerPublishedProductSearchFilters (optional) Signature: ```graphql resellerPublishedProductsSearch(resellerId: String!, queryString: String, locale: Locale!, pageRequest: PublishedProductSearchPageableRequest, sort: PublishedProductSearchSort, filter: ResellerPublishedProductSearchFilters): ResellerPublishedProductSearchResult ``` ```graphql query resellerPublishedProductsSearch($resellerId: String!, $queryString: String, $locale: Locale!, $pageRequest: PublishedProductSearchPageableRequest, $sort: PublishedProductSearchSort, $filter: ResellerPublishedProductSearchFilters) { resellerPublishedProductsSearch(resellerId: $resellerId, queryString: $queryString, locale: $locale, pageRequest: $pageRequest, sort: $sort, filter: $filter) { success totalCount errors hits facets } } ``` Variables: ```json { "resellerId": "example", "queryString": "example", "locale": "value", "pageRequest": { "first": 1, "after": "example" }, "sort": { "field": null, "order": null }, "filter": { "productIds": "example", "distributedAppsAttributeFilter": null } } ``` Sample response: ```json { "data": { "resellerPublishedProductsSearch": { "success": true, "errors": { "code": "example", "message": "example", "path": "example" }, "hits": { "documentId": "123", "documentScore": {}, "documentScoreExplanation": {}, "productId": "123", "productUuid": "123" }, "facets": { "platform": {}, "categories": {}, "subCategories": {}, "attributes": {}, "attributeOptions": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### reviewAllStats Retrieve all product review statistics Arguments: - first: Int (optional) - Number of product reviews to return by page. Maximum of 250 - after: String (optional) - Returns elements after this specific cursor, example MA== - orderBy: ReviewOrderBy (optional) - Product review statistics order information. If not specified, creation date will be use Signature: ```graphql reviewAllStats(first: Int, after: String, orderBy: ReviewOrderBy): ReviewStatsConnection ``` ```graphql query reviewAllStats($first: Int, $after: String, $orderBy: ReviewOrderBy) { reviewAllStats(first: $first, after: $after, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "reviewAllStats": { "totalCount": 1, "nodes": { "id": "123", "productId": "123", "reviewCount": 1, "averageRating": 1, "ratingBreakdown": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### reviews Retrieve a list of product reviews Arguments: - productId: ID! (required) - Product ID - first: Int (optional) - Number of product reviews to return by page. Maximum of 250 - after: String (optional) - Returns elements after this specific cursor, example MA== - orderBy: ReviewOrderBy (optional) - Product review order information. If not specified, creation date will be use - filter: ReviewFilter (optional) - Product review filter information Signature: ```graphql reviews(productId: ID!, first: Int, after: String, orderBy: ReviewOrderBy, filter: ReviewFilter): ReviewsConnection ``` ```graphql query reviews($productId: ID!, $first: Int, $after: String, $orderBy: ReviewOrderBy, $filter: ReviewFilter) { reviews(productId: $productId, first: $first, after: $after, orderBy: $orderBy, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "productId": "123", "first": 10, "after": "cursor", "orderBy": { "field": null, "direction": null }, "filter": { "rating": null } } ``` Sample response: ```json { "data": { "reviews": { "totalCount": 1, "nodes": { "id": "123", "providerReviewId": "example", "productId": "123", "title": "example", "rating": 1 }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### reviewStats Retrieve product review statistics for a given product Arguments: - productId: ID! (required) - Product ID Signature: ```graphql reviewStats(productId: ID!): ReviewStats ``` ```graphql query reviewStats($productId: ID!) { reviewStats(productId: $productId) { id productId reviewCount averageRating ratingBreakdown } } ``` Variables: ```json { "productId": "123" } ``` Sample response: ```json { "data": { "reviewStats": { "id": "123", "productId": "123", "reviewCount": 1, "averageRating": 1, "ratingBreakdown": { "rating": 1, "count": 1 } } } } ``` ### salesAgentPublishedProductsSearch Returns a paginated list of published products for a given Sales Agent that match the queryString, partner, locale and filters provided. Arguments: - queryString: String (optional) - locale: Locale! (required) - explainScore: Boolean (optional) - pageRequest: PublishedProductSearchPageableRequest (optional) - sort: PublishedProductSearchSort (optional) - filter: SalesAgentPublishedProductSearchFilters (optional) Signature: ```graphql salesAgentPublishedProductsSearch(queryString: String, locale: Locale!, explainScore: Boolean, pageRequest: PublishedProductSearchPageableRequest, sort: PublishedProductSearchSort, filter: SalesAgentPublishedProductSearchFilters): SalesAgentPublishedProductSearchResult ``` ```graphql query salesAgentPublishedProductsSearch($queryString: String, $locale: Locale!, $explainScore: Boolean, $pageRequest: PublishedProductSearchPageableRequest, $sort: PublishedProductSearchSort, $filter: SalesAgentPublishedProductSearchFilters) { salesAgentPublishedProductsSearch(queryString: $queryString, locale: $locale, explainScore: $explainScore, pageRequest: $pageRequest, sort: $sort, filter: $filter) { success totalCount errors hits facets } } ``` Variables: ```json { "queryString": "example", "locale": "value", "explainScore": true, "pageRequest": { "first": 1, "after": "example" }, "sort": { "field": null, "order": null }, "filter": { "productIds": "example", "distributedAppsAttributeFilter": null } } ``` Sample response: ```json { "data": { "salesAgentPublishedProductsSearch": { "success": true, "errors": { "code": "example", "message": "example", "path": "example" }, "hits": { "documentId": "123", "documentScore": {}, "documentScoreExplanation": {}, "productId": "123", "productUuid": "123" }, "facets": { "platform": {}, "categories": {}, "subCategories": {}, "attributes": {}, "attributeOptions": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### scheduleJob Returns schedule job by id Arguments: - id: ID! (required) - Unique identifier of the Schedule Job Signature: ```graphql scheduleJob(id: ID!): ScheduleJob ``` ```graphql query scheduleJob($id: ID!) { scheduleJob(id: $id) { id name status concurrencyPolicy successfulScheduleJobsHistoryLimit } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "scheduleJob": { "id": "123", "name": "example", "status": "example", "concurrencyPolicy": "example", "successfulScheduleJobsHistoryLimit": 1 } } } ``` ### scheduleJobByName Returns schedule job by name Arguments: - name: String! (required) Signature: ```graphql scheduleJobByName(name: String!): ScheduleJob ``` ```graphql query scheduleJobByName($name: String!) { scheduleJobByName(name: $name) { id name status concurrencyPolicy successfulScheduleJobsHistoryLimit } } ``` Variables: ```json { "name": "example" } ``` Sample response: ```json { "data": { "scheduleJobByName": { "id": "123", "name": "example", "status": "example", "concurrencyPolicy": "example", "successfulScheduleJobsHistoryLimit": 1 } } } ``` ### scheduleJobs Returns paginated list of the schedule jobs Arguments: - first: Int (optional) - after: String (optional) - last: Int (optional) - before: String (optional) Signature: ```graphql scheduleJobs(first: Int, after: String, last: Int, before: String): ScheduleJobConnection! ``` ```graphql query scheduleJobs($first: Int, $after: String, $last: Int, $before: String) { scheduleJobs(first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "scheduleJobs": { "nodes": { "id": "123", "name": "example", "status": "example", "concurrencyPolicy": "example", "successfulScheduleJobsHistoryLimit": 1 }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1 } } } ``` ### scheduleJobSchedule Returns schedule job schedule by id Arguments: - id: ID! (required) - Unique identifier of the Schedule Job Schedule Signature: ```graphql scheduleJobSchedule(id: ID!): ScheduleJobSchedule ``` ```graphql query scheduleJobSchedule($id: ID!) { scheduleJobSchedule(id: $id) { id scheduleName scheduleStatus scheduleType schedule } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "scheduleJobSchedule": { "id": "123", "scheduleJob": { "id": "123", "name": "example", "status": "example", "concurrencyPolicy": "example", "successfulScheduleJobsHistoryLimit": 1 }, "scheduleName": "example", "scheduleStatus": "example", "scheduleType": "example" } } } ``` ### selfServeSubscriptionUpdateCapabilities Retrieves capabilities for the self-serve subscription update flow to determine which UI elements should be displayed to the user Signature: ```graphql selfServeSubscriptionUpdateCapabilities: Capabilities ``` ```graphql query selfServeSubscriptionUpdateCapabilities { selfServeSubscriptionUpdateCapabilities { available restricted } } ``` Sample response: ```json { "data": { "selfServeSubscriptionUpdateCapabilities": { "available": "example", "restricted": "example" } } } ``` ### serializedUnitsByShipmentItemId Queries a list of serialized units for an item within a shipment. Arguments: - shipmentId: ID! (required) - Filters for a specific shipment. - fulfillmentItemId: ID! (required) - Filters for a specific fulfillment item. - identifierFilter: SerializedIdentifierFilterInput (optional) - Filters for a specific serialized item. - first: Int (optional) - Number of results to return (page size) after the specified *after* cursor. - after: String (optional) - Return results after this cursor. If null, return results starting at the beginning of the collection. - last: Int (optional) - Number of results to return (page size) before the specified *before* cursor. - before: String (optional) - Return results before this cursor. If null, return results starting at the end of the collection. Signature: ```graphql serializedUnitsByShipmentItemId(shipmentId: ID!, fulfillmentItemId: ID!, identifierFilter: SerializedIdentifierFilterInput, first: Int, after: String, last: Int, before: String): SerializedUnitConnection! ``` ```graphql query serializedUnitsByShipmentItemId($shipmentId: ID!, $fulfillmentItemId: ID!, $identifierFilter: SerializedIdentifierFilterInput, $first: Int, $after: String, $last: Int, $before: String) { serializedUnitsByShipmentItemId(shipmentId: $shipmentId, fulfillmentItemId: $fulfillmentItemId, identifierFilter: $identifierFilter, first: $first, after: $after, last: $last, before: $before) { totalCount nodes pageInfo } } ``` Variables: ```json { "shipmentId": "123", "fulfillmentItemId": "123", "identifierFilter": { "allOf": null }, "first": 10, "after": "cursor", "last": 1, "before": "example" } ``` Sample response: ```json { "data": { "serializedUnitsByShipmentItemId": { "totalCount": 1, "nodes": { "id": "123", "purchase": {}, "shipment": {}, "fulfillmentItem": {}, "serializedIdentifiers": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### subscriptionDiscrepancyDetail Arguments: - subscriptionId: String (optional) Signature: ```graphql subscriptionDiscrepancyDetail(subscriptionId: String): SubscriptionDiscrepancy ``` ```graphql query subscriptionDiscrepancyDetail($subscriptionId: String) { subscriptionDiscrepancyDetail(subscriptionId: $subscriptionId) { applicationName editionName status label subscriptionId } } ``` Variables: ```json { "subscriptionId": "example" } ``` Sample response: ```json { "data": { "subscriptionDiscrepancyDetail": { "label": "example", "status": "example", "applicationName": "example", "editionName": "example", "subscriptionId": "example" } } } ``` ### subscriptionUpdateCartFields Retrieves form fields for subscription update cart Arguments: - cartId: ID! (required) - Unique identifier of the cart - locale: Locale! (required) - Preferred locale for the response (e.g., en-US, de, en-AU) - filter: CartFieldsFilter (optional) - Optional filters to refine the response Signature: ```graphql subscriptionUpdateCartFields(cartId: ID!, locale: Locale!, filter: CartFieldsFilter): SubscriptionUpdateCartFieldsPayload ``` ```graphql query subscriptionUpdateCartFields($cartId: ID!, $locale: Locale!, $filter: CartFieldsFilter) { subscriptionUpdateCartFields(cartId: $cartId, locale: $locale, filter: $filter) { productFields } } ``` Variables: ```json { "cartId": "123", "locale": "value", "filter": { "itemIds": "123" } } ``` Sample response: ```json { "data": { "subscriptionUpdateCartFields": { "productFields": { "forms": {}, "itemId": "123" } } } } ``` ### usageFileUploads Returns all file uploads for partner Arguments: - first: Int (optional) - Number of elements to return (page size) in forward direction. Default is 10 - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return (page size) in backward direction. Default is 10 - before: String (optional) - Returns elements before specified cursor - filter: UsageFileUploadFilter (optional) - Criteria to filter usage file uploads - orderBy: UsageFileUploadOrderBy (optional) - Criteria to sort usage file uploads Signature: ```graphql usageFileUploads(first: Int, after: String, last: Int, before: String, filter: UsageFileUploadFilter, orderBy: UsageFileUploadOrderBy): UsageFileUploadConnection! ``` ```graphql query usageFileUploads($first: Int, $after: String, $last: Int, $before: String, $filter: UsageFileUploadFilter, $orderBy: UsageFileUploadOrderBy) { usageFileUploads(first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "requestGroupId": "example", "productIds": "example" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "usageFileUploads": { "totalCount": 1, "nodes": { "fileId": "123", "fileName": "example", "requestGroupId": "example", "productId": "example", "status": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### usageReader Get a usage reader Arguments: - input: UsageReaderInput! (required) - Parameters to get usage reader Signature: ```graphql usageReader(input: UsageReaderInput!): UsageReader! ``` ```graphql query usageReader($input: UsageReaderInput!) { usageReader(input: $input) { id name status vendorId productId } } ``` Variables: ```json { "input": { "vendorId": "example", "productId": "example" } } ``` Sample response: ```json { "data": { "usageReader": { "id": "example", "vendorId": "example", "productId": "example", "name": "example", "status": {} } } } ``` ### usageReaderConfiguration Get usage reader configuration by id Arguments: - id: ID! (required) - Unique id for usage reader Signature: ```graphql usageReaderConfiguration(id: ID!): UsageReaderConfigurationPayload! ``` ```graphql query usageReaderConfiguration($id: ID!) { usageReaderConfiguration(id: $id) { reader } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "usageReaderConfiguration": { "reader": { "id": "123", "name": "example", "inputType": {}, "productId": "example", "product": {} } } } } ``` ### usageReaders Returns all usage readers for partner Arguments: - first: Int (optional) - Number of elements to return (page size) in forward direction. Default is 10 - after: String (optional) - Returns elements after specified cursor - last: Int (optional) - Number of elements to return (page size) in backward direction. Default is 10 - before: String (optional) - Returns elements before specified cursor - filter: UsageReaderFilter (optional) - Criteria to filter usage readers - orderBy: UsageReaderOrderBy (optional) - Criteria to sort usage readers Signature: ```graphql usageReaders(first: Int, after: String, last: Int, before: String, filter: UsageReaderFilter, orderBy: UsageReaderOrderBy): UsageReaderConnection! ``` ```graphql query usageReaders($first: Int, $after: String, $last: Int, $before: String, $filter: UsageReaderFilter, $orderBy: UsageReaderOrderBy) { usageReaders(first: $first, after: $after, last: $last, before: $before, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "name": "example", "status": null }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "usageReaders": { "totalCount": 1, "nodes": { "id": "123", "name": "example", "inputType": {}, "productId": "example", "product": {} }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### user Retrieve a user by ID Arguments: - id: ID! (required) - Unique identifier of the user Signature: ```graphql user(id: ID!): User ``` ```graphql query user($id: ID!) { user(id: $id) { id firstName lastName username title } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "user": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" } } } ``` ### userActivities Arguments: - first: Int (optional) - Number of results to return - after: String (optional) - Paginated result - After this point - last: Int (optional) - Number of items to return before the given before cursor - before: String (optional) - Paginated result - Before this point - filter: UserActivityFilterInput (optional) - Filter to apply to the query Signature: ```graphql userActivities(first: Int, after: String, last: Int, before: String, filter: UserActivityFilterInput): UserActivityConnection ``` ```graphql query userActivities($first: Int, $after: String, $last: Int, $before: String, $filter: UserActivityFilterInput) { userActivities(first: $first, after: $after, last: $last, before: $before, filter: $filter) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "processType": "example", "entityType": "example" } } ``` Sample response: ```json { "data": { "userActivities": { "totalCount": 1, "nodes": { "processId": "example", "triggeredOn": {}, "completedOn": {}, "processType": "example", "entityType": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### userActivity Arguments: - id: ID! (required) Signature: ```graphql userActivity(id: ID!): UserActivity ``` ```graphql query userActivity($id: ID!) { userActivity(id: $id) { status processId processType entityType processedCount } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "userActivity": { "processId": "example", "triggeredOn": {}, "completedOn": {}, "processType": "example", "entityType": "example" } } } ``` ### userByExternalId Retrieve a user by external ID Arguments: - externalId: String! (required) - Unique external identifier of the user Signature: ```graphql userByExternalId(externalId: String!): User ``` ```graphql query userByExternalId($externalId: String!) { userByExternalId(externalId: $externalId) { id firstName lastName username title } } ``` Variables: ```json { "externalId": "example" } ``` Sample response: ```json { "data": { "userByExternalId": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" } } } ``` ### userByUsername Retrieve a user by username Arguments: - username: String! (required) - Username of the user Signature: ```graphql userByUsername(username: String!): User ``` ```graphql query userByUsername($username: String!) { userByUsername(username: $username) { id firstName lastName username title } } ``` Variables: ```json { "username": "example" } ``` Sample response: ```json { "data": { "userByUsername": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" } } } ``` ### users Retrieve list of users Arguments: - first: Int (optional) - Number of elements to return (page size) - after: String (optional) - Returns elements after specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - before: String (optional) - Returns elements before specified cursor, for example bnVtYmVyPTAmc2l6ZT0xMA== - last: Int (optional) - Number of elements to return in reverse order (page size) - filter: UsersFilter (optional) - Filter for user list - orderBy: UserOrderBy (optional) - The property and direction to sort users by Signature: ```graphql users(first: Int, after: String, before: String, last: Int, filter: UsersFilter, orderBy: UserOrderBy): UserConnection! ``` ```graphql query users($first: Int, $after: String, $before: String, $last: Int, $filter: UsersFilter, $orderBy: UserOrderBy) { users(first: $first, after: $after, before: $before, last: $last, filter: $filter, orderBy: $orderBy) { totalCount nodes pageInfo } } ``` Variables: ```json { "first": 10, "after": "cursor", "before": "example", "last": 1, "filter": { "name": "example", "email": "example" }, "orderBy": { "field": null, "direction": null } } ``` Sample response: ```json { "data": { "users": { "totalCount": 1, "nodes": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" }, "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true } } } } ``` ### vendorExchangeRate Returns requested vendor exchange rate Arguments: - input: VendorExchangeRateInput! (required) - Attributes to fetch specific exchange rate Signature: ```graphql vendorExchangeRate(input: VendorExchangeRateInput!): VendorExchangeRate ``` ```graphql query vendorExchangeRate($input: VendorExchangeRateInput!) { vendorExchangeRate(input: $input) { id exchangeRate source baseCurrency targetCurrency } } ``` Variables: ```json { "input": { "baseCurrency": null, "targetCurrency": null } } ``` Sample response: ```json { "data": { "vendorExchangeRate": { "id": "example", "exchangeRate": {}, "source": {}, "baseCurrency": {}, "targetCurrency": {} } } } ``` ### visualizationDataset Retrieve the most recent revision of a dataset Arguments: - id: ID! (required) - Unique identifier for the dataset Signature: ```graphql visualizationDataset(id: ID!): VisualizationDataset ``` ```graphql query visualizationDataset($id: ID!) { visualizationDataset(id: $id) { id name revisionId productId timeColumn } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "visualizationDataset": { "id": "123", "revisionId": 1, "revision": { "id": 1, "name": "example", "datasetSchema": {}, "createdDate": "2024-01-01" }, "productId": "123", "name": "example" } } } ``` ### visualizationMetric Retrieve a specific metric Arguments: - id: ID! (required) - Unique identifier of the metric Signature: ```graphql visualizationMetric(id: ID!): VisualizationMetric ``` ```graphql query visualizationMetric($id: ID!) { visualizationMetric(id: $id) { id name productId datasetId revisionId } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "visualizationMetric": { "name": "example", "id": "123", "productId": "123", "datasetId": "123", "revisionId": 1 } } } ``` ### visualizationMetricData Retrieve metric data Arguments: - metricId: ID! (required) - Unique identifier for the metric - timeFrame: VisualizationMetricTimeFrameInput! (required) - The start and end timeframe for the query - metricParams: [VisualizationMetricParamInput]! (required) - The metric parameter values Signature: ```graphql visualizationMetricData(metricId: ID!, timeFrame: VisualizationMetricTimeFrameInput!, metricParams: [VisualizationMetricParamInput]!): VisualizationDataTable ``` ```graphql query visualizationMetricData($metricId: ID!, $timeFrame: VisualizationMetricTimeFrameInput!, $metricParams: [VisualizationMetricParamInput]!) { visualizationMetricData(metricId: $metricId, timeFrame: $timeFrame, metricParams: $metricParams) { data } } ``` Variables: ```json { "metricId": "123", "timeFrame": { "start": null, "end": null }, "metricParams": [ { "paramKey": "example", "paramValue": "example" } ] } ``` Sample response: ```json { "data": { "visualizationMetricData": { "data": "example" } } } ``` ### webhook Webhook by identifier Arguments: - id: ID! (required) Signature: ```graphql webhook(id: ID!): Webhook! ``` ```graphql query webhook($id: ID!) { webhook(id: $id) { id status resourceType resourcePayload resourceAction } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "webhook": { "id": "123", "status": {}, "resourceType": "example", "resourcePayload": "example", "resourceAction": "example" } } } ``` ### webhookConfiguration Webhook configuration by identifier Arguments: - id: ID! (required) Signature: ```graphql webhookConfiguration(id: ID!): WebhookConfiguration! ``` ```graphql query webhookConfiguration($id: ID!) { webhookConfiguration(id: $id) { id status tenant url active } } ``` Variables: ```json { "id": "123" } ``` Sample response: ```json { "data": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": { "__typename": "WebhookTenantScope" } } } } ``` ### webhookConfigurationAccountResourceTypes List available resource types for account scoped webhook configurations Arguments: - account: ID (optional) Signature: ```graphql webhookConfigurationAccountResourceTypes(account: ID): [WebhookConfigurationResourceTypeAvailability!]! ``` ```graphql query webhookConfigurationAccountResourceTypes($account: ID) { webhookConfigurationAccountResourceTypes(account: $account) { type availableActions } } ``` Variables: ```json { "account": "123" } ``` Sample response: ```json { "data": { "webhookConfigurationAccountResourceTypes": { "type": {}, "availableActions": {} } } } ``` ### webhookConfigurations Paginated list of webhook configurations for a tenant Arguments: - tenant: String (optional) - Tenant - first: Int (optional) - Number of results to fetch forwards - after: String (optional) - Cursor after which to fetch forwards - last: Int (optional) - Number of results to fetch backwards - before: String (optional) - Cursor before which to fetch backwards - filter: WebhookConfigurationFilter (optional) - Filter for webhook configurations Signature: ```graphql webhookConfigurations(tenant: String, first: Int, after: String, last: Int, before: String, filter: WebhookConfigurationFilter): WebhookConfigurationConnection! ``` ```graphql query webhookConfigurations($tenant: String, $first: Int, $after: String, $last: Int, $before: String, $filter: WebhookConfigurationFilter) { webhookConfigurations(tenant: $tenant, first: $first, after: $after, last: $last, before: $before, filter: $filter) { totalCount pageInfo nodes } } ``` Variables: ```json { "tenant": "example", "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "active": true, "status": null } } ``` Sample response: ```json { "data": { "webhookConfigurations": { "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "nodes": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} } } } } ``` ### webhookConfigurationTenantResourceTypes List available resource types for tenant scoped webhook configurations Arguments: - tenant: String (optional) Signature: ```graphql webhookConfigurationTenantResourceTypes(tenant: String): [WebhookConfigurationResourceTypeAvailability!]! ``` ```graphql query webhookConfigurationTenantResourceTypes($tenant: String) { webhookConfigurationTenantResourceTypes(tenant: $tenant) { type availableActions } } ``` Variables: ```json { "tenant": "example" } ``` Sample response: ```json { "data": { "webhookConfigurationTenantResourceTypes": { "type": {}, "availableActions": {} } } } ``` ### webhooks List of webhooks for a tenant Arguments: - tenant: String (optional) - Tenant - first: Int (optional) - Number of results to fetch forwards - after: String (optional) - Cursor after which to fetch forwards - last: Int (optional) - Number of results to fetch backwards - before: String (optional) - Cursor before which to fetch backwards - filter: WebhookFilter (optional) - Filter for webhooks Signature: ```graphql webhooks(tenant: String, first: Int, after: String, last: Int, before: String, filter: WebhookFilter): WebhookConnection! ``` ```graphql query webhooks($tenant: String, $first: Int, $after: String, $last: Int, $before: String, $filter: WebhookFilter) { webhooks(tenant: $tenant, first: $first, after: $after, last: $last, before: $before, filter: $filter) { totalCount pageInfo nodes } } ``` Variables: ```json { "tenant": "example", "first": 10, "after": "cursor", "last": 1, "before": "example", "filter": { "statuses": null, "resourceType": null } } ``` Sample response: ```json { "data": { "webhooks": { "pageInfo": { "startCursor": "example", "endCursor": "example", "hasPreviousPage": true, "hasNextPage": true }, "totalCount": 1, "nodes": { "id": "123", "status": {}, "resourceType": "example", "resourcePayload": "example", "resourceAction": "example" } } } } ``` ## Mutations ### activateUsageReader Updates usage reader status as ACTIVE and further can be used for processing of metered usages Arguments: - input: ActivateUsageReaderInput! (required) - Input to update usage reader status as ACTIVE Signature: ```graphql activateUsageReader(input: ActivateUsageReaderInput!): ActivateUsageReaderPayload! ``` ```graphql mutation activateUsageReader($input: ActivateUsageReaderInput!) { activateUsageReader(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "readerId": "example", "updatedBy": "example" } } ``` Sample response: ```json { "data": { "activateUsageReader": { "success": true, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### addFileToProductEdition Add a file to a product edition Arguments: - input: AddFileToProductEditionInput! (required) Signature: ```graphql addFileToProductEdition(input: AddFileToProductEditionInput!): AddFileToProductEditionPayload! ``` ```graphql mutation addFileToProductEdition($input: AddFileToProductEditionInput!) { addFileToProductEdition(input: $input) { productEditionFile userErrors } } ``` Variables: ```json { "input": { "name": null, "productId": "123", "editionId": "123" } } ``` Sample response: ```json { "data": { "addFileToProductEdition": { "productEditionFile": { "id": "123", "version": "example", "file": {} }, "userErrors": { "__typename": "ProductEditionFileNameError" } } } } ``` ### addItemsToCart Creates a new cart or adds items to an existing active cart Arguments: - input: AddItemsInput! (required) Signature: ```graphql addItemsToCart(input: AddItemsInput!): AddItemsPayload ``` ```graphql mutation addItemsToCart($input: AddItemsInput!) { addItemsToCart(input: $input) { cart } } ``` Variables: ```json { "input": { "items": null, "userId": "123", "accountId": "123" } } ``` Sample response: ```json { "data": { "addItemsToCart": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} } } } } ``` ### addProductIntegrationBookmarkConfiguration Add a Bookmark single sign-on configuration to an existing product integration Arguments: - input: AddProductIntegrationBookmarkConfigurationInput! (required) Signature: ```graphql addProductIntegrationBookmarkConfiguration(input: AddProductIntegrationBookmarkConfigurationInput!): AddProductIntegrationBookmarkConfigurationPayload ``` ```graphql mutation addProductIntegrationBookmarkConfiguration($input: AddProductIntegrationBookmarkConfigurationInput!) { addProductIntegrationBookmarkConfiguration(input: $input) { bookmark userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123", "url": "example" } } ``` Sample response: ```json { "data": { "addProductIntegrationBookmarkConfiguration": { "bookmark": { "url": "example", "setupForm": {} }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### addProductIntegrationOpenIdConnectConfiguration Add a OpenID Connect single sign-on configuration to an existing product integration Arguments: - input: AddProductIntegrationOpenIdConnectConfigurationInput! (required) Signature: ```graphql addProductIntegrationOpenIdConnectConfiguration(input: AddProductIntegrationOpenIdConnectConfigurationInput!): AddProductIntegrationOpenIdConnectConfigurationPayload ``` ```graphql mutation addProductIntegrationOpenIdConnectConfiguration($input: AddProductIntegrationOpenIdConnectConfigurationInput!) { addProductIntegrationOpenIdConnectConfiguration(input: $input) { openIdConnectConfiguration userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123", "clientCreationMethod": null, "grantTypes": null, "redirectUrls": "example", "allowedScopes": null, "initiateLoginUrl": "example" } } ``` Sample response: ```json { "data": { "addProductIntegrationOpenIdConnectConfiguration": { "openIdConnectConfiguration": { "clientCreationMethod": {}, "grantTypes": {}, "redirectUrls": "example", "initiateLoginUrl": "example", "logoutUrl": "example" }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### addProductIntegrationSamlConfiguration Add a SAML single sign-on configuration to an existing product integration Arguments: - input: AddProductIntegrationSamlConfigurationInput! (required) Signature: ```graphql addProductIntegrationSamlConfiguration(input: AddProductIntegrationSamlConfigurationInput!): AddProductIntegrationSamlConfigurationPayload ``` ```graphql mutation addProductIntegrationSamlConfiguration($input: AddProductIntegrationSamlConfigurationInput!) { addProductIntegrationSamlConfiguration(input: $input) { samlConfiguration userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123", "version": "example", "idpConfigurationCreationMethod": null, "serviceProviderEntityId": "example", "assertionConsumerServiceUrl": "example", "nameId": "example", "nameIdFormat": "example", "responseSignatureMode": null, "responseSignatureAlgorithm": null } } ``` Sample response: ```json { "data": { "addProductIntegrationSamlConfiguration": { "samlConfiguration": { "version": "example", "idpConfigurationCreationMethod": "example", "serviceProviderEntityId": "example", "assertionConsumerServiceUrl": "example", "serviceProviderInitiatedLoginUrl": "example" }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### addProductIntegrationSingleSignOnConfigurationSetupForm Add a single sign-on setup form configuration to an existing product integration Arguments: - input: AddProductIntegrationSingleSignOnConfigurationSetupFormInput! (required) Signature: ```graphql addProductIntegrationSingleSignOnConfigurationSetupForm(input: AddProductIntegrationSingleSignOnConfigurationSetupFormInput!): AddProductIntegrationSingleSignOnConfigurationSetupFormPayload ``` ```graphql mutation addProductIntegrationSingleSignOnConfigurationSetupForm($input: AddProductIntegrationSingleSignOnConfigurationSetupFormInput!) { addProductIntegrationSingleSignOnConfigurationSetupForm(input: $input) { setupForm userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123", "overview": "example", "instructions": "example" } } ``` Sample response: ```json { "data": { "addProductIntegrationSingleSignOnConfigurationSetupForm": { "setupForm": { "overview": "example", "instructions": "example", "parameters": {} }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### addProductVariantOption Add a product variant option to a product Arguments: - input: AddProductVariantOptionInput! (required) Signature: ```graphql addProductVariantOption(input: AddProductVariantOptionInput!): AddProductVariantOptionPayload! ``` ```graphql mutation addProductVariantOption($input: AddProductVariantOptionInput!) { addProductVariantOption(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "name": null, "inputType": null } } ``` Sample response: ```json { "data": { "addProductVariantOption": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "InvalidVariantProductTypeError" } } } } ``` ### addProductVariantOptionValue Create variant option values for a product Arguments: - input: AddProductVariantOptionValueInput! (required) Signature: ```graphql addProductVariantOptionValue(input: AddProductVariantOptionValueInput!): AddProductVariantOptionValuePayload! ``` ```graphql mutation addProductVariantOptionValue($input: AddProductVariantOptionValueInput!) { addProductVariantOptionValue(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "optionCode": "example", "name": null, "isDefaultValue": true } } ``` Sample response: ```json { "data": { "addProductVariantOptionValue": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "DuplicateProductVariantOptionValueCodeError" } } } } ``` ### applyDiscountToCart Applies a discount code to the cart Arguments: - input: ApplyDiscountInput! (required) Signature: ```graphql applyDiscountToCart(input: ApplyDiscountInput!): ApplyDiscountCodePayload ``` ```graphql mutation applyDiscountToCart($input: ApplyDiscountInput!) { applyDiscountToCart(input: $input) { cart userErrors } } ``` Variables: ```json { "input": { "cartId": "123", "discountCode": "example" } } ``` Sample response: ```json { "data": { "applyDiscountToCart": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} }, "userErrors": { "__typename": "InvalidDiscountCodeError" } } } } ``` ### assignTransformersToUsageReader Adds the transformers in the usage reader Arguments: - input: AssignUsageReaderTransformationsInput! (required) - Input with transformer information Signature: ```graphql assignTransformersToUsageReader(input: AssignUsageReaderTransformationsInput!): AssignUsageReaderTransformationsPayload! ``` ```graphql mutation assignTransformersToUsageReader($input: AssignUsageReaderTransformationsInput!) { assignTransformersToUsageReader(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "id": "123", "eventDateFormat": "example", "updatedBy": "example" } } ``` Sample response: ```json { "data": { "assignTransformersToUsageReader": { "success": true, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### associateUsageReader Associate existing reader to new product and vendor Arguments: - input: AssociateUsageReaderInput! (required) - Input to associate existing reader to new product and vendor Signature: ```graphql associateUsageReader(input: AssociateUsageReaderInput!): AssociateUsageReaderPayload! ``` ```graphql mutation associateUsageReader($input: AssociateUsageReaderInput!) { associateUsageReader(input: $input) { readerId vendorId productId userErrors } } ``` Variables: ```json { "input": { "existingReaderId": "123", "vendorId": "123", "productId": "123", "name": "example" } } ``` Sample response: ```json { "data": { "associateUsageReader": { "readerId": "123", "vendorId": "123", "productId": "123", "userErrors": { "__typename": "AssociateUsageReaderError" } } } } ``` ### bootstrapAccountByPartner Bootstrap accounts (re-sending all account events) Arguments: - input: BootstrapAccountInput! (required) - Input parameters for bootstrap accounts Signature: ```graphql bootstrapAccountByPartner(input: BootstrapAccountInput!): BootstrapAccountPayload! ``` ```graphql mutation bootstrapAccountByPartner($input: BootstrapAccountInput!) { bootstrapAccountByPartner(input: $input) { success bootstrapId } } ``` Variables: ```json { "input": { "tenant": "example" } } ``` Sample response: ```json { "data": { "bootstrapAccountByPartner": { "success": true, "bootstrapId": "example" } } } ``` ### bootstrapMarketplaceProductSearchIndexesForCluster Bootstrap a marketplace product Arguments: - maxNbOfPartrners: Int (optional) Signature: ```graphql bootstrapMarketplaceProductSearchIndexesForCluster(maxNbOfPartrners: Int): BootstrapMarketplaceProductSearchIndexesResponse! ``` ```graphql mutation bootstrapMarketplaceProductSearchIndexesForCluster($maxNbOfPartrners: Int) { bootstrapMarketplaceProductSearchIndexesForCluster(maxNbOfPartrners: $maxNbOfPartrners) { id messages } } ``` Variables: ```json { "maxNbOfPartrners": 1 } ``` Sample response: ```json { "data": { "bootstrapMarketplaceProductSearchIndexesForCluster": { "id": "example", "messages": "example" } } } ``` ### bootstrapMarketplaceProductSearchIndexesForPartner Bootstrap a marketplace product Arguments: - partner: String! (required) Signature: ```graphql bootstrapMarketplaceProductSearchIndexesForPartner(partner: String!): BootstrapMarketplaceProductSearchIndexesResponse! ``` ```graphql mutation bootstrapMarketplaceProductSearchIndexesForPartner($partner: String!) { bootstrapMarketplaceProductSearchIndexesForPartner(partner: $partner) { id messages } } ``` Variables: ```json { "partner": "example" } ``` Sample response: ```json { "data": { "bootstrapMarketplaceProductSearchIndexesForPartner": { "id": "example", "messages": "example" } } } ``` ### bootstrapMembershipByPartner Bootstrap membership (re-sending all user events) Arguments: - input: BootstrapMembershipInput! (required) - Input parameters for bootstrap membership Signature: ```graphql bootstrapMembershipByPartner(input: BootstrapMembershipInput!): BootstrapMembershipPayload! ``` ```graphql mutation bootstrapMembershipByPartner($input: BootstrapMembershipInput!) { bootstrapMembershipByPartner(input: $input) { success bootstrapId } } ``` Variables: ```json { "input": { "tenant": "example" } } ``` Sample response: ```json { "data": { "bootstrapMembershipByPartner": { "success": true, "bootstrapId": "example" } } } ``` ### bootstrapUserByPartner Bootstrap users (re-sending all user events) Arguments: - input: BootstrapUserInput! (required) - Input parameters for bootstrap users Signature: ```graphql bootstrapUserByPartner(input: BootstrapUserInput!): BootstrapUserPayload! ``` ```graphql mutation bootstrapUserByPartner($input: BootstrapUserInput!) { bootstrapUserByPartner(input: $input) { success bootstrapId } } ``` Variables: ```json { "input": { "tenant": "example" } } ``` Sample response: ```json { "data": { "bootstrapUserByPartner": { "success": true, "bootstrapId": "example" } } } ``` ### cancelHighGrowthOrder Arguments: - input: CancelHighGrowthOrderInput! (required) Signature: ```graphql cancelHighGrowthOrder(input: CancelHighGrowthOrderInput!): CancelHighGrowthOrderPayload! ``` ```graphql mutation cancelHighGrowthOrder($input: CancelHighGrowthOrderInput!) { cancelHighGrowthOrder(input: $input) { success } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "cancelHighGrowthOrder": { "success": true } } } ``` ### cancelResellerRelationship Arguments: - companyUuid: String! (required) Signature: ```graphql cancelResellerRelationship(companyUuid: String!): RelationshipResponse! ``` ```graphql mutation cancelResellerRelationship($companyUuid: String!) { cancelResellerRelationship(companyUuid: $companyUuid) { id requestStatus lastModified createdAt companyUuid } } ``` Variables: ```json { "companyUuid": "example" } ``` Sample response: ```json { "data": { "cancelResellerRelationship": { "id": {}, "lastModified": "example", "createdAt": "example", "companyUuid": "example", "customerTenantId": "example" } } } ``` ### closeCreditMemo Close credit memo Arguments: - input: CloseCreditMemoInput! (required) Signature: ```graphql closeCreditMemo(input: CloseCreditMemoInput!): CloseCreditMemoPayload! ``` ```graphql mutation closeCreditMemo($input: CloseCreditMemoInput!) { closeCreditMemo(input: $input) { operationStatus creditMemo userErrors } } ``` Variables: ```json { "input": { "creditMemoId": "123" } } ``` Sample response: ```json { "data": { "closeCreditMemo": { "creditMemo": { "id": "123", "amountAvailable": {}, "amountUsed": {}, "creditMemoAppliedDate": {}, "creditMemoCreationDate": {} }, "operationStatus": {}, "userErrors": { "__typename": "CreditMemoHasNoBalanceError" } } } } ``` ### createAccount Create a new marketplace account (company) Arguments: - input: CreateAccountInput! (required) - Specifies attributes for a new marketplace account (company) Signature: ```graphql createAccount(input: CreateAccountInput!): CreateAccountPayload! ``` ```graphql mutation createAccount($input: CreateAccountInput!) { createAccount(input: $input) { account userErrors } } ``` Variables: ```json { "input": { "name": "example", "countryCode": "example", "firstUser": null } } ``` Sample response: ```json { "data": { "createAccount": { "account": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "userErrors": { "__typename": "AccountUserExistsWithSameEmailError" } } } } ``` ### createAccountAssociation Create reseller account association with customer account Arguments: - input: CreateAccountAssociationInput! (required) - Specifies data to identify reseller account and customer account that is to be associated Signature: ```graphql createAccountAssociation(input: CreateAccountAssociationInput!): CreateAccountAssociationPayload! ``` ```graphql mutation createAccountAssociation($input: CreateAccountAssociationInput!) { createAccountAssociation(input: $input) { accountAssociation userErrors } } ``` Variables: ```json { "input": { "resellerAccountId": "123", "customerAccountId": "123" } } ``` Sample response: ```json { "data": { "createAccountAssociation": { "accountAssociation": { "id": "123", "createdOn": {}, "resellerAccount": {}, "customerAccount": {} }, "userErrors": { "__typename": "NotAResellerAccountError" } } } } ``` ### createAccountMembership Add a new or existing user as a member of a marketplace account (company) Arguments: - input: CreateAccountMembershipInput! (required) - Specifies the attributes required to add a user as a member of an account (company) Signature: ```graphql createAccountMembership(input: CreateAccountMembershipInput!): CreateAccountMembershipPayload! ``` ```graphql mutation createAccountMembership($input: CreateAccountMembershipInput!) { createAccountMembership(input: $input) { accountMembership userErrors } } ``` Variables: ```json { "input": { "accountId": "123" } } ``` Sample response: ```json { "data": { "createAccountMembership": { "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "userErrors": { "__typename": "AccountUserExistsWithSameEmailError" } } } } ``` ### createAccountMembershipWithPassword Create a marketplace user with membership in the given company. The created user is active, and is associated with the specified company (membership). User is set with a temporary password; the password is emailed to the recipients specified in the request body. The domain part of the user's email address must match one of the verified domains associated with the company the user will be created in. Arguments: - input: CreateAccountMembershipWithPasswordInput! (required) - Specifies the attributes required to add a user as a member of an account (company) Signature: ```graphql createAccountMembershipWithPassword(input: CreateAccountMembershipWithPasswordInput!): CreateAccountMembershipWithPasswordPayload! ``` ```graphql mutation createAccountMembershipWithPassword($input: CreateAccountMembershipWithPasswordInput!) { createAccountMembershipWithPassword(input: $input) { accountMembership userErrors } } ``` Variables: ```json { "input": { "accountId": "123" } } ``` Sample response: ```json { "data": { "createAccountMembershipWithPassword": { "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "userErrors": { "__typename": "AccountMembershipEmptyTemporaryPasswordError" } } } } ``` ### createAccountWebhookConfiguration Create a new account scoped webhook configuration Arguments: - input: CreateAccountWebhookConfigurationInput! (required) Signature: ```graphql createAccountWebhookConfiguration(input: CreateAccountWebhookConfigurationInput!): CreateAccountWebhookConfigurationPayload! ``` ```graphql mutation createAccountWebhookConfiguration($input: CreateAccountWebhookConfigurationInput!) { createAccountWebhookConfiguration(input: $input) { webhookConfiguration userErrors } } ``` Variables: ```json { "input": { "resourceType": null, "resourceActions": null } } ``` Sample response: ```json { "data": { "createAccountWebhookConfiguration": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} }, "userErrors": { "__typename": "DuplicateWebhookConfigurationError" } } } } ``` ### createAgreement Arguments: - companyUuid: String! (required) - tenantId: String! (required) Signature: ```graphql createAgreement(companyUuid: String!, tenantId: String!): AttestationResponse! ``` ```graphql mutation createAgreement($companyUuid: String!, $tenantId: String!) { createAgreement(companyUuid: $companyUuid, tenantId: $tenantId) { signatoryFirstName signatoryLastName status attestationId companyUuid } } ``` Variables: ```json { "companyUuid": "example", "tenantId": "example" } ``` Sample response: ```json { "data": { "createAgreement": { "attestationId": "example", "status": {}, "companyUuid": "example", "partner": "example", "signatoryFirstName": "example" } } } ``` ### createAllocation Create allocation Arguments: - input: [CreateAllocationInput!]! (required) Signature: ```graphql createAllocation(input: [CreateAllocationInput!]!): CreateSubscriptionAllocationPayload! ``` ```graphql mutation createAllocation($input: [CreateAllocationInput!]!) { createAllocation(input: $input) { allocations errors } } ``` Variables: ```json { "input": [ { "tenant": "example", "subscriptionId": "example", "allocationInput": null } ] } ``` Sample response: ```json { "data": { "createAllocation": { "allocations": { "uuid": "example", "chargeId": "example", "subscriptionId": "example", "allocations": {} }, "errors": { "__typename": "UnspecifiedAllocationError" } } } } ``` ### createAttestation Arguments: - companyUuid: String! (required) - signatoryFirstName: String! (required) - signatoryLastName: String! (required) - emailAddress: String! (required) - phoneNumber: String! (required) - country: String (optional) - userUuid: String (optional) - sendNotification: Boolean (optional) Signature: ```graphql createAttestation(companyUuid: String!, signatoryFirstName: String!, signatoryLastName: String!, emailAddress: String!, phoneNumber: String!, country: String, userUuid: String, sendNotification: Boolean): CreateAttestationResponse! ``` ```graphql mutation createAttestation($companyUuid: String!, $signatoryFirstName: String!, $signatoryLastName: String!, $emailAddress: String!, $phoneNumber: String!, $country: String, $userUuid: String, $sendNotification: Boolean) { createAttestation(companyUuid: $companyUuid, signatoryFirstName: $signatoryFirstName, signatoryLastName: $signatoryLastName, emailAddress: $emailAddress, phoneNumber: $phoneNumber, country: $country, userUuid: $userUuid, sendNotification: $sendNotification) { attestation userErrors } } ``` Variables: ```json { "companyUuid": "example", "signatoryFirstName": "example", "signatoryLastName": "example", "emailAddress": "example", "phoneNumber": "example", "country": "example", "userUuid": "example", "sendNotification": true } ``` Sample response: ```json { "data": { "createAttestation": { "attestation": { "attestationId": "example", "url": "example" }, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### createBalanceApplicationRequest Create balance application request Arguments: - input: CreateBalanceApplicationRequestInput! (required) Signature: ```graphql createBalanceApplicationRequest(input: CreateBalanceApplicationRequestInput!): CreateBalanceApplicationRequestPayload ``` ```graphql mutation createBalanceApplicationRequest($input: CreateBalanceApplicationRequestInput!) { createBalanceApplicationRequest(input: $input) { status body } } ``` Variables: ```json { "input": { "balanceSourceType": null, "balanceSourceId": "example", "idempotencyKey": "example", "customerAccountId": "123", "userId": "123", "invoices": null } } ``` Sample response: ```json { "data": { "createBalanceApplicationRequest": { "status": "example", "body": { "id": "123", "createdOn": {}, "balanceSourceType": {}, "balanceSourceId": "example", "idempotencyKey": "example" } } } } ``` ### createBillingRelationship Create new billing relationship Arguments: - input: CreateBillingRelationshipInput! (required) Signature: ```graphql createBillingRelationship(input: CreateBillingRelationshipInput!): CreateBillingRelationshipPayload ``` ```graphql mutation createBillingRelationship($input: CreateBillingRelationshipInput!) { createBillingRelationship(input: $input) { billingRelationship validationErrors } } ``` Variables: ```json { "input": { "locale": null, "label": "example", "description": "example", "relationships": null } } ``` Sample response: ```json { "data": { "createBillingRelationship": { "billingRelationship": { "id": "123", "tenant": "example", "relationships": {}, "status": {}, "label": "example" }, "validationErrors": { "code": "example", "message": "example", "timestamp": {} } } } } ``` ### createFunction Create a function. Arguments: - input: CreateFunctionInput! (required) Signature: ```graphql createFunction(input: CreateFunctionInput!): CreateFunctionPayload! ``` ```graphql mutation createFunction($input: CreateFunctionInput!) { createFunction(input: $input) { function userErrors } } ``` Variables: ```json { "input": { "name": "example", "codeFileName": "example" } } ``` Sample response: ```json { "data": { "createFunction": { "function": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "name": "example" }, "userErrors": { "__typename": "InvalidFunctionNameError" } } } } ``` ### createHighGrowthOffer Arguments: - input: HighGrowthOfferInput! (required) Signature: ```graphql createHighGrowthOffer(input: HighGrowthOfferInput!): CreateHighGrowthOfferPayload! ``` ```graphql mutation createHighGrowthOffer($input: HighGrowthOfferInput!) { createHighGrowthOffer(input: $input) { highGrowthOffer userErrors } } ``` Variables: ```json { "input": { "renewalCode": "example", "productId": "123", "offerId": "example", "customerId": "example", "companyUuid": "example", "requestType": null } } ``` Sample response: ```json { "data": { "createHighGrowthOffer": { "highGrowthOffer": { "id": "123", "renewalCode": "example", "offerId": "example", "subscriptionId": "example", "customerId": "example" }, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### createInventory Create an inventory record Arguments: - input: CreateInventoryInput! (required) Signature: ```graphql createInventory(input: CreateInventoryInput!): CreateInventoryPayload! ``` ```graphql mutation createInventory($input: CreateInventoryInput!) { createInventory(input: $input) { inventory } } ``` Variables: ```json { "input": { "editionCode": "example", "sku": "example" } } ``` Sample response: ```json { "data": { "createInventory": { "inventory": { "id": "123", "editionCode": "example", "sku": "example", "stock": 1, "vendorId": "123" } } } } ``` ### createMissingIndexes Signature: ```graphql createMissingIndexes: ProductSearchCreateMissingIndexesPayload! ``` ```graphql mutation createMissingIndexes { createMissingIndexes { success results userErrors } } ``` Sample response: ```json { "data": { "createMissingIndexes": { "success": true, "results": { "success": true, "message": "example", "errorCause": {} }, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### createNotificationOptOut OptOut notifications for given notification delivery method, notification types and target Arguments: - input: CreateNotificationOptOutInput! (required) - Input object to create notification opt out Signature: ```graphql createNotificationOptOut(input: CreateNotificationOptOutInput!): CreateNotificationOptOutPayload! ``` ```graphql mutation createNotificationOptOut($input: CreateNotificationOptOutInput!) { createNotificationOptOut(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "types": null, "target": "example" } } ``` Sample response: ```json { "data": { "createNotificationOptOut": { "success": true, "errors": { "__typename": "InvalidOptoutEmailError" } } } } ``` ### createOrUpdateAdobe3YCCommitments Arguments: - adobe3YCCommitmentsRequest: Adobe3YCCommitmentsRequest! (required) Signature: ```graphql createOrUpdateAdobe3YCCommitments(adobe3YCCommitmentsRequest: Adobe3YCCommitmentsRequest!): Adobe3YCCommitmentsResponse ``` ```graphql mutation createOrUpdateAdobe3YCCommitments($adobe3YCCommitmentsRequest: Adobe3YCCommitmentsRequest!) { createOrUpdateAdobe3YCCommitments(adobe3YCCommitmentsRequest: $adobe3YCCommitmentsRequest) { customerResponse } } ``` Variables: ```json { "adobe3YCCommitmentsRequest": { "action": null, "companyUUID": "example" } } ``` Sample response: ```json { "data": { "createOrUpdateAdobe3YCCommitments": { "customerResponse": { "customerId": "example", "cotermDate": "example", "creationDate": "example", "status": "example", "externalReferenceId": "example" } } } } ``` ### createOrUpdateAdobeCustomerAccount Arguments: - adobeCustomerAccountRequest: AdobeCustomerAccountRequest! (required) Signature: ```graphql createOrUpdateAdobeCustomerAccount(adobeCustomerAccountRequest: AdobeCustomerAccountRequest!): AdobeCustomerAccountResponse ``` ```graphql mutation createOrUpdateAdobeCustomerAccount($adobeCustomerAccountRequest: AdobeCustomerAccountRequest!) { createOrUpdateAdobeCustomerAccount(adobeCustomerAccountRequest: $adobeCustomerAccountRequest) { customerResponse } } ``` Variables: ```json { "adobeCustomerAccountRequest": { "action": null, "customerCompanyUuid": "example", "customerCompanyName": "example", "firstName": "example", "lastName": "example", "email": "example", "address": "example", "city": "example", "country": "example", "state": "example", "zip": "example", "preferredLanguage": "example" } } ``` Sample response: ```json { "data": { "createOrUpdateAdobeCustomerAccount": { "customerResponse": { "customerId": "example", "cotermDate": "example", "creationDate": "example", "status": "example", "externalReferenceId": "example" } } } } ``` ### createPayment Create a payment for an intent, e.g. USER, COMPANY, INVOICE Arguments: - input: CreatePaymentInput! (required) Signature: ```graphql createPayment(input: CreatePaymentInput!): CreatePaymentPayload! ``` ```graphql mutation createPayment($input: CreatePaymentInput!) { createPayment(input: $input) { payment userErrors } } ``` Variables: ```json { "input": { "amount": null, "currency": null, "intents": null, "userId": "123", "accountId": "123", "flowType": null, "merchantOfRecordId": "example", "merchantOfRecordType": "example" } } ``` Sample response: ```json { "data": { "createPayment": { "payment": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createProduct Create a product Arguments: - input: CreateProductInput! (required) Signature: ```graphql createProduct(input: CreateProductInput!): CreateProductPayload! ``` ```graphql mutation createProduct($input: CreateProductInput!) { createProduct(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "type": null, "addon": true, "allowMultiplePurchases": true, "usageType": null, "referable": true } } ``` Sample response: ```json { "data": { "createProduct": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "UnspecifiedVendorError" } } } } ``` ### createProductEdition Create an edition Arguments: - input: CreateProductEditionInput! (required) Signature: ```graphql createProductEdition(input: CreateProductEditionInput!): CreateProductEditionPayload! ``` ```graphql mutation createProductEdition($input: CreateProductEditionInput!) { createProductEdition(input: $input) { edition userErrors } } ``` Variables: ```json { "input": { "productId": "123", "code": null } } ``` Sample response: ```json { "data": { "createProductEdition": { "edition": { "id": "123", "version": "example", "code": "example", "product": {}, "inventory": {} }, "userErrors": { "__typename": "StringTooLongError" } } } } ``` ### createProductEditionAssociations Create an association between editions Arguments: - input: CreateProductEditionAssociationsInput! (required) - Input for Creating Product Edition Association Signature: ```graphql createProductEditionAssociations(input: CreateProductEditionAssociationsInput!): CreateProductEditionAssociationsPayload! ``` ```graphql mutation createProductEditionAssociations($input: CreateProductEditionAssociationsInput!) { createProductEditionAssociations(input: $input) { associations productEdition userErrors } } ``` Variables: ```json { "input": { "productEdition": null, "requiresAnyOf": null } } ``` Sample response: ```json { "data": { "createProductEditionAssociations": { "associations": { "id": "123", "productEdition": {}, "requiresAllOf": {} }, "productEdition": { "id": "123", "version": "example", "code": "example", "product": {}, "inventory": {} }, "userErrors": { "__typename": "ProductEditionNotFoundError" } } } } ``` ### createProductIntegration Create product integration. Arguments: - input: CreateProductIntegrationInput! (required) - Input to create a product integration. Signature: ```graphql createProductIntegration(input: CreateProductIntegrationInput!): CreateProductIntegrationPayload! ``` ```graphql mutation createProductIntegration($input: CreateProductIntegrationInput!) { createProductIntegration(input: $input) { productIntegration userErrors } } ``` Variables: ```json { "input": { "name": "example", "vendorId": "123" } } ``` Sample response: ```json { "data": { "createProductIntegration": { "productIntegration": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} }, "userErrors": { "__typename": "CreateProductIntegrationUnspecifiedVendorError" } } } } ``` ### createProgramApplicant Arguments: - input: CreateProgramApplicantInput! (required) Signature: ```graphql createProgramApplicant(input: CreateProgramApplicantInput!): CreateProgramApplicantPayload! ``` ```graphql mutation createProgramApplicant($input: CreateProgramApplicantInput!) { createProgramApplicant(input: $input) { applicant } } ``` Variables: ```json { "input": { "programType": "example", "answers": null } } ``` Sample response: ```json { "data": { "createProgramApplicant": { "applicant": { "id": "123", "programType": {}, "answers": {}, "status": {}, "appliedOn": {} } } } } ``` ### createPsaAddition Create a psa addition Arguments: - input: CreatePsaAdditionInput! (required) Signature: ```graphql createPsaAddition(input: CreatePsaAdditionInput!): CreatePsaAdditionPayload! ``` ```graphql mutation createPsaAddition($input: CreatePsaAdditionInput!) { createPsaAddition(input: $input) { additionId userErrors } } ``` Variables: ```json { "input": { "mor": null, "agreementId": "123", "quantity": null, "itemId": "123" } } ``` Sample response: ```json { "data": { "createPsaAddition": { "additionId": "123", "userErrors": { "message": "example", "path": "example" } } } } ``` ### createPsaAdditionForSubscription Sync a psa addition Arguments: - input: CreatePsaAdditionForSubscriptionInput! (required) Signature: ```graphql createPsaAdditionForSubscription(input: CreatePsaAdditionForSubscriptionInput!): CreatePsaAdditionForSubscriptionPayload! ``` ```graphql mutation createPsaAdditionForSubscription($input: CreatePsaAdditionForSubscriptionInput!) { createPsaAdditionForSubscription(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "subscriptionId": "123" } } ``` Sample response: ```json { "data": { "createPsaAdditionForSubscription": { "success": true, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createPsaAdditionForSubscriptionAndAgreement Sync a psa addition with subscription and agreement Arguments: - input: CreatePsaAdditionForSubscriptionAndAgreementInput! (required) Signature: ```graphql createPsaAdditionForSubscriptionAndAgreement(input: CreatePsaAdditionForSubscriptionAndAgreementInput!): CreatePsaAdditionForSubscriptionAndAgreementPayload! ``` ```graphql mutation createPsaAdditionForSubscriptionAndAgreement($input: CreatePsaAdditionForSubscriptionAndAgreementInput!) { createPsaAdditionForSubscriptionAndAgreement(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "subscriptionId": "123", "agreementId": "123" } } ``` Sample response: ```json { "data": { "createPsaAdditionForSubscriptionAndAgreement": { "success": true, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createPsaConnector Create a psa sync service connector Arguments: - input: CreatePsaConnectorInput! (required) Signature: ```graphql createPsaConnector(input: CreatePsaConnectorInput!): CreatePsaConnectorPayload! ``` ```graphql mutation createPsaConnector($input: CreatePsaConnectorInput!) { createPsaConnector(input: $input) { connector userErrors } } ``` Variables: ```json { "input": { "name": "example", "type": null } } ``` Sample response: ```json { "data": { "createPsaConnector": { "connector": { "id": "123", "name": "example", "type": {}, "configuration": {}, "credentials": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createPsaConnectorConfiguration Create a psa sync service connector configuration for an merchant of record Arguments: - input: CreatePsaConnectorConfigurationInput! (required) Signature: ```graphql createPsaConnectorConfiguration(input: CreatePsaConnectorConfigurationInput!): CreatePsaConnectorConfigurationPayload! ``` ```graphql mutation createPsaConnectorConfiguration($input: CreatePsaConnectorConfigurationInput!) { createPsaConnectorConfiguration(input: $input) { connectorConfiguration userErrors } } ``` Variables: ```json { "input": { "connectorId": "123", "mor": null, "configuration": null } } ``` Sample response: ```json { "data": { "createPsaConnectorConfiguration": { "connectorConfiguration": { "id": "123", "connectorId": "123", "mor": {}, "configuration": {}, "credentials": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createPsaProductMapping Create a product mapping Arguments: - input: CreatePsaProductMappingInput! (required) Signature: ```graphql createPsaProductMapping(input: CreatePsaProductMappingInput!): CreatePsaProductMappingPayload! ``` ```graphql mutation createPsaProductMapping($input: CreatePsaProductMappingInput!) { createPsaProductMapping(input: $input) { productMapping userErrors } } ``` Variables: ```json { "input": { "mor": null, "productId": "123", "editionId": "123", "editionPricingId": "123", "itemId": "123", "psaProduct": null } } ``` Sample response: ```json { "data": { "createPsaProductMapping": { "productMapping": { "id": "123", "connectorType": {}, "mor": {}, "product": {}, "productName": "example" }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createRefundPayment Create a refund payment for an intent, e.g. USER, COMPANY, INVOICE Arguments: - input: CreateRefundPaymentInput! (required) Signature: ```graphql createRefundPayment(input: CreateRefundPaymentInput!): CreatePaymentPayload! ``` ```graphql mutation createRefundPayment($input: CreateRefundPaymentInput!) { createRefundPayment(input: $input) { payment userErrors } } ``` Variables: ```json { "input": { "originalPaymentId": "123", "flowType": null, "intent": null, "source": null, "userId": "123", "accountId": "123", "merchantOfRecordType": "example", "isRefundProcessedOffPlatform": true, "refundReason": "example" } } ``` Sample response: ```json { "data": { "createRefundPayment": { "payment": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createScheduleJobSchedule Create a schedule job schedule Arguments: - input: CreateScheduleJobScheduleInput! (required) - Attributes to create a schedule job schedule Signature: ```graphql createScheduleJobSchedule(input: CreateScheduleJobScheduleInput!): CreateScheduleJobSchedulePayload! ``` ```graphql mutation createScheduleJobSchedule($input: CreateScheduleJobScheduleInput!) { createScheduleJobSchedule(input: $input) { scheduleJobSchedule userErrors } } ``` Variables: ```json { "input": { "scheduleJobId": "123", "name": "example", "type": "example", "schedule": "example" } } ``` Sample response: ```json { "data": { "createScheduleJobSchedule": { "scheduleJobSchedule": { "id": "123", "scheduleJob": {}, "scheduleName": "example", "scheduleStatus": "example", "scheduleType": "example" }, "userErrors": { "__typename": "BackoffLimitValueError" } } } } ``` ### createSerializedUnitsForShipment Creates a list of serialized units for a shipping item in a shipment. Arguments: - input: CreateSerializedUnitsForShipmentInput! (required) Signature: ```graphql createSerializedUnitsForShipment(input: CreateSerializedUnitsForShipmentInput!): CreateSerializedUnitsForShipmentPayload! ``` ```graphql mutation createSerializedUnitsForShipment($input: CreateSerializedUnitsForShipmentInput!) { createSerializedUnitsForShipment(input: $input) { serializedUnits } } ``` Variables: ```json { "input": { "purchaseId": "123", "shipmentId": "123", "serializedUnitsMappings": null } } ``` Sample response: ```json { "data": { "createSerializedUnitsForShipment": { "serializedUnits": { "id": "123", "purchase": {}, "shipment": {}, "fulfillmentItem": {}, "serializedIdentifiers": {} } } } } ``` ### createSubscriptionSyncRequests Arguments: - requests: [GraphQLSubscriptionSyncRequest!]! (required) Signature: ```graphql createSubscriptionSyncRequests(requests: [GraphQLSubscriptionSyncRequest!]!): [MicrosoftSubscriptionSyncResponse!]! ``` ```graphql mutation createSubscriptionSyncRequests($requests: [GraphQLSubscriptionSyncRequest!]!) { createSubscriptionSyncRequests(requests: $requests) { offerName companyName status requestUuid partner } } ``` Variables: ```json { "requests": [ { "subscriptionUuid": "example", "companyName": "example" } ] } ``` Sample response: ```json { "data": { "createSubscriptionSyncRequests": { "requestUuid": "example", "status": "example", "partner": "example", "country": "example", "tenantId": "example" } } } ``` ### createTenantWebhookConfiguration Create a new tenant scoped webhook configuration Arguments: - input: CreateTenantWebhookConfigurationInput! (required) Signature: ```graphql createTenantWebhookConfiguration(input: CreateTenantWebhookConfigurationInput!): CreateTenantWebhookConfigurationPayload! ``` ```graphql mutation createTenantWebhookConfiguration($input: CreateTenantWebhookConfigurationInput!) { createTenantWebhookConfiguration(input: $input) { webhookConfiguration userErrors } } ``` Variables: ```json { "input": { "resourceType": null, "resourceActions": null } } ``` Sample response: ```json { "data": { "createTenantWebhookConfiguration": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} }, "userErrors": { "__typename": "DuplicateWebhookConfigurationError" } } } } ``` ### createUpdatePsaCompanyMapping Create or update a company mapping only for user interface Arguments: - input: CreatePsaCompanyMappingInput! (required) Signature: ```graphql createUpdatePsaCompanyMapping(input: CreatePsaCompanyMappingInput!): PsaCompanyMappingsPayload! ``` ```graphql mutation createUpdatePsaCompanyMapping($input: CreatePsaCompanyMappingInput!) { createUpdatePsaCompanyMapping(input: $input) { companyMapping userErrors } } ``` Variables: ```json { "input": { "mor": null, "accountId": "123", "psaCompanies": null } } ``` Sample response: ```json { "data": { "createUpdatePsaCompanyMapping": { "companyMapping": { "id": "123", "accountId": "123", "mor": {}, "tenant": "example", "connectorType": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### createUsageFileUploadLink Mutation to create an upload-link on which usage file is uploaded Arguments: - input: CreateUsageFileUploadLinkInput! (required) Signature: ```graphql createUsageFileUploadLink(input: CreateUsageFileUploadLinkInput!): CreateUsageFileUploadLinkPayload! ``` ```graphql mutation createUsageFileUploadLink($input: CreateUsageFileUploadLinkInput!) { createUsageFileUploadLink(input: $input) { fileName fileId requestGroupId uploadLink expiration } } ``` Variables: ```json { "input": { "fileName": "example" } } ``` Sample response: ```json { "data": { "createUsageFileUploadLink": { "fileId": "123", "fileName": "example", "uploadLink": {}, "expiration": {}, "requestGroupId": "example" } } } ``` ### createUsageReader Create a Usage Reader Arguments: - input: CreateUsageReaderInput! (required) - Attributes to create a Usage Reader Signature: ```graphql createUsageReader(input: CreateUsageReaderInput!): CreateUsageReaderPayload! ``` ```graphql mutation createUsageReader($input: CreateUsageReaderInput!) { createUsageReader(input: $input) { id name vendorId productId billable } } ``` Variables: ```json { "input": { "name": "example", "vendorId": "example", "productId": "example", "usageProcessingType": null, "parser": null, "updatedDate": null } } ``` Sample response: ```json { "data": { "createUsageReader": { "id": "example", "vendorId": "example", "productId": "example", "name": "example", "usageItemType": {} } } } ``` ### createUsageReaderConfiguration Create a usage reader Arguments: - input: CreateUsageReaderConfigurationInput! (required) - Attributes to create a usage reader Signature: ```graphql createUsageReaderConfiguration(input: CreateUsageReaderConfigurationInput!): CreateUsageReaderConfigurationPayload! ``` ```graphql mutation createUsageReaderConfiguration($input: CreateUsageReaderConfigurationInput!) { createUsageReaderConfiguration(input: $input) { reader userErrors } } ``` Variables: ```json { "input": { "name": "example", "inputType": null, "productId": "example", "fieldMappings": null, "createdBy": "example" } } ``` Sample response: ```json { "data": { "createUsageReaderConfiguration": { "reader": { "id": "123", "name": "example", "inputType": {}, "productId": "example", "product": {} }, "userErrors": { "__typename": "UsageReaderAlreadyExistsError" } } } } ``` ### createUsageReaderWithFieldDefinitions Create Usage Reader only with field definitions Arguments: - input: CreateUsageReaderWithFieldDefinitionsInput! (required) - Input to create usage reader only with field definitions Signature: ```graphql createUsageReaderWithFieldDefinitions(input: CreateUsageReaderWithFieldDefinitionsInput!): CreateUsageReaderWithFieldDefinitionsPayload! ``` ```graphql mutation createUsageReaderWithFieldDefinitions($input: CreateUsageReaderWithFieldDefinitionsInput!) { createUsageReaderWithFieldDefinitions(input: $input) { readerId userErrors } } ``` Variables: ```json { "input": { "name": "example", "vendorId": "example", "productId": "example", "usageProcessingType": null, "parser": null } } ``` Sample response: ```json { "data": { "createUsageReaderWithFieldDefinitions": { "readerId": "123", "userErrors": { "__typename": "UsageReaderAlreadyExistsForVendorAndProductError" } } } } ``` ### createVisualizationDataset Arguments: - input: CreateVisualizationDatasetInput! (required) - Input sent to the createVisualizationDataset mutation Signature: ```graphql createVisualizationDataset(input: CreateVisualizationDatasetInput!): CreateVisualizationDatasetPayload! ``` ```graphql mutation createVisualizationDataset($input: CreateVisualizationDatasetInput!) { createVisualizationDataset(input: $input) { dataset userErrors } } ``` Variables: ```json { "input": { "name": "example", "productId": "123", "datasetSchema": null } } ``` Sample response: ```json { "data": { "createVisualizationDataset": { "dataset": { "id": "123", "revisionId": 1, "revision": {}, "productId": "123", "name": "example" }, "userErrors": { "__typename": "CreateVisualizationDatasetTooManyDatasetsError" } } } } ``` ### createVisualizationMetric Arguments: - input: CreateVisualizationMetricInput! (required) - Input sent to the createVisualizationMetric mutation Signature: ```graphql createVisualizationMetric(input: CreateVisualizationMetricInput!): CreateVisualizationMetricPayload! ``` ```graphql mutation createVisualizationMetric($input: CreateVisualizationMetricInput!) { createVisualizationMetric(input: $input) { metric userErrors } } ``` Variables: ```json { "input": { "name": "example", "productId": "123", "datasetId": "123", "revisionId": 1, "query": "example" } } ``` Sample response: ```json { "data": { "createVisualizationMetric": { "metric": { "name": "example", "id": "123", "productId": "123", "datasetId": "123", "revisionId": 1 }, "userErrors": { "__typename": "VisualizationMetricInvalidQueryError" } } } } ``` ### customizeProductSearchSettings Arguments: - input: CustomizeProductSearchSettingsInput! (required) Signature: ```graphql customizeProductSearchSettings(input: CustomizeProductSearchSettingsInput!): CustomizeProductSearchSettingsPayload! ``` ```graphql mutation customizeProductSearchSettings($input: CustomizeProductSearchSettingsInput!) { customizeProductSearchSettings(input: $input) { productSearchSettings userErrors } } ``` Variables: ```json { "input": { "productSearchableFields": null, "algorithmVersion": null } } ``` Sample response: ```json { "data": { "customizeProductSearchSettings": { "productSearchSettings": { "fields": {}, "lastPublished": {}, "algorithmVersion": {} }, "userErrors": { "__typename": "InvalidFieldNameError" } } } } ``` ### deactivateUsageReader Updates usage reader status as INACTIVE Arguments: - input: DeactivateUsageReaderInput! (required) - Input to update usage reader status as INACTIVE Signature: ```graphql deactivateUsageReader(input: DeactivateUsageReaderInput!): DeactivateUsageReaderPayload! ``` ```graphql mutation deactivateUsageReader($input: DeactivateUsageReaderInput!) { deactivateUsageReader(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "readerId": "example", "updatedBy": "example" } } ``` Sample response: ```json { "data": { "deactivateUsageReader": { "success": true, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### deleteAccount Delete an existing marketplace account (company) Arguments: - input: DeleteAccountInput! (required) - Specifies data to identify account (company) Signature: ```graphql deleteAccount(input: DeleteAccountInput!): DeleteAccountPayload! ``` ```graphql mutation deleteAccount($input: DeleteAccountInput!) { deleteAccount(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "accountId": "123" } } ``` Sample response: ```json { "data": { "deleteAccount": { "success": true, "userErrors": { "__typename": "AccountWithExistingEntitlementsError" } } } } ``` ### deleteAccountAssociation Delete an existing reseller account association with customer account Arguments: - input: DeleteAccountAssociationInput! (required) - Specifies data to identify reseller account association with customer account Signature: ```graphql deleteAccountAssociation(input: DeleteAccountAssociationInput!): DeleteAccountAssociationPayload! ``` ```graphql mutation deleteAccountAssociation($input: DeleteAccountAssociationInput!) { deleteAccountAssociation(input: $input) { success } } ``` Variables: ```json { "input": { "accountAssociationId": "123" } } ``` Sample response: ```json { "data": { "deleteAccountAssociation": { "success": true } } } ``` ### deleteAccountMembership Delete a marketplace user's account (company) membership. If this is the only company the user was member of, the user is marked as deleted. A user who has active entitlements, owns products, or is managed on an external system can't be deleted. Arguments: - input: DeleteAccountMembershipInput! (required) - Specifies data to identify account (company) membership Signature: ```graphql deleteAccountMembership(input: DeleteAccountMembershipInput!): DeleteAccountMembershipPayload! ``` ```graphql mutation deleteAccountMembership($input: DeleteAccountMembershipInput!) { deleteAccountMembership(input: $input) { success } } ``` Variables: ```json { "input": { "accountId": "123", "userId": "123" } } ``` Sample response: ```json { "data": { "deleteAccountMembership": { "success": true } } } ``` ### deleteBillingRelationship Delete billing relationship Arguments: - input: DeleteBillingRelationshipInput! (required) Signature: ```graphql deleteBillingRelationship(input: DeleteBillingRelationshipInput!): DeleteBillingRelationshipPayload ``` ```graphql mutation deleteBillingRelationship($input: DeleteBillingRelationshipInput!) { deleteBillingRelationship(input: $input) { success validationErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteBillingRelationship": { "success": true, "validationErrors": { "code": "example", "message": "example", "timestamp": {} } } } } ``` ### deleteDistributorAccount Delete an existing distributor account Arguments: - input: DeleteDistributorAccountInput! (required) Signature: ```graphql deleteDistributorAccount(input: DeleteDistributorAccountInput!): DeleteDistributorAccountPayload! ``` ```graphql mutation deleteDistributorAccount($input: DeleteDistributorAccountInput!) { deleteDistributorAccount(input: $input) { deleted } } ``` Variables: ```json { "input": { "id": "example" } } ``` Sample response: ```json { "data": { "deleteDistributorAccount": { "deleted": true } } } ``` ### deleteFunction Delete an existing function. Arguments: - input: DeleteFunctionInput! (required) Signature: ```graphql deleteFunction(input: DeleteFunctionInput!): DeleteFunctionPayload! ``` ```graphql mutation deleteFunction($input: DeleteFunctionInput!) { deleteFunction(input: $input) { deleted userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteFunction": { "deleted": true, "userErrors": { "__typename": "ReferencedFunctionError" } } } } ``` ### deleteInventory Delete an inventory record Arguments: - input: DeleteInventoryInput! (required) Signature: ```graphql deleteInventory(input: DeleteInventoryInput!): DeleteInventoryPayload! ``` ```graphql mutation deleteInventory($input: DeleteInventoryInput!) { deleteInventory(input: $input) { deletedId } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteInventory": { "deletedId": "123" } } } ``` ### deleteInvoice Delete an invoice Arguments: - input: DeleteInvoiceInput! (required) Signature: ```graphql deleteInvoice(input: DeleteInvoiceInput!): DeleteInvoicePayload! ``` ```graphql mutation deleteInvoice($input: DeleteInvoiceInput!) { deleteInvoice(input: $input) { operationStatus userErrors } } ``` Variables: ```json { "input": { "invoiceId": "123" } } ``` Sample response: ```json { "data": { "deleteInvoice": { "operationStatus": {}, "userErrors": { "__typename": "InvoiceHasInvalidStatusError" } } } } ``` ### deleteNotificationOptOut OptIn notifications for given notification delivery method, notification types and target Arguments: - input: DeleteNotificationOptOutInput! (required) - Input object to delete notification opt out Signature: ```graphql deleteNotificationOptOut(input: DeleteNotificationOptOutInput!): DeleteNotificationOptOutPayload! ``` ```graphql mutation deleteNotificationOptOut($input: DeleteNotificationOptOutInput!) { deleteNotificationOptOut(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "types": null, "target": "example" } } ``` Sample response: ```json { "data": { "deleteNotificationOptOut": { "success": true, "errors": { "__typename": "DeleteNotificationOptOutInvalidInputError" } } } } ``` ### deleteNotificationOptOutsForTargets OptIn notifications for given notification delivery method and targets Arguments: - input: DeleteNotificationOptOutsForTargetsInput! (required) - Input object to delete notification opt outs for given types Signature: ```graphql deleteNotificationOptOutsForTargets(input: DeleteNotificationOptOutsForTargetsInput!): DeleteNotificationOptOutsForTargetsPayload! ``` ```graphql mutation deleteNotificationOptOutsForTargets($input: DeleteNotificationOptOutsForTargetsInput!) { deleteNotificationOptOutsForTargets(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "targets": "example" } } ``` Sample response: ```json { "data": { "deleteNotificationOptOutsForTargets": { "success": true, "errors": { "__typename": "DeleteNotificationOptOutsForTargetsInvalidInputError" } } } } ``` ### deleteNotificationOptOutsForTypes OptIn notifications for given notification delivery method and notification types Arguments: - input: DeleteNotificationOptOutsForTypesInput! (required) - Input object to delete notification opt outs for given types Signature: ```graphql deleteNotificationOptOutsForTypes(input: DeleteNotificationOptOutsForTypesInput!): DeleteNotificationOptOutsForTypesPayload! ``` ```graphql mutation deleteNotificationOptOutsForTypes($input: DeleteNotificationOptOutsForTypesInput!) { deleteNotificationOptOutsForTypes(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "types": null } } ``` Sample response: ```json { "data": { "deleteNotificationOptOutsForTypes": { "success": true, "errors": { "__typename": "DeleteNotificationOptOutsForTypesInvalidInputError" } } } } ``` ### deleteNotificationTemplate Deletes a specific notification template (identified by ID and type). Arguments: - input: DeleteNotificationTemplateInput! (required) - Input used to update a specific notification template. Signature: ```graphql deleteNotificationTemplate(input: DeleteNotificationTemplateInput!): DeleteNotificationTemplatePayload! ``` ```graphql mutation deleteNotificationTemplate($input: DeleteNotificationTemplateInput!) { deleteNotificationTemplate(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "type": null, "id": "123" } } ``` Sample response: ```json { "data": { "deleteNotificationTemplate": { "success": true, "errors": { "__typename": "DeleteNotificationTemplateInvalidInputError" } } } } ``` ### deleteProductEditionAssociation Delete an association Arguments: - input: DeleteProductEditionAssociationInput! (required) - Input for Deleting Product Edition Association Signature: ```graphql deleteProductEditionAssociation(input: DeleteProductEditionAssociationInput!): DeleteProductEditionAssociationPayload! ``` ```graphql mutation deleteProductEditionAssociation($input: DeleteProductEditionAssociationInput!) { deleteProductEditionAssociation(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteProductEditionAssociation": { "success": true, "userErrors": { "__typename": "ProductEditionAssociationNotFoundError" } } } } ``` ### deleteProductIntegrationSingleSignOnConfigurationSetupForm Delete the single sign-on setup form configuration within an existing product integration Arguments: - input: DeleteProductIntegrationSingleSignOnConfigurationSetupFormInput! (required) Signature: ```graphql deleteProductIntegrationSingleSignOnConfigurationSetupForm(input: DeleteProductIntegrationSingleSignOnConfigurationSetupFormInput!): DeleteProductIntegrationSingleSignOnConfigurationSetupFormPayload! ``` ```graphql mutation deleteProductIntegrationSingleSignOnConfigurationSetupForm($input: DeleteProductIntegrationSingleSignOnConfigurationSetupFormInput!) { deleteProductIntegrationSingleSignOnConfigurationSetupForm(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123" } } ``` Sample response: ```json { "data": { "deleteProductIntegrationSingleSignOnConfigurationSetupForm": { "success": true, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### deleteProductReviews Remove all product reviews by product IDs. This operation is idempotent and will return true even if a product ID is not found. Arguments: - input: DeleteProductReviewsInput! (required) - Specifies product IDs Signature: ```graphql deleteProductReviews(input: DeleteProductReviewsInput!): DeleteProductReviewsPayload ``` ```graphql mutation deleteProductReviews($input: DeleteProductReviewsInput!) { deleteProductReviews(input: $input) { success } } ``` Variables: ```json { "input": { "externalProvider": "example", "productIds": "example" } } ``` Sample response: ```json { "data": { "deleteProductReviews": { "success": true } } } ``` ### deleteProviderReviews Remove all product reviews for a given external provider Arguments: - externalProvider: String! (required) - External provider name Signature: ```graphql deleteProviderReviews(externalProvider: String!): DeleteProviderReviewsPayload ``` ```graphql mutation deleteProviderReviews($externalProvider: String!) { deleteProviderReviews(externalProvider: $externalProvider) { success } } ``` Variables: ```json { "externalProvider": "example" } ``` Sample response: ```json { "data": { "deleteProviderReviews": { "success": true } } } ``` ### deleteReviews Remove product reviews by external provider review IDs. This operation is idempotent and will return true even if a product review ID is not found. Arguments: - input: DeleteReviewsInput! (required) - Specifies review IDs to delete Signature: ```graphql deleteReviews(input: DeleteReviewsInput!): DeleteReviewsPayload ``` ```graphql mutation deleteReviews($input: DeleteReviewsInput!) { deleteReviews(input: $input) { success } } ``` Variables: ```json { "input": { "externalProvider": "example", "providerReviewIds": "example" } } ``` Sample response: ```json { "data": { "deleteReviews": { "success": true } } } ``` ### deleteScheduleJobSchedule Delete a schedule job schedule Arguments: - input: DeleteScheduleJobScheduleInput! (required) - Attributes to delete a schedule job schedule Signature: ```graphql deleteScheduleJobSchedule(input: DeleteScheduleJobScheduleInput!): DeleteScheduleJobSchedulePayload! ``` ```graphql mutation deleteScheduleJobSchedule($input: DeleteScheduleJobScheduleInput!) { deleteScheduleJobSchedule(input: $input) { scheduleJobSchedule userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteScheduleJobSchedule": { "scheduleJobSchedule": { "id": "123", "scheduleJob": {}, "scheduleName": "example", "scheduleStatus": "example", "scheduleType": "example" }, "userErrors": { "__typename": "InvalidScheduleIdError" } } } } ``` ### deleteSerializedUnitsForShipment Deletes a list of serialized units. Arguments: - input: DeleteSerializedUnitsForShipmentInput! (required) Signature: ```graphql deleteSerializedUnitsForShipment(input: DeleteSerializedUnitsForShipmentInput!): DeleteSerializedUnitsForShipmentPayload ``` ```graphql mutation deleteSerializedUnitsForShipment($input: DeleteSerializedUnitsForShipmentInput!) { deleteSerializedUnitsForShipment(input: $input) { deletedSerializedUnitIds } } ``` Variables: ```json { "input": { "purchaseId": "123", "shipmentId": "123", "serializedUnitIdsMappings": null } } ``` Sample response: ```json { "data": { "deleteSerializedUnitsForShipment": { "deletedSerializedUnitIds": "123" } } } ``` ### deleteUsageReader Deletes a usage reader Arguments: - input: DeleteUsageReaderInput! (required) - Input for deleting usage reader Signature: ```graphql deleteUsageReader(input: DeleteUsageReaderInput!): DeleteUsageReaderPayload! ``` ```graphql mutation deleteUsageReader($input: DeleteUsageReaderInput!) { deleteUsageReader(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "id": "123", "deletedBy": "example" } } ``` Sample response: ```json { "data": { "deleteUsageReader": { "success": true, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### deleteVisualizationMetric Arguments: - input: DeleteVisualizationMetricInput! (required) - Input sent to the deleteVisualizationMetric mutation Signature: ```graphql deleteVisualizationMetric(input: DeleteVisualizationMetricInput!): DeleteVisualizationMetricPayload! ``` ```graphql mutation deleteVisualizationMetric($input: DeleteVisualizationMetricInput!) { deleteVisualizationMetric(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "id": "example" } } ``` Sample response: ```json { "data": { "deleteVisualizationMetric": { "success": true, "userErrors": { "__typename": "DeleteVisualizationMetricInvalidIdError" } } } } ``` ### deleteWebhookConfiguration Delete a webhook configuration Arguments: - input: DeleteWebhookConfigurationInput! (required) Signature: ```graphql deleteWebhookConfiguration(input: DeleteWebhookConfigurationInput!): DeleteWebhookConfigurationPayload! ``` ```graphql mutation deleteWebhookConfiguration($input: DeleteWebhookConfigurationInput!) { deleteWebhookConfiguration(input: $input) { deletedId } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "deleteWebhookConfiguration": { "deletedId": "123" } } } ``` ### disableAccountMembership Disable marketplace user's account (company) membership. This only changes the user account membership's enabled status; all other attributes are ignored. Arguments: - input: DisableAccountMembershipInput! (required) - Specifies data to identify account (company) membership Signature: ```graphql disableAccountMembership(input: DisableAccountMembershipInput!): DisableAccountMembershipPayload! ``` ```graphql mutation disableAccountMembership($input: DisableAccountMembershipInput!) { disableAccountMembership(input: $input) { accountMembership } } ``` Variables: ```json { "input": { "accountId": "123", "userId": "123" } } ``` Sample response: ```json { "data": { "disableAccountMembership": { "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true } } } } ``` ### disableProductVariants Disable a product variant Arguments: - input: DisableProductVariantsInput! (required) Signature: ```graphql disableProductVariants(input: DisableProductVariantsInput!): DisableProductVariantsPayload! ``` ```graphql mutation disableProductVariants($input: DisableProductVariantsInput!) { disableProductVariants(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "configuration": null } } ``` Sample response: ```json { "data": { "disableProductVariants": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### disableWebhookConfiguration Disable a webhook configuration Arguments: - input: DisableWebhookConfigurationInput! (required) Signature: ```graphql disableWebhookConfiguration(input: DisableWebhookConfigurationInput!): DisableWebhookConfigurationPayload! ``` ```graphql mutation disableWebhookConfiguration($input: DisableWebhookConfigurationInput!) { disableWebhookConfiguration(input: $input) { webhookConfiguration } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "disableWebhookConfiguration": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} } } } } ``` ### enableAccountMembership Enable marketplace user's account (company) membership. This only changes the user account membership's enabled status; all other attributes are ignored. Arguments: - input: EnableAccountMembershipInput! (required) - Specifies data to identify account (company) membership Signature: ```graphql enableAccountMembership(input: EnableAccountMembershipInput!): EnableAccountMembershipPayload! ``` ```graphql mutation enableAccountMembership($input: EnableAccountMembershipInput!) { enableAccountMembership(input: $input) { accountMembership } } ``` Variables: ```json { "input": { "accountId": "123", "userId": "123" } } ``` Sample response: ```json { "data": { "enableAccountMembership": { "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true } } } } ``` ### enableProductVariants Enable a product variant Arguments: - input: EnableProductVariantsInput! (required) Signature: ```graphql enableProductVariants(input: EnableProductVariantsInput!): EnableProductVariantsPayload! ``` ```graphql mutation enableProductVariants($input: EnableProductVariantsInput!) { enableProductVariants(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "configuration": null } } ``` Sample response: ```json { "data": { "enableProductVariants": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### enableWebhookConfiguration Enable a webhook configuration Arguments: - input: EnableWebhookConfigurationInput! (required) Signature: ```graphql enableWebhookConfiguration(input: EnableWebhookConfigurationInput!): EnableWebhookConfigurationPayload! ``` ```graphql mutation enableWebhookConfiguration($input: EnableWebhookConfigurationInput!) { enableWebhookConfiguration(input: $input) { webhookConfiguration } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "enableWebhookConfiguration": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} } } } } ``` ### enrollToLinkedMembership Arguments: - input: EnrollToLinkedMembershipRequest! (required) Signature: ```graphql enrollToLinkedMembership(input: EnrollToLinkedMembershipRequest!): EnrollToLinkedMembershipResponse ``` ```graphql mutation enrollToLinkedMembership($input: EnrollToLinkedMembershipRequest!) { enrollToLinkedMembership(input: $input) { success message } } ``` Variables: ```json { "input": { "customerId": "example", "linkedMembershipId": "example" } } ``` Sample response: ```json { "data": { "enrollToLinkedMembership": { "success": true, "message": "example" } } } ``` ### finalizeCart Completes the cart checkout process and creates an order Arguments: - input: FinalizeCartInput! (required) Signature: ```graphql finalizeCart(input: FinalizeCartInput!): FinalizeCartPayload ``` ```graphql mutation finalizeCart($input: FinalizeCartInput!) { finalizeCart(input: $input) { purchaseDetails userErrors } } ``` Variables: ```json { "input": { "cartId": "123" } } ``` Sample response: ```json { "data": { "finalizeCart": { "purchaseDetails": { "purchaseId": "123", "purchaseNumber": "example" }, "userErrors": { "__typename": "DetailedUserError" } } } } ``` ### generateProductIntegrationInboundClient Generate inbound client credentials for a product integration. Arguments: - input: GenerateProductIntegrationInboundClientInput! (required) - Input to generate inbound client credentials for a product integration. Signature: ```graphql generateProductIntegrationInboundClient(input: GenerateProductIntegrationInboundClientInput!): GenerateProductIntegrationInboundClientPayload! ``` ```graphql mutation generateProductIntegrationInboundClient($input: GenerateProductIntegrationInboundClientInput!) { generateProductIntegrationInboundClient(input: $input) { clientId clientSecret createdOn userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "generateProductIntegrationInboundClient": { "clientId": "example", "clientSecret": "example", "createdOn": {}, "userErrors": { "__typename": "ProductIntegrationNotFoundError" } } } } ``` ### linkProductIntegration Link a product to a product integration Arguments: - input: LinkProductIntegrationInput (optional) Signature: ```graphql linkProductIntegration(input: LinkProductIntegrationInput): LinkProductIntegrationPayload! ``` ```graphql mutation linkProductIntegration($input: LinkProductIntegrationInput) { linkProductIntegration(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "integrationId": "123" } } ``` Sample response: ```json { "data": { "linkProductIntegration": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "ProductIntegrationLinkLimitExceededError" } } } } ``` ### listProductOnStorefront Adds a product to the production catalog of a marketplace. Arguments: - input: ListProductOnStorefrontInput! (required) Signature: ```graphql listProductOnStorefront(input: ListProductOnStorefrontInput!): ListProductOnStorefrontPayload! ``` ```graphql mutation listProductOnStorefront($input: ListProductOnStorefrontInput!) { listProductOnStorefront(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "productId": "123", "productUuid": "123" } } ``` Sample response: ```json { "data": { "listProductOnStorefront": { "success": true, "userErrors": { "__typename": "InvalidIdError" } } } } ``` ### microsoftSubscriptionSyncRequest Arguments: - input: MicrosoftSubscriptionSyncRequestInput! (required) Signature: ```graphql microsoftSubscriptionSyncRequest(input: MicrosoftSubscriptionSyncRequestInput!): MicrosoftSubscriptionSyncResponse ``` ```graphql mutation microsoftSubscriptionSyncRequest($input: MicrosoftSubscriptionSyncRequestInput!) { microsoftSubscriptionSyncRequest(input: $input) { offerName companyName status requestUuid partner } } ``` Variables: ```json { "input": { "subscriptionUuid": "example", "scheduled": true } } ``` Sample response: ```json { "data": { "microsoftSubscriptionSyncRequest": { "requestUuid": "example", "status": "example", "partner": "example", "country": "example", "tenantId": "example" } } } ``` ### migrateAllSearchIndexes Signature: ```graphql migrateAllSearchIndexes: ProductSearchIndexMigrationResponsePayload! ``` ```graphql mutation migrateAllSearchIndexes { migrateAllSearchIndexes { success results userErrors } } ``` Sample response: ```json { "data": { "migrateAllSearchIndexes": { "success": true, "results": { "success": true, "message": "example", "errorCause": {} }, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### migrateDeltaSearchIndexes Signature: ```graphql migrateDeltaSearchIndexes: ProductSearchIndexMigrationDeltaResponsePayload! ``` ```graphql mutation migrateDeltaSearchIndexes { migrateDeltaSearchIndexes { indexStatus success results userErrors } } ``` Sample response: ```json { "data": { "migrateDeltaSearchIndexes": { "indexStatus": { "index": "example", "mappings": {}, "settings": {} }, "success": true, "results": { "success": true, "message": "example", "errorCause": {} }, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### orderProductVariantOptions Edit the order for product variant options Arguments: - input: OrderProductVariantOptionsInput! (required) Signature: ```graphql orderProductVariantOptions(input: OrderProductVariantOptionsInput!): OrderProductVariantOptionsPayload! ``` ```graphql mutation orderProductVariantOptions($input: OrderProductVariantOptionsInput!) { orderProductVariantOptions(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "optionCodeOrder": "example" } } ``` Sample response: ```json { "data": { "orderProductVariantOptions": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "IncompleteProductVariantOptionOrder" } } } } ``` ### orderProductVariantOptionValues Order product variant option values Arguments: - input: OrderProductVariantOptionValuesInput! (required) Signature: ```graphql orderProductVariantOptionValues(input: OrderProductVariantOptionValuesInput!): OrderProductVariantOptionValuesPayload! ``` ```graphql mutation orderProductVariantOptionValues($input: OrderProductVariantOptionValuesInput!) { orderProductVariantOptionValues(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "optionCode": "example", "optionValueCodeOrder": "example" } } ``` Sample response: ```json { "data": { "orderProductVariantOptionValues": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "IncompleteProductVariantOptionValuesOrder" } } } } ``` ### publishProductIntegration Publish product integration. Arguments: - input: PublishProductIntegrationInput! (required) - Input to publish a product integration. Signature: ```graphql publishProductIntegration(input: PublishProductIntegrationInput!): PublishProductIntegrationPayload ``` ```graphql mutation publishProductIntegration($input: PublishProductIntegrationInput!) { publishProductIntegration(input: $input) { productIntegration userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "publishProductIntegration": { "productIntegration": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} }, "userErrors": { "__typename": "ProductIntegrationNotFoundError" } } } } ``` ### publishProductSearchSettings Signature: ```graphql publishProductSearchSettings: PublishProductSearchSettingsPayload! ``` ```graphql mutation publishProductSearchSettings { publishProductSearchSettings { success productSearchSettings } } ``` Sample response: ```json { "data": { "publishProductSearchSettings": { "success": true, "productSearchSettings": { "fields": {}, "lastPublished": {}, "algorithmVersion": {} } } } } ``` ### publishSearchSettings Signature: ```graphql publishSearchSettings: PublishSearchSettingsPayload! ``` ```graphql mutation publishSearchSettings { publishSearchSettings { success productSearchSettings } } ``` Sample response: ```json { "data": { "publishSearchSettings": { "success": true, "productSearchSettings": { "fields": {}, "lastPublished": {}, "algorithmVersion": {} } } } } ``` ### pushReviews Create or update product reviews. If the review already exist it will be replaced. Maximum of 250 reviews can be pushed at the same time. Arguments: - input: PushReviewsInput! (required) - Specifies all the product reviews to create or update Signature: ```graphql pushReviews(input: PushReviewsInput!): PushReviewsPayload ``` ```graphql mutation pushReviews($input: PushReviewsInput!) { pushReviews(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "syndication": null, "reviews": null } } ``` Sample response: ```json { "data": { "pushReviews": { "success": true, "userErrors": { "__typename": "EmptyReviewsError" } } } } ``` ### pushToVisualizationDataset Arguments: - input: PushToVisualizationDatasetInput! (required) - Input sent to the pushToVisualizationDataset mutation Signature: ```graphql pushToVisualizationDataset(input: PushToVisualizationDatasetInput!): PushToVisualizationDatasetPayload! ``` ```graphql mutation pushToVisualizationDataset($input: PushToVisualizationDatasetInput!) { pushToVisualizationDataset(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "datasetId": "123", "revisionId": 1, "productId": "example", "fields": null } } ``` Sample response: ```json { "data": { "pushToVisualizationDataset": { "success": true, "userErrors": { "__typename": "PushToVisualizationDatasetInvalidDatasetError" } } } } ``` ### registerDistributorAccount Register a new distributor account Arguments: - input: RegisterDistributorAccountInput! (required) Signature: ```graphql registerDistributorAccount(input: RegisterDistributorAccountInput!): RegisterDistributorAccountPayload! ``` ```graphql mutation registerDistributorAccount($input: RegisterDistributorAccountInput!) { registerDistributorAccount(input: $input) { id userErrors } } ``` Variables: ```json { "input": { "accountId": "example", "userId": "example", "distributorDetails": null, "accountDetails": null } } ``` Sample response: ```json { "data": { "registerDistributorAccount": { "id": "example", "userErrors": { "__typename": "DuplicateAccountError" } } } } ``` ### releaseInvoiceBalance Release an invoice balance Arguments: - input: ReleaseInvoiceBalanceInput! (required) Signature: ```graphql releaseInvoiceBalance(input: ReleaseInvoiceBalanceInput!): ReleaseInvoiceBalancePayload! ``` ```graphql mutation releaseInvoiceBalance($input: ReleaseInvoiceBalanceInput!) { releaseInvoiceBalance(input: $input) { operationStatus userErrors } } ``` Variables: ```json { "input": { "invoiceId": "123" } } ``` Sample response: ```json { "data": { "releaseInvoiceBalance": { "operationStatus": {}, "userErrors": { "__typename": "InvoiceHasInvalidStatusError" } } } } ``` ### removeCompanyMapping Create or update a company mapping only for user interface Arguments: - input: RemoveCompanyMappingInput! (required) Signature: ```graphql removeCompanyMapping(input: RemoveCompanyMappingInput!): PsaCompanyMappingsPayload! ``` ```graphql mutation removeCompanyMapping($input: RemoveCompanyMappingInput!) { removeCompanyMapping(input: $input) { companyMapping userErrors } } ``` Variables: ```json { "input": { "mor": null, "accountId": "123", "psaCompanies": null } } ``` Sample response: ```json { "data": { "removeCompanyMapping": { "companyMapping": { "id": "123", "accountId": "123", "mor": {}, "tenant": "example", "connectorType": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### removeDiscountFromCart Removes a discount code from the cart Arguments: - input: RemoveDiscountCodeInput! (required) Signature: ```graphql removeDiscountFromCart(input: RemoveDiscountCodeInput!): RemoveDiscountCodePayload ``` ```graphql mutation removeDiscountFromCart($input: RemoveDiscountCodeInput!) { removeDiscountFromCart(input: $input) { cart } } ``` Variables: ```json { "input": { "cartId": "123", "discountCode": "example" } } ``` Sample response: ```json { "data": { "removeDiscountFromCart": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} } } } } ``` ### removeFileFromProductEdition Remove a file from a product edition Arguments: - input: RemoveFileFromProductEditionInput! (required) Signature: ```graphql removeFileFromProductEdition(input: RemoveFileFromProductEditionInput!): RemoveFileFromProductEditionPayload! ``` ```graphql mutation removeFileFromProductEdition($input: RemoveFileFromProductEditionInput!) { removeFileFromProductEdition(input: $input) { productEdition } } ``` Variables: ```json { "input": { "productId": "123", "editionId": "123", "productEditionFileId": "123" } } ``` Sample response: ```json { "data": { "removeFileFromProductEdition": { "productEdition": { "id": "123", "version": "example", "code": "example", "product": {}, "inventory": {} } } } } ``` ### removeItemsFromCart Removes specified items from the cart Arguments: - input: RemoveItemsInput! (required) Signature: ```graphql removeItemsFromCart(input: RemoveItemsInput!): RemoveItemsPayload ``` ```graphql mutation removeItemsFromCart($input: RemoveItemsInput!) { removeItemsFromCart(input: $input) { cart } } ``` Variables: ```json { "input": { "cartId": "123", "itemIds": "123" } } ``` Sample response: ```json { "data": { "removeItemsFromCart": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} } } } } ``` ### removePrivacyPolicyLink Remove a privacy policy link for a product Arguments: - input: RemovePrivacyPolicyLinkInput! (required) Signature: ```graphql removePrivacyPolicyLink(input: RemovePrivacyPolicyLinkInput!): RemovePrivacyPolicyLinkPayload! ``` ```graphql mutation removePrivacyPolicyLink($input: RemovePrivacyPolicyLinkInput!) { removePrivacyPolicyLink(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "locale": null } } ``` Sample response: ```json { "data": { "removePrivacyPolicyLink": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "LocalizedFieldLocaleError" } } } } ``` ### removeProductVariantOption Remove a product variant option from a product Arguments: - input: RemoveProductVariantOptionInput! (required) Signature: ```graphql removeProductVariantOption(input: RemoveProductVariantOptionInput!): RemoveProductVariantOptionPayload! ``` ```graphql mutation removeProductVariantOption($input: RemoveProductVariantOptionInput!) { removeProductVariantOption(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "code": "example" } } ``` Sample response: ```json { "data": { "removeProductVariantOption": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### removeProductVariantOptionValue Delete/remove a variant option's value Arguments: - input: RemoveProductVariantOptionValueInput! (required) Signature: ```graphql removeProductVariantOptionValue(input: RemoveProductVariantOptionValueInput!): RemoveProductVariantOptionValuePayload! ``` ```graphql mutation removeProductVariantOptionValue($input: RemoveProductVariantOptionValueInput!) { removeProductVariantOptionValue(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "optionCode": "example", "valueCode": "example" } } ``` Sample response: ```json { "data": { "removeProductVariantOptionValue": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### removePsaProductMapping remove a product mapping Arguments: - input: RemovePsaProductMappingInput! (required) Signature: ```graphql removePsaProductMapping(input: RemovePsaProductMappingInput!): RemovePsaProductMappingPayload! ``` ```graphql mutation removePsaProductMapping($input: RemovePsaProductMappingInput!) { removePsaProductMapping(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "removePsaProductMapping": { "success": true, "userErrors": { "message": "example", "path": "example" } } } } ``` ### removeTermsAndConditionsLink Remove a terms and conditions link for a product Arguments: - input: RemoveTermsAndConditionsLinkInput! (required) Signature: ```graphql removeTermsAndConditionsLink(input: RemoveTermsAndConditionsLinkInput!): RemoveTermsAndConditionsLinkPayload! ``` ```graphql mutation removeTermsAndConditionsLink($input: RemoveTermsAndConditionsLinkInput!) { removeTermsAndConditionsLink(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "locale": null } } ``` Sample response: ```json { "data": { "removeTermsAndConditionsLink": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "LocalizedFieldLocaleError" } } } } ``` ### resellerRelationship Arguments: - domain: String! (required) - companyUuid: String! (required) Signature: ```graphql resellerRelationship(domain: String!, companyUuid: String!): RelationshipResponse! ``` ```graphql mutation resellerRelationship($domain: String!, $companyUuid: String!) { resellerRelationship(domain: $domain, companyUuid: $companyUuid) { id requestStatus lastModified createdAt companyUuid } } ``` Variables: ```json { "domain": "example", "companyUuid": "example" } ``` Sample response: ```json { "data": { "resellerRelationship": { "id": {}, "lastModified": "example", "createdAt": "example", "companyUuid": "example", "customerTenantId": "example" } } } ``` ### resetProductSearchSettings Signature: ```graphql resetProductSearchSettings: ResetProductSearchSettingsPayload! ``` ```graphql mutation resetProductSearchSettings { resetProductSearchSettings { success productSearchSettings } } ``` Sample response: ```json { "data": { "resetProductSearchSettings": { "success": true, "productSearchSettings": { "fields": {}, "lastPublished": {}, "algorithmVersion": {} } } } } ``` ### resetProgramQuestionnaire Arguments: - input: ResetProgramQuestionnaireInput! (required) Signature: ```graphql resetProgramQuestionnaire(input: ResetProgramQuestionnaireInput!): ResetProgramQuestionnairePayload! ``` ```graphql mutation resetProgramQuestionnaire($input: ResetProgramQuestionnaireInput!) { resetProgramQuestionnaire(input: $input) { program } } ``` Variables: ```json { "input": { "type": null } } ``` Sample response: ```json { "data": { "resetProgramQuestionnaire": { "program": { "type": {}, "status": "example", "description": "example", "settings": {}, "questionnaire": {} } } } } ``` ### retryFunctionProvisioning Retry the provisioning of an existing Function. Useful in case an error happened with the first provisioning attempt. Arguments: - input: RetryFunctionProvisioningInput! (required) Signature: ```graphql retryFunctionProvisioning(input: RetryFunctionProvisioningInput!): RetryFunctionProvisioningPayload! ``` ```graphql mutation retryFunctionProvisioning($input: RetryFunctionProvisioningInput!) { retryFunctionProvisioning(input: $input) { function userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "retryFunctionProvisioning": { "function": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "name": "example" }, "userErrors": { "__typename": "InvalidFunctionProvisioningStatusError" } } } } ``` ### retryInvoiceImports Retry imports for failed invoices Arguments: - input: RetryInvoiceImportsInput! (required) Signature: ```graphql retryInvoiceImports(input: RetryInvoiceImportsInput!): RetryInvoiceImportsResponse! ``` ```graphql mutation retryInvoiceImports($input: RetryInvoiceImportsInput!) { retryInvoiceImports(input: $input) { message } } ``` Variables: ```json { "input": { "invoiceNumbers": 1 } } ``` Sample response: ```json { "data": { "retryInvoiceImports": { "message": "example" } } } ``` ### retryWebhook Retry a failed webhook Arguments: - input: RetryWebhookInput! (required) Signature: ```graphql retryWebhook(input: RetryWebhookInput!): RetryWebhookPayload! ``` ```graphql mutation retryWebhook($input: RetryWebhookInput!) { retryWebhook(input: $input) { webhook userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "retryWebhook": { "webhook": { "id": "123", "status": {}, "resourceType": "example", "resourcePayload": "example", "resourceAction": "example" }, "userErrors": { "__typename": "NoWebhookConfigurationPresentError" } } } } ``` ### scheduledAdobeOrder Arguments: - scheduledAdobeOrderRequest: ScheduledAdobeOrderRequest (optional) Signature: ```graphql scheduledAdobeOrder(scheduledAdobeOrderRequest: ScheduledAdobeOrderRequest): ScheduledAdobeOrderResponse ``` ```graphql mutation scheduledAdobeOrder($scheduledAdobeOrderRequest: ScheduledAdobeOrderRequest) { scheduledAdobeOrder(scheduledAdobeOrderRequest: $scheduledAdobeOrderRequest) { statusCode message scheduledOrderId } } ``` Variables: ```json { "scheduledAdobeOrderRequest": { "applicationUuid": "example", "companyUuid": "example", "customerId": "example", "offerId": "example", "currentQuantity": 1, "changedQuantity": 1, "operationType": null } } ``` Sample response: ```json { "data": { "scheduledAdobeOrder": { "statusCode": "example", "message": "example", "scheduledOrderId": "example" } } } ``` ### sendAttestationReminder Arguments: - companyUuid: String! (required) Signature: ```graphql sendAttestationReminder(companyUuid: String!): AttestationReminderResponse! ``` ```graphql mutation sendAttestationReminder($companyUuid: String!) { sendAttestationReminder(companyUuid: $companyUuid) { success message } } ``` Variables: ```json { "companyUuid": "example" } ``` Sample response: ```json { "data": { "sendAttestationReminder": { "success": true, "message": "example" } } } ``` ### setRenewalSettingResponse Definition for SetGoogleRenewalResponse Arguments: - googleRenewalRequest: GoogleRenewalRequest (optional) Signature: ```graphql setRenewalSettingResponse(googleRenewalRequest: GoogleRenewalRequest): GoogleRenewalResponse ``` ```graphql mutation setRenewalSettingResponse($googleRenewalRequest: GoogleRenewalRequest) { setRenewalSettingResponse(googleRenewalRequest: $googleRenewalRequest) { code message success } } ``` Variables: ```json { "googleRenewalRequest": { "renewalOption": "example", "editionCode": "example" } } ``` Sample response: ```json { "data": { "setRenewalSettingResponse": { "code": "example", "message": "example", "success": true } } } ``` ### triggerBalanceOperationEvent Triggers the publication of a balance event for a given Balance Operation Arguments: - input: TriggerBalanceOperationEventInput! (required) Signature: ```graphql triggerBalanceOperationEvent(input: TriggerBalanceOperationEventInput!): TriggerBalanceOperationEventPayload! ``` ```graphql mutation triggerBalanceOperationEvent($input: TriggerBalanceOperationEventInput!) { triggerBalanceOperationEvent(input: $input) { status requestId } } ``` Variables: ```json { "input": { "balanceOperationIds": "123" } } ``` Sample response: ```json { "data": { "triggerBalanceOperationEvent": { "requestId": "123", "status": "example" } } } ``` ### triggerCommissionCancelProcess Triggers the cancel flow for a given cycle, batch or collection of events. Arguments: - input: TriggerCommissionCancelProcessInput! (required) Signature: ```graphql triggerCommissionCancelProcess(input: TriggerCommissionCancelProcessInput!): TriggerCommissionCancelProcessPayload! ``` ```graphql mutation triggerCommissionCancelProcess($input: TriggerCommissionCancelProcessInput!) { triggerCommissionCancelProcess(input: $input) { isSuccess userErrors } } ``` Variables: ```json { "input": { "cycleYear": 1, "cycleMonth": 1 } } ``` Sample response: ```json { "data": { "triggerCommissionCancelProcess": { "isSuccess": true, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### triggerCommissionImportProcess Triggers the import flow for a given cycle, batch or collection of events. Arguments: - input: TriggerCommissionImportProcessInput! (required) Signature: ```graphql triggerCommissionImportProcess(input: TriggerCommissionImportProcessInput!): TriggerCommissionImportProcessPayload! ``` ```graphql mutation triggerCommissionImportProcess($input: TriggerCommissionImportProcessInput!) { triggerCommissionImportProcess(input: $input) { isSuccess userErrors } } ``` Variables: ```json { "input": { "cycleYear": 1, "cycleMonth": 1 } } ``` Sample response: ```json { "data": { "triggerCommissionImportProcess": { "isSuccess": true, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### triggerCommissionRetryProcess Triggers the retry flow for a given cycle, batch or collection of events. Arguments: - input: TriggerCommissionImportProcessInput! (required) Signature: ```graphql triggerCommissionRetryProcess(input: TriggerCommissionImportProcessInput!): TriggerCommissionRetryProcessPayload! ``` ```graphql mutation triggerCommissionRetryProcess($input: TriggerCommissionImportProcessInput!) { triggerCommissionRetryProcess(input: $input) { isSuccess userErrors } } ``` Variables: ```json { "input": { "cycleYear": 1, "cycleMonth": 1 } } ``` Sample response: ```json { "data": { "triggerCommissionRetryProcess": { "isSuccess": true, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### triggerCreateAdhocCreditMemoProcess Arguments: - input: TriggerCreateAdhocCreditMemoProcessInput! (required) Signature: ```graphql triggerCreateAdhocCreditMemoProcess(input: TriggerCreateAdhocCreditMemoProcessInput!): TriggerCreateAdhocCreditMemoProcessPayload! ``` ```graphql mutation triggerCreateAdhocCreditMemoProcess($input: TriggerCreateAdhocCreditMemoProcessInput!) { triggerCreateAdhocCreditMemoProcess(input: $input) { process userErrors } } ``` Variables: ```json { "input": { "idempotencyKey": "123", "currency": "example", "customer": null, "merchantOfRecord": null, "lines": null } } ``` Sample response: ```json { "data": { "triggerCreateAdhocCreditMemoProcess": { "process": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "idempotencyKey": "123" }, "userErrors": { "__typename": "InvalidCreateAdhocCreditMemoInputError" } } } } ``` ### triggerCreditMemoRetryProcess Arguments: - input: TriggerCreditMemoRetryProcessInput! (required) Signature: ```graphql triggerCreditMemoRetryProcess(input: TriggerCreditMemoRetryProcessInput!): TriggerCreditMemoRetryProcessPayload! ``` ```graphql mutation triggerCreditMemoRetryProcess($input: TriggerCreditMemoRetryProcessInput!) { triggerCreditMemoRetryProcess(input: $input) { status requestId userErrors } } ``` Variables: ```json { "input": { "creditMemoUUIDs": "example" } } ``` Sample response: ```json { "data": { "triggerCreditMemoRetryProcess": { "requestId": "123", "status": "example", "userErrors": "example" } } } ``` ### triggerDistributorsProductsImports Import distributor products to marketplace Arguments: - input: TriggerDistributorsProductsImportsInput! (required) Signature: ```graphql triggerDistributorsProductsImports(input: TriggerDistributorsProductsImportsInput!): TriggerDistributorsProductsImportsPayload ``` ```graphql mutation triggerDistributorsProductsImports($input: TriggerDistributorsProductsImportsInput!) { triggerDistributorsProductsImports(input: $input) { productImportIds userErrors } } ``` Variables: ```json { "input": { "distributorProductIds": "123", "accountId": "example" } } ``` Sample response: ```json { "data": { "triggerDistributorsProductsImports": { "productImportIds": "123", "userErrors": { "__typename": "InvalidDistributorProductIdsError" } } } } ``` ### triggerMigrateMarketplaceProcess Triggers the process to migrate invoices from the specified marketplace Arguments: - input: TriggerMigrateMarketplaceProcessInput! (required) Signature: ```graphql triggerMigrateMarketplaceProcess(input: TriggerMigrateMarketplaceProcessInput!): TriggerMigrateMarketplaceProcessPayload! ``` ```graphql mutation triggerMigrateMarketplaceProcess($input: TriggerMigrateMarketplaceProcessInput!) { triggerMigrateMarketplaceProcess(input: $input) { status requestId } } ``` Variables: ```json { "input": { "tenant": "example" } } ``` Sample response: ```json { "data": { "triggerMigrateMarketplaceProcess": { "requestId": "123", "status": "example" } } } ``` ### triggerProductDeletionProcess Trigger the product deletion process for one or more products Arguments: - input: TriggerProductDeletionProcessInput! (required) Signature: ```graphql triggerProductDeletionProcess(input: TriggerProductDeletionProcessInput!): TriggerProductDeletionProcessPayload! ``` ```graphql mutation triggerProductDeletionProcess($input: TriggerProductDeletionProcessInput!) { triggerProductDeletionProcess(input: $input) { productDeletionProcesses } } ``` Variables: ```json { "input": { "productIds": "123" } } ``` Sample response: ```json { "data": { "triggerProductDeletionProcess": { "productDeletionProcesses": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } } ``` ### triggerProductDownloadProcess Arguments: - input: TriggerProductDownloadProcessInput (optional) Signature: ```graphql triggerProductDownloadProcess(input: TriggerProductDownloadProcessInput): TriggerProductDownloadProcessPayload! ``` ```graphql mutation triggerProductDownloadProcess($input: TriggerProductDownloadProcessInput) { triggerProductDownloadProcess(input: $input) { process } } ``` Variables: ```json { "input": { "entityType": null } } ``` Sample response: ```json { "data": { "triggerProductDownloadProcess": { "process": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "totalProducts": 1 } } } } ``` ### triggerProductIntegrationPingTest Trigger ping tests for a product integration. Arguments: - input: TriggerProductIntegrationPingTestInput! (required) - Input to trigger ping tests for a product integration. Signature: ```graphql triggerProductIntegrationPingTest(input: TriggerProductIntegrationPingTestInput!): TriggerProductIntegrationPingTestPayload! ``` ```graphql mutation triggerProductIntegrationPingTest($input: TriggerProductIntegrationPingTestInput!) { triggerProductIntegrationPingTest(input: $input) { productIntegration userErrors } } ``` Variables: ```json { "input": { "id": "123", "version": "example" } } ``` Sample response: ```json { "data": { "triggerProductIntegrationPingTest": { "productIntegration": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### triggerProductPublicationProcess Trigger the product publication process for one or more products Arguments: - input: TriggerProductPublicationProcessInput! (required) Signature: ```graphql triggerProductPublicationProcess(input: TriggerProductPublicationProcessInput!): TriggerProductPublicationProcessPayload! ``` ```graphql mutation triggerProductPublicationProcess($input: TriggerProductPublicationProcessInput!) { triggerProductPublicationProcess(input: $input) { productPublicationProcesses } } ``` Variables: ```json { "input": { "productIds": "123" } } ``` Sample response: ```json { "data": { "triggerProductPublicationProcess": { "productPublicationProcesses": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } } ``` ### triggerProductUnpublicationProcess Trigger the product unpublication process for one or more products Arguments: - input: TriggerProductUnpublicationProcessInput! (required) Signature: ```graphql triggerProductUnpublicationProcess(input: TriggerProductUnpublicationProcessInput!): TriggerProductUnpublicationProcessPayload! ``` ```graphql mutation triggerProductUnpublicationProcess($input: TriggerProductUnpublicationProcessInput!) { triggerProductUnpublicationProcess(input: $input) { productUnpublicationProcesses } } ``` Variables: ```json { "input": { "productIds": "123" } } ``` Sample response: ```json { "data": { "triggerProductUnpublicationProcess": { "productUnpublicationProcesses": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "productId": "example" } } } } ``` ### triggerProductVariantsCreation Trigger the creation of the variants for one product Arguments: - input: TriggerProductVariantCreationInput! (required) Signature: ```graphql triggerProductVariantsCreation(input: TriggerProductVariantCreationInput!): TriggerProductVariantsCreationPayload! ``` ```graphql mutation triggerProductVariantsCreation($input: TriggerProductVariantCreationInput!) { triggerProductVariantsCreation(input: $input) { process userErrors } } ``` Variables: ```json { "input": { "productId": "123" } } ``` Sample response: ```json { "data": { "triggerProductVariantsCreation": { "process": { "id": "123", "triggeredOn": {}, "startedOn": {}, "completedOn": {}, "product": {} }, "userErrors": { "__typename": "InvalidVariantProductTypeError" } } } } ``` ### triggerRefreshCycleSummaryDataProcess Triggers a cycle summary data refresh flow for a given partner and year, or cycle. Arguments: - input: TriggerCycleSummaryRefreshProcessInput! (required) Signature: ```graphql triggerRefreshCycleSummaryDataProcess(input: TriggerCycleSummaryRefreshProcessInput!): TriggerCycleSummaryRefreshProcessPayload! ``` ```graphql mutation triggerRefreshCycleSummaryDataProcess($input: TriggerCycleSummaryRefreshProcessInput!) { triggerRefreshCycleSummaryDataProcess(input: $input) { isSuccess isRunning userErrors } } ``` Variables: ```json { "input": { "partner": "example", "cycleYear": 1 } } ``` Sample response: ```json { "data": { "triggerRefreshCycleSummaryDataProcess": { "isSuccess": true, "isRunning": true, "userErrors": { "__typename": "HighGrowthOfferQuantityError" } } } } ``` ### unlistProductFromStorefront Removes a product from the production catalog of a marketplace. Arguments: - input: UnlistProductFromStorefrontInput! (required) Signature: ```graphql unlistProductFromStorefront(input: UnlistProductFromStorefrontInput!): UnlistProductFromStorefrontPayload! ``` ```graphql mutation unlistProductFromStorefront($input: UnlistProductFromStorefrontInput!) { unlistProductFromStorefront(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "productId": "123", "productUuid": "123" } } ``` Sample response: ```json { "data": { "unlistProductFromStorefront": { "success": true, "userErrors": { "__typename": "InvalidIdError" } } } } ``` ### updateAccount Update a marketplace account (company) Arguments: - input: UpdateAccountInput! (required) - Specifies update attributes for a marketplace account (company) Signature: ```graphql updateAccount(input: UpdateAccountInput!): UpdateAccountPayload! ``` ```graphql mutation updateAccount($input: UpdateAccountInput!) { updateAccount(input: $input) { account userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateAccount": { "account": { "id": "123", "creditMemos": {}, "name": "example", "status": {}, "accessTypes": {} }, "userErrors": { "__typename": "AccountCannotBeCreatedWithBothReferralAndResellerError" } } } } ``` ### updateAttestationStatus Arguments: - companyUuid: String! (required) - attestationId: String! (required) - status: attestationStatus! (required) - agreementDate: String (optional) Signature: ```graphql updateAttestationStatus(companyUuid: String!, attestationId: String!, status: attestationStatus!, agreementDate: String): AttestationResponse! ``` ```graphql mutation updateAttestationStatus($companyUuid: String!, $attestationId: String!, $status: attestationStatus!, $agreementDate: String) { updateAttestationStatus(companyUuid: $companyUuid, attestationId: $attestationId, status: $status, agreementDate: $agreementDate) { signatoryFirstName signatoryLastName status attestationId companyUuid } } ``` Variables: ```json { "companyUuid": "example", "attestationId": "example", "status": "value", "agreementDate": "example" } ``` Sample response: ```json { "data": { "updateAttestationStatus": { "attestationId": "example", "status": {}, "companyUuid": "example", "partner": "example", "signatoryFirstName": "example" } } } ``` ### updateBillingRelationship Update billing relationship Arguments: - input: UpdateBillingRelationshipInput! (required) Signature: ```graphql updateBillingRelationship(input: UpdateBillingRelationshipInput!): UpdateBillingRelationshipPayload ``` ```graphql mutation updateBillingRelationship($input: UpdateBillingRelationshipInput!) { updateBillingRelationship(input: $input) { billingRelationship validationErrors } } ``` Variables: ```json { "input": { "id": "123", "locale": null, "label": "example", "description": "example", "default": true, "relationships": null } } ``` Sample response: ```json { "data": { "updateBillingRelationship": { "billingRelationship": { "id": "123", "tenant": "example", "relationships": {}, "status": {}, "label": "example" }, "validationErrors": { "code": "example", "message": "example", "timestamp": {} } } } } ``` ### updateCartCustomAttributes Updates custom attributes of an existing cart Arguments: - input: UpdateCartCustomAttributesInput! (required) Signature: ```graphql updateCartCustomAttributes(input: UpdateCartCustomAttributesInput!): UpdateCartCustomAttributesPayload! ``` ```graphql mutation updateCartCustomAttributes($input: UpdateCartCustomAttributesInput!) { updateCartCustomAttributes(input: $input) { cart } } ``` Variables: ```json { "input": { "cartId": "123" } } ``` Sample response: ```json { "data": { "updateCartCustomAttributes": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} } } } } ``` ### updateCartItems Updates items in an existing cart Arguments: - input: UpdateCartItemsInput! (required) Signature: ```graphql updateCartItems(input: UpdateCartItemsInput!): UpdateCartItemsPayload! ``` ```graphql mutation updateCartItems($input: UpdateCartItemsInput!) { updateCartItems(input: $input) { cart userErrors } } ``` Variables: ```json { "input": { "cartId": "123", "items": null } } ``` Sample response: ```json { "data": { "updateCartItems": { "cart": { "id": "123", "buyerUser": {}, "buyerAccount": {}, "currency": {}, "status": {} }, "userErrors": { "__typename": "UnitQuantityMinError" } } } } ``` ### updateCompanyCatalogCuration TODO: document me Arguments: - input: UpdateCompanyCatalogCurationInput! (required) Signature: ```graphql updateCompanyCatalogCuration(input: UpdateCompanyCatalogCurationInput!): UpdateCompanyCatalogCurationPayload! ``` ```graphql mutation updateCompanyCatalogCuration($input: UpdateCompanyCatalogCurationInput!) { updateCompanyCatalogCuration(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "companyId": "123", "productIds": "123" } } ``` Sample response: ```json { "data": { "updateCompanyCatalogCuration": { "success": true, "userErrors": { "__typename": "InvalidProductIdError" } } } } ``` ### updateCustomer Arguments: - updateCustomerRequest: UpdateCustomerRequest! (required) Signature: ```graphql updateCustomer(updateCustomerRequest: UpdateCustomerRequest!): AdobeCustomerResponse ``` ```graphql mutation updateCustomer($updateCustomerRequest: UpdateCustomerRequest!) { updateCustomer(updateCustomerRequest: $updateCustomerRequest) { id name customerId type linkedMembershipType } } ``` Variables: ```json { "updateCustomerRequest": { "customerId": "example", "name": "example", "type": "example" } } ``` Sample response: ```json { "data": { "updateCustomer": { "customerId": "example", "id": "example", "name": "example", "type": "example", "linkedMembershipType": "example" } } } ``` ### updateDistributorAccount Update an existing distributor account Arguments: - input: UpdateDistributorAccountInput! (required) Signature: ```graphql updateDistributorAccount(input: UpdateDistributorAccountInput!): UpdateDistributorAccountPayload! ``` ```graphql mutation updateDistributorAccount($input: UpdateDistributorAccountInput!) { updateDistributorAccount(input: $input) { id userErrors } } ``` Variables: ```json { "input": { "id": "example" } } ``` Sample response: ```json { "data": { "updateDistributorAccount": { "id": "example", "userErrors": { "__typename": "InvalidAccountCredentialsError" } } } } ``` ### updateFunction Update an existing function. Arguments: - input: UpdateFunctionInput! (required) Signature: ```graphql updateFunction(input: UpdateFunctionInput!): UpdateFunctionPayload! ``` ```graphql mutation updateFunction($input: UpdateFunctionInput!) { updateFunction(input: $input) { function userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateFunction": { "function": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "name": "example" }, "userErrors": { "__typename": "InvalidFunctionNameError" } } } } ``` ### updateInventory Update an inventory record Arguments: - input: UpdateInventoryInput! (required) Signature: ```graphql updateInventory(input: UpdateInventoryInput!): UpdateInventoryPayload! ``` ```graphql mutation updateInventory($input: UpdateInventoryInput!) { updateInventory(input: $input) { inventory } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateInventory": { "inventory": { "id": "123", "editionCode": "example", "sku": "example", "stock": 1, "vendorId": "123" } } } } ``` ### updateNotificationTemplate Updates the subject line and main content for notifications of a specified type. Arguments: - input: UpdateNotificationTemplateInput! (required) - Input used to update a specific notification template. Signature: ```graphql updateNotificationTemplate(input: UpdateNotificationTemplateInput!): UpdateNotificationTemplatePayload! ``` ```graphql mutation updateNotificationTemplate($input: UpdateNotificationTemplateInput!) { updateNotificationTemplate(input: $input) { success errors } } ``` Variables: ```json { "input": { "method": null, "type": null, "id": "123", "subject": "example", "content": "example" } } ``` Sample response: ```json { "data": { "updateNotificationTemplate": { "success": true, "errors": { "__typename": "UpdateNotificationTemplateInvalidInputError" } } } } ``` ### updateOffPlatformPayment Update off-platform payment Arguments: - input: UpdateOffPlatformPaymentInput! (required) Signature: ```graphql updateOffPlatformPayment(input: UpdateOffPlatformPaymentInput!): UpdateOffPlatformPaymentPayload! ``` ```graphql mutation updateOffPlatformPayment($input: UpdateOffPlatformPaymentInput!) { updateOffPlatformPayment(input: $input) { payment userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateOffPlatformPayment": { "payment": { "id": "123", "paymentNumber": "example", "jbillingPaymentId": "example", "amount": {}, "dateTime": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### updateProduct Update a product Arguments: - input: UpdateProductInput! (required) Signature: ```graphql updateProduct(input: UpdateProductInput!): UpdateProductPayload! ``` ```graphql mutation updateProduct($input: UpdateProductInput!) { updateProduct(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123" } } ``` Sample response: ```json { "data": { "updateProduct": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "UnsupportedSupplierIdError" } } } } ``` ### updateProductDefaultVariant Update a product's default variant Arguments: - input: UpdateProductDefaultVariantInput! (required) Signature: ```graphql updateProductDefaultVariant(input: UpdateProductDefaultVariantInput!): UpdateProductDefaultVariantPayload! ``` ```graphql mutation updateProductDefaultVariant($input: UpdateProductDefaultVariantInput!) { updateProductDefaultVariant(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123" } } ``` Sample response: ```json { "data": { "updateProductDefaultVariant": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "InvalidUnitError" } } } } ``` ### updateProductEdition Update a product edition Arguments: - input: UpdateProductEditionInput! (required) Signature: ```graphql updateProductEdition(input: UpdateProductEditionInput!): UpdateProductEditionPayload! ``` ```graphql mutation updateProductEdition($input: UpdateProductEditionInput!) { updateProductEdition(input: $input) { edition userErrors } } ``` Variables: ```json { "input": { "id": "123", "productId": "123" } } ``` Sample response: ```json { "data": { "updateProductEdition": { "edition": { "id": "123", "version": "example", "code": "example", "product": {}, "inventory": {} }, "userErrors": { "__typename": "StringTooLongError" } } } } ``` ### updateProductIntegration Update an existing product integration. Arguments: - input: UpdateProductIntegrationInput! (required) - Input to update a product integration. Signature: ```graphql updateProductIntegration(input: UpdateProductIntegrationInput!): UpdateProductIntegrationPayload! ``` ```graphql mutation updateProductIntegration($input: UpdateProductIntegrationInput!) { updateProductIntegration(input: $input) { productIntegration userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateProductIntegration": { "productIntegration": { "id": "123", "version": "example", "type": {}, "createdOn": {}, "lastModified": {} }, "userErrors": { "__typename": "ProductIntegrationSuiteRegularConvertError" } } } } ``` ### updateProductIntegrationBookmarkConfiguration Update the Bookmark single sign-on configuration within an existing product integration Arguments: - input: UpdateProductIntegrationBookmarkConfigurationInput! (required) Signature: ```graphql updateProductIntegrationBookmarkConfiguration(input: UpdateProductIntegrationBookmarkConfigurationInput!): UpdateProductIntegrationBookmarkConfigurationPayload ``` ```graphql mutation updateProductIntegrationBookmarkConfiguration($input: UpdateProductIntegrationBookmarkConfigurationInput!) { updateProductIntegrationBookmarkConfiguration(input: $input) { bookmark userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123", "url": "example" } } ``` Sample response: ```json { "data": { "updateProductIntegrationBookmarkConfiguration": { "bookmark": { "url": "example", "setupForm": {} }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### updateProductIntegrationOpenIdConfiguration Update the OpenID 2.0 single sign-on configuration within an existing product integration Arguments: - input: UpdateProductIntegrationOpenIdConfigurationInput! (required) Signature: ```graphql updateProductIntegrationOpenIdConfiguration(input: UpdateProductIntegrationOpenIdConfigurationInput!): UpdateProductIntegrationOpenIdConfigurationPayload ``` ```graphql mutation updateProductIntegrationOpenIdConfiguration($input: UpdateProductIntegrationOpenIdConfigurationInput!) { updateProductIntegrationOpenIdConfiguration(input: $input) { openIdConfiguration userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123" } } ``` Sample response: ```json { "data": { "updateProductIntegrationOpenIdConfiguration": { "openIdConfiguration": { "loginMethod": {}, "loginUrl": "example", "realm": "example", "setupForm": {} }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### updateProductIntegrationOpenIdConnectConfiguration Update the OpenID Connect single sign-on configuration within an existing product integration Arguments: - input: UpdateProductIntegrationOpenIdConnectConfigurationInput! (required) Signature: ```graphql updateProductIntegrationOpenIdConnectConfiguration(input: UpdateProductIntegrationOpenIdConnectConfigurationInput!): UpdateProductIntegrationOpenIdConnectConfigurationPayload ``` ```graphql mutation updateProductIntegrationOpenIdConnectConfiguration($input: UpdateProductIntegrationOpenIdConnectConfigurationInput!) { updateProductIntegrationOpenIdConnectConfiguration(input: $input) { openIdConnectConfiguration userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123" } } ``` Sample response: ```json { "data": { "updateProductIntegrationOpenIdConnectConfiguration": { "openIdConnectConfiguration": { "clientCreationMethod": {}, "grantTypes": {}, "redirectUrls": "example", "initiateLoginUrl": "example", "logoutUrl": "example" }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### updateProductIntegrationSamlConfiguration Update the SAML single sign-on configuration within an existing product integration Arguments: - input: UpdateProductIntegrationSamlConfigurationInput! (required) Signature: ```graphql updateProductIntegrationSamlConfiguration(input: UpdateProductIntegrationSamlConfigurationInput!): UpdateProductIntegrationSamlConfigurationPayload ``` ```graphql mutation updateProductIntegrationSamlConfiguration($input: UpdateProductIntegrationSamlConfigurationInput!) { updateProductIntegrationSamlConfiguration(input: $input) { samlConfiguration userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123" } } ``` Sample response: ```json { "data": { "updateProductIntegrationSamlConfiguration": { "samlConfiguration": { "version": "example", "idpConfigurationCreationMethod": "example", "serviceProviderEntityId": "example", "assertionConsumerServiceUrl": "example", "serviceProviderInitiatedLoginUrl": "example" }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### updateProductIntegrationSingleSignOnConfigurationSetupForm Update the single sign-on setup form configuration within an existing product integration Arguments: - input: UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput! (required) Signature: ```graphql updateProductIntegrationSingleSignOnConfigurationSetupForm(input: UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput!): UpdateProductIntegrationSingleSignOnConfigurationSetupFormPayload ``` ```graphql mutation updateProductIntegrationSingleSignOnConfigurationSetupForm($input: UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput!) { updateProductIntegrationSingleSignOnConfigurationSetupForm(input: $input) { setupForm userErrors } } ``` Variables: ```json { "input": { "integrationConfigurationId": "123" } } ``` Sample response: ```json { "data": { "updateProductIntegrationSingleSignOnConfigurationSetupForm": { "setupForm": { "overview": "example", "instructions": "example", "parameters": {} }, "userErrors": { "__typename": "SingleSignOnConfigurationNotFoundError" } } } } ``` ### updateProductVariantOption Update a product's variant option Arguments: - input: UpdateProductVariantOptionInput! (required) Signature: ```graphql updateProductVariantOption(input: UpdateProductVariantOptionInput!): UpdateProductVariantOptionPayload! ``` ```graphql mutation updateProductVariantOption($input: UpdateProductVariantOptionInput!) { updateProductVariantOption(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "code": "example" } } ``` Sample response: ```json { "data": { "updateProductVariantOption": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "EmptyLocalizedFieldError" } } } } ``` ### updateProductVariantOptionValue Update a product variant option value Arguments: - input: UpdateProductVariantOptionValueInput! (required) Signature: ```graphql updateProductVariantOptionValue(input: UpdateProductVariantOptionValueInput!): UpdateProductVariantOptionValuePayload! ``` ```graphql mutation updateProductVariantOptionValue($input: UpdateProductVariantOptionValueInput!) { updateProductVariantOptionValue(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "optionCode": "example", "valueCode": "example" } } ``` Sample response: ```json { "data": { "updateProductVariantOptionValue": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "InvalidProductOptionDefaultValueError" } } } } ``` ### updateProductVariants Update the product's variant(s) Arguments: - input: UpdateProductVariantsInput! (required) Signature: ```graphql updateProductVariants(input: UpdateProductVariantsInput!): UpdateProductVariantsPayload! ``` ```graphql mutation updateProductVariants($input: UpdateProductVariantsInput!) { updateProductVariants(input: $input) { product userErrors } } ``` Variables: ```json { "input": { "productId": "123", "configuration": null } } ``` Sample response: ```json { "data": { "updateProductVariants": { "product": { "id": "123", "version": "example", "vendor": {}, "type": {}, "name": {} }, "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### updateProductVariantsByIds Update the product's variant(s) by id(s) Arguments: - input: UpdateProductVariantByIdsInput! (required) Signature: ```graphql updateProductVariantsByIds(input: UpdateProductVariantByIdsInput!): UpdateProductVariantsByIdsPayload! ``` ```graphql mutation updateProductVariantsByIds($input: UpdateProductVariantByIdsInput!) { updateProductVariantsByIds(input: $input) { variantIds userErrors } } ``` Variables: ```json { "input": { "productId": "123", "ids": "123" } } ``` Sample response: ```json { "data": { "updateProductVariantsByIds": { "variantIds": "123", "userErrors": { "__typename": "VariantFeatureNotAllowedError" } } } } ``` ### updateProgram Arguments: - input: UpdateProgramInput! (required) Signature: ```graphql updateProgram(input: UpdateProgramInput!): UpdateProgramPayload! ``` ```graphql mutation updateProgram($input: UpdateProgramInput!) { updateProgram(input: $input) { program } } ``` Variables: ```json { "input": { "type": "example" } } ``` Sample response: ```json { "data": { "updateProgram": { "program": { "type": {}, "status": "example", "description": "example", "settings": {}, "questionnaire": {} } } } } ``` ### updateProgramApplicant Arguments: - input: UpdateProgramApplicantInput! (required) Signature: ```graphql updateProgramApplicant(input: UpdateProgramApplicantInput!): UpdateProgramApplicantPayload! ``` ```graphql mutation updateProgramApplicant($input: UpdateProgramApplicantInput!) { updateProgramApplicant(input: $input) { applicant } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateProgramApplicant": { "applicant": { "id": "123", "programType": {}, "answers": {}, "status": {}, "appliedOn": {} } } } } ``` ### updateProgramApplicantStatus Arguments: - input: UpdateProgramApplicantStatusInput! (required) Signature: ```graphql updateProgramApplicantStatus(input: UpdateProgramApplicantStatusInput!): UpdateProgramApplicantStatusPayload! ``` ```graphql mutation updateProgramApplicantStatus($input: UpdateProgramApplicantStatusInput!) { updateProgramApplicantStatus(input: $input) { applicant } } ``` Variables: ```json { "input": { "id": "123", "status": null } } ``` Sample response: ```json { "data": { "updateProgramApplicantStatus": { "applicant": { "id": "123", "programType": {}, "answers": {}, "status": {}, "appliedOn": {} } } } } ``` ### updatePsaConnector Update a psa sync service connector Arguments: - input: UpdatePsaConnectorInput! (required) Signature: ```graphql updatePsaConnector(input: UpdatePsaConnectorInput!): UpdatePsaConnectorPayload! ``` ```graphql mutation updatePsaConnector($input: UpdatePsaConnectorInput!) { updatePsaConnector(input: $input) { connector userErrors } } ``` Variables: ```json { "input": { "id": "123", "name": "example" } } ``` Sample response: ```json { "data": { "updatePsaConnector": { "connector": { "id": "123", "name": "example", "type": {}, "configuration": {}, "credentials": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### updatePsaConnectorConfiguration Update a psa sync service connector Arguments: - input: UpdatePsaConnectorConfigurationInput! (required) Signature: ```graphql updatePsaConnectorConfiguration(input: UpdatePsaConnectorConfigurationInput!): UpdatePsaConnectorConfigurationPayload! ``` ```graphql mutation updatePsaConnectorConfiguration($input: UpdatePsaConnectorConfigurationInput!) { updatePsaConnectorConfiguration(input: $input) { connectorConfiguration userErrors } } ``` Variables: ```json { "input": { "connectorId": "123", "mor": null, "configuration": null } } ``` Sample response: ```json { "data": { "updatePsaConnectorConfiguration": { "connectorConfiguration": { "id": "123", "connectorId": "123", "mor": {}, "configuration": {}, "credentials": {} }, "userErrors": { "message": "example", "path": "example" } } } } ``` ### updateRolesForAccountMembership Update roles for an account (company) membership Arguments: - input: UpdateRolesForAccountMembershipInput! (required) - Specifies the account membership and the roles to be updated Signature: ```graphql updateRolesForAccountMembership(input: UpdateRolesForAccountMembershipInput!): UpdateRolesForAccountMembershipPayload! ``` ```graphql mutation updateRolesForAccountMembership($input: UpdateRolesForAccountMembershipInput!) { updateRolesForAccountMembership(input: $input) { accountMembership userErrors } } ``` Variables: ```json { "input": { "accountId": "123", "userId": "123" } } ``` Sample response: ```json { "data": { "updateRolesForAccountMembership": { "accountMembership": { "user": {}, "account": {}, "feedResources": {}, "creditMemos": {}, "isLastUsed": true }, "userErrors": { "__typename": "AccountMembershipRoleAssignmentFailedError" } } } } ``` ### updateRolesForAccountMemberships Update roles for account (company) memberships Arguments: - input: UpdateRolesForAccountMembershipsInput! (required) - Specifies the account memberships and the roles to be updated Signature: ```graphql updateRolesForAccountMemberships(input: UpdateRolesForAccountMembershipsInput!): UpdateRolesForAccountMembershipsPayload! ``` ```graphql mutation updateRolesForAccountMemberships($input: UpdateRolesForAccountMembershipsInput!) { updateRolesForAccountMemberships(input: $input) { success userErrors } } ``` Variables: ```json { "input": { "accountId": "123" } } ``` Sample response: ```json { "data": { "updateRolesForAccountMemberships": { "success": {}, "userErrors": { "__typename": "AccountMembershipRoleAssignmentFailedError" } } } } ``` ### updateScheduleJobSchedule Update a schedule job schedule Arguments: - input: UpdateScheduleJobScheduleInput! (required) - Attributes to update a schedule job schedule Signature: ```graphql updateScheduleJobSchedule(input: UpdateScheduleJobScheduleInput!): UpdateScheduleJobSchedulePayload! ``` ```graphql mutation updateScheduleJobSchedule($input: UpdateScheduleJobScheduleInput!) { updateScheduleJobSchedule(input: $input) { scheduleJobSchedule userErrors } } ``` Variables: ```json { "input": { "id": "123", "schedule": "example" } } ``` Sample response: ```json { "data": { "updateScheduleJobSchedule": { "scheduleJobSchedule": { "id": "123", "scheduleJob": {}, "scheduleName": "example", "scheduleStatus": "example", "scheduleType": "example" }, "userErrors": { "__typename": "BackoffLimitValueError" } } } } ``` ### updateUsageReaderConfiguration Update a usage reader Arguments: - input: UpdateUsageReaderConfigurationInput! (required) - Attributes to update a usage reader Signature: ```graphql updateUsageReaderConfiguration(input: UpdateUsageReaderConfigurationInput!): UpdateUsageReaderConfigurationPayload! ``` ```graphql mutation updateUsageReaderConfiguration($input: UpdateUsageReaderConfigurationInput!) { updateUsageReaderConfiguration(input: $input) { reader userErrors } } ``` Variables: ```json { "input": { "id": "123", "updatedBy": "example" } } ``` Sample response: ```json { "data": { "updateUsageReaderConfiguration": { "reader": { "id": "123", "name": "example", "inputType": {}, "productId": "example", "product": {} }, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### updateUsageReaderRatingConfiguration Update usage reader rating configuration Arguments: - input: UpdateUsageReaderRatingConfigurationInput! (required) - Input to update usage reader rating configuration Signature: ```graphql updateUsageReaderRatingConfiguration(input: UpdateUsageReaderRatingConfigurationInput!): UpdateUsageReaderRatingConfigurationPayload! ``` ```graphql mutation updateUsageReaderRatingConfiguration($input: UpdateUsageReaderRatingConfigurationInput!) { updateUsageReaderRatingConfiguration(input: $input) { id rating userErrors } } ``` Variables: ```json { "input": { "readerId": "example", "exchangeRateSource": null, "updatedBy": "example" } } ``` Sample response: ```json { "data": { "updateUsageReaderRatingConfiguration": { "id": "example", "rating": { "exchangeRateSource": "example", "pricingProperties": "example" }, "userErrors": { "__typename": "UsageReaderNotFoundError" } } } } ``` ### updateUser Updates a marketplace user Arguments: - input: UpdateUserInput! (required) - Input parameters for update marketplace user information Signature: ```graphql updateUser(input: UpdateUserInput!): UpdateUserPayload! ``` ```graphql mutation updateUser($input: UpdateUserInput!) { updateUser(input: $input) { user userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateUser": { "user": { "id": "123", "createdOn": {}, "email": "example", "externalId": "example", "firstName": "example" }, "userErrors": { "__typename": "UserInvalidFieldValueError" } } } } ``` ### updateVisualizationDataset Arguments: - input: UpdateVisualizationDatasetInput! (required) - Input sent to the updateVisualizationDataset mutation Signature: ```graphql updateVisualizationDataset(input: UpdateVisualizationDatasetInput!): UpdateVisualizationDatasetPayload! ``` ```graphql mutation updateVisualizationDataset($input: UpdateVisualizationDatasetInput!) { updateVisualizationDataset(input: $input) { dataset userErrors } } ``` Variables: ```json { "input": { "name": "example", "productId": "123", "datasetId": "123", "datasetSchema": null } } ``` Sample response: ```json { "data": { "updateVisualizationDataset": { "dataset": { "id": "123", "revisionId": 1, "revision": {}, "productId": "123", "name": "example" }, "userErrors": { "__typename": "UpdateVisualizationDatasetError" } } } } ``` ### updateVisualizationMetric Arguments: - input: UpdateVisualizationMetricInput! (required) - Input sent to the updateVisualizationMetric mutation Signature: ```graphql updateVisualizationMetric(input: UpdateVisualizationMetricInput!): UpdateVisualizationMetricPayload! ``` ```graphql mutation updateVisualizationMetric($input: UpdateVisualizationMetricInput!) { updateVisualizationMetric(input: $input) { metric userErrors } } ``` Variables: ```json { "input": { "metricId": "123", "name": "example", "productId": "123", "datasetId": "123", "revisionId": 1, "query": "example" } } ``` Sample response: ```json { "data": { "updateVisualizationMetric": { "metric": { "name": "example", "id": "123", "productId": "123", "datasetId": "123", "revisionId": 1 }, "userErrors": { "__typename": "VisualizationMetricInvalidQueryError" } } } } ``` ### updateWebhookConfiguration Update a webhook configuration Arguments: - input: UpdateWebhookConfigurationInput! (required) Signature: ```graphql updateWebhookConfiguration(input: UpdateWebhookConfigurationInput!): UpdateWebhookConfigurationPayload! ``` ```graphql mutation updateWebhookConfiguration($input: UpdateWebhookConfigurationInput!) { updateWebhookConfiguration(input: $input) { webhookConfiguration userErrors } } ``` Variables: ```json { "input": { "id": "123" } } ``` Sample response: ```json { "data": { "updateWebhookConfiguration": { "webhookConfiguration": { "id": "123", "tenant": "example", "createdOn": {}, "lastModifiedOn": {}, "scope": {} }, "userErrors": { "__typename": "DuplicateWebhookConfigurationError" } } } } ``` ### validateCart Validates cart items through the validation engine Arguments: - input: CartValidationInput! (required) Signature: ```graphql validateCart(input: CartValidationInput!): CartValidationPayload ``` ```graphql mutation validateCart($input: CartValidationInput!) { validateCart(input: $input) { cartValidation } } ``` Variables: ```json { "input": { "cartId": "123", "level": null } } ``` Sample response: ```json { "data": { "validateCart": { "cartValidation": { "id": "123", "blockingErrors": {}, "createdOn": {}, "pendingValidations": "example", "warnings": {} } } } } ``` ### validateProgramApplicant Arguments: - input: ValidateProgramApplicantInput! (required) Signature: ```graphql validateProgramApplicant(input: ValidateProgramApplicantInput!): ValidateProgramApplicantPayload! ``` ```graphql mutation validateProgramApplicant($input: ValidateProgramApplicantInput!) { validateProgramApplicant(input: $input) { applicant } } ``` Variables: ```json { "input": { "id": "123", "token": "example" } } ``` Sample response: ```json { "data": { "validateProgramApplicant": { "applicant": { "id": "123", "programType": {}, "answers": {}, "status": {}, "appliedOn": {} } } } } ``` ### voidInvoice Void an invoice Arguments: - input: VoidInvoiceInput! (required) Signature: ```graphql voidInvoice(input: VoidInvoiceInput!): VoidInvoicePayload! ``` ```graphql mutation voidInvoice($input: VoidInvoiceInput!) { voidInvoice(input: $input) { operationStatus invoice creditMemos userErrors } } ``` Variables: ```json { "input": { "invoiceId": "123" } } ``` Sample response: ```json { "data": { "voidInvoice": { "invoice": { "id": "123", "locale": {}, "localized": true, "displayTaxBreakdown": true, "invoiceNumber": "example" }, "creditMemos": { "id": "123", "amountAvailable": {}, "amountUsed": {}, "creditMemoAppliedDate": {}, "creditMemoCreationDate": {} }, "operationStatus": {}, "userErrors": { "__typename": "InvoiceHasNoBalanceError" } } } } ```