BETA TEST

This site documentation is in beta, and may not be up to date. Use GraphDoc or GraphQL Voyager for dynamically updated docs.

API Endpoints
https://www.bestfriendbazaar.com/graphql

Queries

adminRoles

Description

Returns a collection of existing admin roles. Only accessible to operator admin users.

Response

Returns an AdminRolesConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query adminRoles(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  adminRoles(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...AdminRolesConnectionFragment
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "adminRoles": {
      "edges": [AdminRolesEdge],
      "nodes": [AdminRole],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

advertSearch

Description

Search for published adverts. NOTE: This is probably only helpful for exposing search directly to consumers.

Response

Returns an AdvertSearchResponse!

Arguments
Name Description
attributes - AdvertSearchInput Search query params to determine which adverts are returned.

Example

Query
query advertSearch($attributes: AdvertSearchInput) {
  advertSearch(attributes: $attributes) {
    ...AdvertSearchResponseFragment
  }
}
Variables
{"attributes": AdvertSearchInput}
Response
{
  "data": {
    "advertSearch": {
      "adverts": AdvertsConnection,
      "applicableFilters": AdvertSearchApplicableFilters,
      "esAdverts": ESAdvertsConnection,
      "pointInTime": "abc123",
      "seoContent": SeoContent
    }
  }
}
Queries

advertsWhere

Description

Select adverts with the given attributes. Only adverts that match all queried fields will be returned. If no arguments are given, returns an empty response.

Response

Returns an AdvertsConnection!

Arguments
Name Description
q - String Keywords to search for. (Currently Title and Product ID). Default = null
idTitleSkuBarcode - String Search in ProductID, Title, SKU and Barcode. Default = null
brandIds - [ID!] Default = []
legacyIds - [Int!] Default = []
retailerIds - [ID!] Filter to only associated sellers. (Overridden for seller api keys). Default = []
status - AdvertStatusEnum Default = null
taxonIds - [ID!] Default = []
taxonIdsWithDescendants - [ID!] Select adverts that have associated taxons and including the taxon descendants. Default = []
title - String Default = null
variantBarcodes - [String!] Select adverts that have associated variants with one of the given barcodes. Default = []
variantSkus - [String!] Select adverts that have associated variants with one of the given skus. Default = []
createdSince - ISO8601DateTime Select adverts created since this time. Default = null
createdUntil - ISO8601DateTime Select adverts created until this time. Default = null
updatedSince - ISO8601DateTime Select adverts updated since this time. Default = null
updatedUntil - ISO8601DateTime Select adverts updated until this time. Default = null
sort - [AdvertsWhereSort!] Specifies how the list is sorted. Default = []
vetted - Boolean Select adverts that have been vetted. Default = false
rejectedViaVetting - Boolean Select adverts that have been rejected via vetting. Default = false
withVettingRejectedReason - Boolean Select adverts that have a vetting rejection reason. Default = false
requiresVetting - Boolean Select adverts that require vetting. Default = false
stockStatus - AdvertStockStatusEnum Select adverts with stock or without stock. Default = null
failedCatalogRuleIds - [ID!] Filter adverts with provided catalog rule errors. Note this filter may be impacted by background tasks. Default = []
withFailedCatalogRules - Boolean Filter adverts with any catalog rule errors. Note this filter may be impacted by background tasks.
externalId - ExternalIDInput Select adverts with a particular External ID. Default = null
suggestedTaxonIds - [ID!] ID of suggested taxon
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query advertsWhere(
  $q: String,
  $idTitleSkuBarcode: String,
  $brandIds: [ID!],
  $legacyIds: [Int!],
  $retailerIds: [ID!],
  $status: AdvertStatusEnum,
  $taxonIds: [ID!],
  $taxonIdsWithDescendants: [ID!],
  $title: String,
  $variantBarcodes: [String!],
  $variantSkus: [String!],
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $updatedSince: ISO8601DateTime,
  $updatedUntil: ISO8601DateTime,
  $sort: [AdvertsWhereSort!],
  $vetted: Boolean,
  $rejectedViaVetting: Boolean,
  $withVettingRejectedReason: Boolean,
  $requiresVetting: Boolean,
  $stockStatus: AdvertStockStatusEnum,
  $failedCatalogRuleIds: [ID!],
  $withFailedCatalogRules: Boolean,
  $externalId: ExternalIDInput,
  $suggestedTaxonIds: [ID!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  advertsWhere(
    q: $q,
    idTitleSkuBarcode: $idTitleSkuBarcode,
    brandIds: $brandIds,
    legacyIds: $legacyIds,
    retailerIds: $retailerIds,
    status: $status,
    taxonIds: $taxonIds,
    taxonIdsWithDescendants: $taxonIdsWithDescendants,
    title: $title,
    variantBarcodes: $variantBarcodes,
    variantSkus: $variantSkus,
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    updatedSince: $updatedSince,
    updatedUntil: $updatedUntil,
    sort: $sort,
    vetted: $vetted,
    rejectedViaVetting: $rejectedViaVetting,
    withVettingRejectedReason: $withVettingRejectedReason,
    requiresVetting: $requiresVetting,
    stockStatus: $stockStatus,
    failedCatalogRuleIds: $failedCatalogRuleIds,
    withFailedCatalogRules: $withFailedCatalogRules,
    externalId: $externalId,
    suggestedTaxonIds: $suggestedTaxonIds,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...AdvertsConnectionFragment
  }
}
Variables
{
  "q": null,
  "idTitleSkuBarcode": null,
  "brandIds": [""],
  "legacyIds": [""],
  "retailerIds": [""],
  "status": "null",
  "taxonIds": [""],
  "taxonIdsWithDescendants": [""],
  "title": null,
  "variantBarcodes": [""],
  "variantSkus": [""],
  "createdSince": null,
  "createdUntil": null,
  "updatedSince": null,
  "updatedUntil": null,
  "sort": [""],
  "vetted": false,
  "rejectedViaVetting": false,
  "withVettingRejectedReason": false,
  "requiresVetting": false,
  "stockStatus": "null",
  "failedCatalogRuleIds": [""],
  "withFailedCatalogRules": false,
  "externalId": null,
  "suggestedTaxonIds": ["4"],
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "advertsWhere": {
      "edges": [AdvertsEdge],
      "nodes": [Advert],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

adyenBillingSettings

Description

Adyen settings for billing

Response

Returns an AdyenBillingSettings

Example

Query
query adyenBillingSettings {
  adyenBillingSettings {
    ...AdyenBillingSettingsFragment
  }
}
Response
{
  "data": {
    "adyenBillingSettings": {
      "adyenBillingPaymentsWidgetPaymentMethod": 4,
      "adyenDirectDebitPaymentMethod": "4",
      "billingMerchantAccount": "xyz789",
      "category": "RATINGS_AND_REVIEWS",
      "checkoutApiKey": "xyz789",
      "checkoutEndpoint": "xyz789",
      "clientKey": "abc123",
      "collectThreeDSecureInformation": true,
      "description": "abc123",
      "hmacKey": "xyz789",
      "logoUrl": "abc123",
      "paymentsApiAuth": "abc123",
      "paymentsEndpoint": "abc123",
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "status": "AVAILABLE"
    }
  }
}
Queries

adyenEcommerceSettings

Description

Adyen settings for ecommerce

Response

Returns an AdyenEcommerceSettings

Example

Query
query adyenEcommerceSettings {
  adyenEcommerceSettings {
    ...AdyenEcommerceSettingsFragment
  }
}
Response
{
  "data": {
    "adyenEcommerceSettings": {
      "adyenEcommercePaymentsWidgetPaymentMethod": "4",
      "category": "RATINGS_AND_REVIEWS",
      "checkoutApiKey": "xyz789",
      "checkoutEndpoint": "abc123",
      "clientKey": "abc123",
      "customMerchantBaseFeeCents": 123,
      "customMerchantBaseFeeFormatted": "abc123",
      "customMerchantFee": 987.65,
      "description": "abc123",
      "dropInEnabled": false,
      "ecommerceMerchantAccount": "xyz789",
      "hmacKey": "abc123",
      "logoUrl": "abc123",
      "overrideCustomMerchantFee": false,
      "paymentsApiAuth": "abc123",
      "paymentsEndpoint": "xyz789",
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "status": "AVAILABLE"
    }
  }
}
Queries

afterpay

Description

Afterpay payment configuration data.

Response

Returns an Afterpay

Example

Query
query afterpay {
  afterpay {
    ...AfterpayFragment
  }
}
Response
{"data": {"afterpay": {"maxAmount": 123.45, "minAmount": 123.45}}}
Queries

afterpaySettings

Description

Afterpay settings

Response

Returns an AfterpaySettings

Example

Query
query afterpaySettings {
  afterpaySettings {
    ...AfterpaySettingsFragment
  }
}
Response
{
  "data": {
    "afterpaySettings": {
      "afterpayEnabled": false,
      "category": "RATINGS_AND_REVIEWS",
      "customMerchantBaseFeeCents": 987,
      "customMerchantBaseFeeFormatted": "abc123",
      "customMerchantFee": 123.45,
      "description": "xyz789",
      "logoUrl": "xyz789",
      "merchantId": "xyz789",
      "merchantKey": "xyz789",
      "overrideCustomMerchantFee": true,
      "providerHandle": "abc123",
      "providerName": "xyz789",
      "regionCode": "xyz789",
      "status": "AVAILABLE"
    }
  }
}
Queries

allAdverts

Description

Includes deleted and unpublished adverts. When using a Seller API key, adverts will be restricted to that Seller.

Response

Returns an AllAdvertsConnection!

Arguments
Name Description
updatedSince - ISO8601DateTime Only return adverts which have been updated since this date. This takes into account not only the last updatedAt date of the advert(s), but also the last updatedAt date of the seller associated with the advert(s). Default = null
vetted - Boolean True if advert is vetted. Default = null
requiresVetting - Boolean True if the advert requires vetting. Default = null
sort - [AdvertsWhereSort!] Specifies how the list is sorted. Default = []
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query allAdverts(
  $updatedSince: ISO8601DateTime,
  $vetted: Boolean,
  $requiresVetting: Boolean,
  $sort: [AdvertsWhereSort!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  allAdverts(
    updatedSince: $updatedSince,
    vetted: $vetted,
    requiresVetting: $requiresVetting,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...AllAdvertsConnectionFragment
  }
}
Variables
{
  "updatedSince": null,
  "vetted": null,
  "requiresVetting": null,
  "sort": [""],
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "allAdverts": {
      "edges": [AllAdvertsEdge],
      "nodes": [Advert],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

allSellers

Description

Query for sellers (extant and prospective or retailer). Only accessible to operator admin users.

Response

Returns an AllSellersConnection!

Arguments
Name Description
updatedSince - ISO8601DateTime Only return sellers which have been updated since this date. Default = null
accountType - [AllSellersAccountTypeEnum!] Only return sellers with these types (default is retailer and prospective). Default = [RETAILER, PROSPECTIVE]
includeDeleted - Boolean Include soft deleted sellers in the list. Default = null
sort - [AllSellersSort!] Specifies how the list is sorted. Default = [{field: UPDATED_AT, ordering: ASCENDING}]
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query allSellers(
  $updatedSince: ISO8601DateTime,
  $accountType: [AllSellersAccountTypeEnum!],
  $includeDeleted: Boolean,
  $sort: [AllSellersSort!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  allSellers(
    updatedSince: $updatedSince,
    accountType: $accountType,
    includeDeleted: $includeDeleted,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...AllSellersConnectionFragment
  }
}
Variables
{
  "updatedSince": null,
  "accountType": ["RETAILER", "PROSPECTIVE"],
  "includeDeleted": null,
  "sort": [{"field": "UPDATED_AT", "ordering": "ASCENDING"}],
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "allSellers": {
      "edges": [AllSellersEdge],
      "nodes": [DeletedSeller],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

apiKeyPrincipal

Description

Show key's principal.

Response

Returns an APIKeyPrincipal

Example

Query
query apiKeyPrincipal {
  apiKeyPrincipal {
    ...APIKeyPrincipalFragment
  }
}
Response
{
  "data": {
    "apiKeyPrincipal": {
      "emailAddress": "abc123",
      "name": "xyz789",
      "seller": Seller,
      "user": User,
      "username": "xyz789"
    }
  }
}
Queries

billings

Description

Get billings

Response

Returns a BillingsConnection!

Arguments
Name Description
retailerIds - [ID!] IDs of sellers. If omitted will return all billing invoices in marketplace. (Overridden for seller API keys). Default = []
filters - BillingFilters Filters the list of billings with different criteria. Default = null
sort - BillingSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query billings(
  $retailerIds: [ID!],
  $filters: BillingFilters,
  $sort: BillingSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  billings(
    retailerIds: $retailerIds,
    filters: $filters,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...BillingsConnectionFragment
  }
}
Variables
{
  "retailerIds": [""],
  "filters": null,
  "sort": null,
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "billings": {
      "edges": [BillingsEdge],
      "nodes": [Billing],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

braintree

Description

Show braintree information.

Response

Returns a Braintree

Example

Query
query braintree {
  braintree {
    ...BraintreeFragment
  }
}
Response
{
  "data": {
    "braintree": {
      "clientToken": "abc123",
      "clientTokenError": "abc123"
    }
  }
}
Queries

braintreeBillingSettings

Description

Braintree settings for billing.

Response

Returns a BraintreeBillingSettings

Example

Query
query braintreeBillingSettings {
  braintreeBillingSettings {
    ...BraintreeBillingSettingsFragment
  }
}
Response
{
  "data": {
    "braintreeBillingSettings": {
      "billingMerchantAccount": "abc123",
      "braintree3dSecureEnabled": false,
      "braintreeBillingDropInEnabled": true,
      "canEnableBraintree3dSecure": false,
      "category": "RATINGS_AND_REVIEWS",
      "description": "abc123",
      "logoUrl": "abc123",
      "merchantId": "xyz789",
      "paymentMethod": PaymentMethod,
      "paypalAccount": "xyz789",
      "privateKey": "abc123",
      "providerHandle": "abc123",
      "providerName": "xyz789",
      "publicKey": "xyz789",
      "status": "AVAILABLE",
      "useSandboxEnvironment": true
    }
  }
}
Queries

braintreeEcommerceSettings

Description

Braintree settings for ecommerce.

Response

Returns a BraintreeEcommerceSettings

Example

Query
query braintreeEcommerceSettings {
  braintreeEcommerceSettings {
    ...BraintreeEcommerceSettingsFragment
  }
}
Response
{
  "data": {
    "braintreeEcommerceSettings": {
      "applePayEnabled": true,
      "braintree3dSecureEnabled": true,
      "braintreeEcommerceDropInEnabled": false,
      "braintreeFraudProtectionEnabled": false,
      "canEnableBraintree3dSecure": false,
      "canEnableBraintreeFraudProtection": false,
      "category": "RATINGS_AND_REVIEWS",
      "customMerchantBaseFee": "abc123",
      "customMerchantFee": "xyz789",
      "description": "xyz789",
      "ecommerceMerchantAccount": "abc123",
      "googleMerchantId": "abc123",
      "googlePayEnabled": false,
      "kountSiteId": "xyz789",
      "logoUrl": "abc123",
      "merchantId": "abc123",
      "overrideCustomMerchantFee": true,
      "paymentMethod": PaymentMethod,
      "paypalAccount": "xyz789",
      "privateKey": "xyz789",
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "publicKey": "xyz789",
      "sendShippingDetailsToBraintree": false,
      "sendSiteNameToKount": true,
      "status": "AVAILABLE",
      "useSandboxEnvironment": false
    }
  }
}
Queries

brandSearch

Description

Search for Brands.

Response

Returns an ESBrandSearchConnection!

Arguments
Name Description
keyword - String Filter brands based on the keyword value passed. Default = ""
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query brandSearch(
  $keyword: String,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  brandSearch(
    keyword: $keyword,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ESBrandSearchConnectionFragment
  }
}
Variables
{
  "keyword": "",
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "brandSearch": {
      "edges": [ESBrandSearchEdge],
      "nodes": [ESBrandSearch],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

brands

Description

List Brands.

Response

Returns a BrandsConnection!

Arguments
Name Description
showOnlineOnly - Boolean Request only brands that have online adverts associated with them. Default = false
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query brands(
  $showOnlineOnly: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  brands(
    showOnlineOnly: $showOnlineOnly,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...BrandsConnectionFragment
  }
}
Variables
{
  "showOnlineOnly": false,
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "brands": {
      "edges": [BrandsEdge],
      "nodes": [Brand],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

cart

Description

Get cart details.

Response

Returns a Cart!

Arguments
Name Description
id - ID! ID of the requested cart.

Example

Query
query cart($id: ID!) {
  cart(id: $id) {
    ...CartFragment
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "cart": {
      "address": Address,
      "billingAddress": Address,
      "billingCompanyName": "xyz789",
      "billingEmailAddress": "abc123",
      "billingFirstName": "xyz789",
      "billingPhone": "abc123",
      "billingSurname": "xyz789",
      "buyableQuantity": 987,
      "cartItems": CartItemConnection,
      "cartSellers": CartSellersConnection,
      "companyName": "abc123",
      "couponCode": "abc123",
      "createdAt": ISO8601DateTime,
      "discountCents": 987,
      "discountFormatted": "xyz789",
      "emailAddress": "abc123",
      "firstName": "xyz789",
      "id": "4",
      "isGift": true,
      "messageToGiftRecipient": "xyz789",
      "messageToSeller": "xyz789",
      "phone": "abc123",
      "shippingCostCents": 987,
      "shippingCostFormatted": "abc123",
      "subtotalCents": 123,
      "subtotalFormatted": "abc123",
      "surname": "abc123",
      "taxCalculationStatus": "SUCCESS",
      "taxTotalCents": 123,
      "taxTotalFormatted": "xyz789",
      "token": "abc123",
      "totalCents": 123,
      "totalFormatted": "abc123",
      "updatedAt": ISO8601DateTime,
      "user": User
    }
  }
}
Queries

catalogRules

Description

Returns a collection of Catalog Rules available on the marketplace.

Response

Returns a CatalogRulesConnection!

Arguments
Name Description
createdSince - ISO8601DateTime Only return catalog rules made on or after this date. Default = null
createdUntil - ISO8601DateTime Only return catalog rules made on or before this date. Default = null
keys - [CatalogRulesKeyEnum!] Filter catalog rules by the key field. Default = null
sort - CatalogRulesSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query catalogRules(
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $keys: [CatalogRulesKeyEnum!],
  $sort: CatalogRulesSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  catalogRules(
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    keys: $keys,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CatalogRulesConnectionFragment
  }
}
Variables
{
  "createdSince": null,
  "createdUntil": null,
  "keys": ["ul"],
  "sort": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "catalogRules": {
      "edges": [CatalogRulesEdge],
      "nodes": [CatalogRule],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

changeLogs

Description

Returns relevant change logs. Only accessible to operator and seller admin users.

Response

Returns a ChangeLogsConnection

Arguments
Name Description
createdAt - DateRangeInput Show changes made between dates
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query changeLogs(
  $createdAt: DateRangeInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  changeLogs(
    createdAt: $createdAt,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ChangeLogsConnectionFragment
  }
}
Variables
{
  "createdAt": DateRangeInput,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "changeLogs": {
      "edges": [ChangeLogsEdge],
      "nodes": [ChangeLog],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

chatMessages

Description

Fetch chat messages between operator and seller. Only accessible to operator and seller admin users.

Response

Returns a ChatMessagesConnection!

Arguments
Name Description
sellerId - ID ID of the seller. May be omitted if using a seller api key, but is required otherwise
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query chatMessages(
  $sellerId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  chatMessages(
    sellerId: $sellerId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ChatMessagesConnectionFragment
  }
}
Variables
{
  "sellerId": "4",
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "chatMessages": {
      "edges": [ChatMessageEdge],
      "lastReadMessage": ChatMessage,
      "nodes": [ChatMessage],
      "pageInfo": PageInfo,
      "totalCount": 987,
      "totalUnreadCount": 123
    }
  }
}
Queries

commissionPackageSchedules

Description

Returns a collection of commission packages schedules available on the marketplace.

Response

Returns a CommissionPackageScheduleConnection!

Arguments
Name Description
filters - CommissionPackageScheduleFilters Filters for Commission Package Schedules. Default = {}
createdSince - ISO8601DateTime Only return commission package schedules made after this date. Default = null
createdUntil - ISO8601DateTime Only return commission package schedules created before this date. Default = null
commissionPackageScheduleIds - [ID!] ID of the commission package schedule. If omitted will return all commission packages schedules in marketplace. Default = []
sort - CommissionPackageScheduleSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query commissionPackageSchedules(
  $filters: CommissionPackageScheduleFilters,
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $commissionPackageScheduleIds: [ID!],
  $sort: CommissionPackageScheduleSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  commissionPackageSchedules(
    filters: $filters,
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    commissionPackageScheduleIds: $commissionPackageScheduleIds,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CommissionPackageScheduleConnectionFragment
  }
}
Variables
{
  "filters": {},
  "createdSince": null,
  "createdUntil": null,
  "commissionPackageScheduleIds": [""],
  "sort": null,
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "commissionPackageSchedules": {
      "edges": [CommissionPackageScheduleEdge],
      "nodes": [CommissionPackageSchedule],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

commissionPackageVersionLogs

Description

Returns a collection of commission packages versions for a specified seller in the marketplace

Response

Returns a CommissionPackageVersionLogConnection!

Arguments
Name Description
retailerId - ID! ID of the seller
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query commissionPackageVersionLogs(
  $retailerId: ID!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  commissionPackageVersionLogs(
    retailerId: $retailerId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CommissionPackageVersionLogConnectionFragment
  }
}
Variables
{
  "retailerId": "4",
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "commissionPackageVersionLogs": {
      "edges": [CommissionPackageVersionLogEdge],
      "nodes": [CommissionPackageVersionLog],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

commissionPackages

Description

Returns a collection of commission packages available on the marketplace

Response

Returns a CommissionPackageConnection!

Arguments
Name Description
retailerIds - [ID!] ID of the seller. If omitted will return all commission_packages in marketplace. (Overridden for seller API keys). Default = []
appliesToPostage - Boolean Only return commission packages with specified postage setting. Default = null
name - String Search by name of the commission package. Includes partial text matches in results. (default keyword returns default package). Default = null
createdSince - ISO8601DateTime Only return commission packages made after this date. Default = null
createdUntil - ISO8601DateTime Only return commission packages made before this date. Default = null
sort - CommissionPackageSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query commissionPackages(
  $retailerIds: [ID!],
  $appliesToPostage: Boolean,
  $name: String,
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $sort: CommissionPackageSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  commissionPackages(
    retailerIds: $retailerIds,
    appliesToPostage: $appliesToPostage,
    name: $name,
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CommissionPackageConnectionFragment
  }
}
Variables
{
  "retailerIds": [""],
  "appliesToPostage": null,
  "name": null,
  "createdSince": null,
  "createdUntil": null,
  "sort": null,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "commissionPackages": {
      "edges": [CommissionPackageEdge],
      "nodes": [CommissionPackage],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

contextualHistory

Description

BETA: may change behaviour or arguments

Response

Returns a ContextualHistoryConnection!

Arguments
Name Description
itemId - ID
createdAt - DateRangeInput
event - String
itemType - String
whodunnit - String
whodunnitType - String
enrichAttributes - Boolean Enables enrichment of papertrail version attributes like id to name mapping
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query contextualHistory(
  $itemId: ID,
  $createdAt: DateRangeInput,
  $event: String,
  $itemType: String,
  $whodunnit: String,
  $whodunnitType: String,
  $enrichAttributes: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  contextualHistory(
    itemId: $itemId,
    createdAt: $createdAt,
    event: $event,
    itemType: $itemType,
    whodunnit: $whodunnit,
    whodunnitType: $whodunnitType,
    enrichAttributes: $enrichAttributes,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ContextualHistoryConnectionFragment
  }
}
Variables
{
  "itemId": "4",
  "createdAt": DateRangeInput,
  "event": "xyz789",
  "itemType": "xyz789",
  "whodunnit": "xyz789",
  "whodunnitType": "xyz789",
  "enrichAttributes": false,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "contextualHistory": {
      "edges": [ContextualHistoryEdge],
      "nodes": [ContextualHistory],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

countries

Description

All countries and states

Response

Returns a CountrysConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query countries(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  countries(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CountrysConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "countries": {
      "edges": [CountrysEdge],
      "nodes": [Country],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

customFieldGroups

Use entityCustomFieldGroups instead
Description

Returns all CustomFieldGroups.

Response

Returns a CustomFieldGroupsConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query customFieldGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  customFieldGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...CustomFieldGroupsConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "customFieldGroups": {
      "edges": [CustomFieldGroupsEdge],
      "nodes": [CustomFieldGroup],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

emailMarketing

Description

Direct email marketing.

Response

Returns an EmailMarketing!

Example

Query
query emailMarketing {
  emailMarketing {
    ...EmailMarketingFragment
  }
}
Response
{
  "data": {
    "emailMarketing": {
      "edmEnabled": false,
      "gdprSubscriptionCheckboxEnabled": false,
      "id": "4",
      "newsletterSubscriptionForm": NewsletterSubscriptionForm,
      "privacyPolicyLink": TextLink
    }
  }
}
Queries

emailMarketingSubscriptions

Description

Email Marketing Subscriptions

Response

Returns a SubscriptionsConnection!

Arguments
Name Description
subscribedSince - ISO8601Date Only return Subscriptions created after this date, format: YYYY-MM-DD. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query emailMarketingSubscriptions(
  $subscribedSince: ISO8601Date,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  emailMarketingSubscriptions(
    subscribedSince: $subscribedSince,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...SubscriptionsConnectionFragment
  }
}
Variables
{
  "subscribedSince": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "emailMarketingSubscriptions": {
      "edges": [SubscriptionsEdge],
      "nodes": [Subscription],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

entityCustomFieldGroups

Description

Returns all CustomFieldGroups.

Response

Returns an EntityCustomFieldGroupsConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query entityCustomFieldGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  entityCustomFieldGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...EntityCustomFieldGroupsConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "entityCustomFieldGroups": {
      "edges": [EntityCustomFieldGroupsEdge],
      "nodes": [EntityCustomFieldGroup],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

experimentalAi

Experimental, will change
Description

Don't use me.

Response

Returns an ExperimentalAi!

Example

Query
query experimentalAi {
  experimentalAi {
    ...ExperimentalAiFragment
  }
}
Response
{
  "data": {
    "experimentalAi": {
      "generateDescription": "xyz789"
    }
  }
}
Queries

externalIds

Description

List ExternalIds. Only accessible to operator and seller admin users.

Response

Returns [ExternalID!]!

Arguments
Name Description
ownerType - String Specify the type of the external id, eg: invoice, order, variant. Default = null
key - String Label for the system or client that uses this external ID. Default = null
value - String The external ID used by an external system or client. Default = null
values - [String!] The external IDs (plural) used by an external system or client. Default = null
first - Int Limit to the first N values. Default = null

Example

Query
query externalIds(
  $ownerType: String,
  $key: String,
  $value: String,
  $values: [String!],
  $first: Int
) {
  externalIds(
    ownerType: $ownerType,
    key: $key,
    value: $value,
    values: $values,
    first: $first
  ) {
    ...ExternalIDFragment
  }
}
Variables
{"ownerType": null, "key": null, "value": null, "values": null, "first": null}
Response
{
  "data": {
    "externalIds": [
      {
        "id": "4",
        "key": "abc123",
        "owner": Node,
        "value": "abc123"
      }
    ]
  }
}
Queries

featureEnabled

Description

Check if a feature flag is enabled?.

Response

Returns a Boolean!

Arguments
Name Description
name - String! The flag name to check if it is enabled.

Example

Query
query featureEnabled($name: String!) {
  featureEnabled(name: $name)
}
Variables
{"name": "abc123"}
Response
{"data": {"featureEnabled": true}}
Queries

givexSettings

Description

Givex settings

Response

Returns a GivexSettings

Example

Query
query givexSettings {
  givexSettings {
    ...GivexSettingsFragment
  }
}
Response
{
  "data": {
    "givexSettings": {
      "category": "RATINGS_AND_REVIEWS",
      "customMerchantBaseFeeCents": 987,
      "customMerchantBaseFeeFormatted": "xyz789",
      "customMerchantFee": 123.45,
      "description": "xyz789",
      "givexPaymentMethod": "4",
      "logoUrl": "abc123",
      "overrideCustomMerchantFee": true,
      "password": "xyz789",
      "primaryApiUrl": "xyz789",
      "providerHandle": "xyz789",
      "providerName": "abc123",
      "secondaryApiUrl": "xyz789",
      "status": "AVAILABLE",
      "userId": "abc123"
    }
  }
}
Queries

globalSearch

Description

Deprecated: beta. Only accessible to operator and seller admin users.

Response

Returns a GlobalSearchResultsConnection!

Arguments
Name Description
keywords - String! Search query params to determine which records are returned. Default = ""
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query globalSearch(
  $keywords: String!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  globalSearch(
    keywords: $keywords,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...GlobalSearchResultsConnectionFragment
  }
}
Variables
{
  "keywords": "",
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "globalSearch": {
      "edges": [GlobalSearchResultsEdge],
      "nodes": [GlobalSearchResult],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

goldenProducts

Description

Golden Product records. Only accessible to operator admin users.

Response

Returns a GoldenProductsConnection!

Arguments
Name Description
activeStatus - GoldenProductActiveStatusEnum Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query goldenProducts(
  $activeStatus: GoldenProductActiveStatusEnum,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  goldenProducts(
    activeStatus: $activeStatus,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...GoldenProductsConnectionFragment
  }
}
Variables
{
  "activeStatus": "null",
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "goldenProducts": {
      "edges": [GoldenProductsEdge],
      "nodes": [GoldenProduct],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

header

Description

Site header data.

Response

Returns a Header!

Example

Query
query header {
  header {
    ...HeaderFragment
  }
}
Response
{
  "data": {
    "header": {
      "categoryMenuEntries": [DirectLink],
      "navBar": NavBar,
      "searchFields": [FreeTextAndSelectField]
    }
  }
}
Queries

healthCheck

Description

Get health_check

Response

Returns a HealthCheck!

Example

Query
query healthCheck {
  healthCheck {
    ...HealthCheckFragment
  }
}
Response
{
  "data": {
    "healthCheck": {
      "all": [StatusInfo],
      "database": StatusInfo,
      "default": StatusInfo,
      "elasticsearch": StatusInfo,
      "memcached": StatusInfo,
      "puma": StatusInfo,
      "redis": StatusInfo,
      "ruby": StatusInfo,
      "sidekiq": StatusInfo,
      "success": false,
      "version": StatusInfo
    }
  }
}
Queries

importExports

Description

List imports, and exports

Response

Returns an ImportExportConnection

Arguments
Name Description
type - ImportExportTypeEnum
status - ImportExportStatusEnum
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query importExports(
  $type: ImportExportTypeEnum,
  $status: ImportExportStatusEnum,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  importExports(
    type: $type,
    status: $status,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ImportExportConnectionFragment
  }
}
Variables
{
  "type": "ADVERT_EXPORT",
  "status": "PENDING",
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "importExports": {
      "edges": [ImportExportEdge],
      "nodes": [ImportExport],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

invoiceAmendments

Description

Get invoice amendments

Response

Returns an InvoiceAmendmentsConnection!

Arguments
Name Description
filters - InvoiceAmendmentFilters Filters the list of invoice amendments with different criteria. Default = null
sort - InvoiceAmendmentSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query invoiceAmendments(
  $filters: InvoiceAmendmentFilters,
  $sort: InvoiceAmendmentSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  invoiceAmendments(
    filters: $filters,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...InvoiceAmendmentsConnectionFragment
  }
}
Variables
{
  "filters": null,
  "sort": null,
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "invoiceAmendments": {
      "edges": [InvoiceAmendmentsEdge],
      "nodes": [InvoiceAmendment],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

invoiceAnnotationType

Description

All invoice annotation types.

Response

Returns an InvoiceAnnotationTypeConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query invoiceAnnotationType(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  invoiceAnnotationType(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...InvoiceAnnotationTypeConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "invoiceAnnotationType": {
      "edges": [InvoiceAnnotationTypeEdge],
      "nodes": [InvoiceAnnotationType],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

invoices

Description

Get invoices

Response

Returns an InvoicesConnection!

Arguments
Name Description
filters - InvoiceFilters Filters the list of invoices with different criteria. Default = null
sort - InvoiceSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query invoices(
  $filters: InvoiceFilters,
  $sort: InvoiceSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  invoices(
    filters: $filters,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...InvoicesConnectionFragment
  }
}
Variables
{
  "filters": null,
  "sort": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "invoices": {
      "edges": [InvoicesEdge],
      "nodes": [Invoice],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

klaviyoSettings

Description

Klaviyo settings.

Response

Returns a KlaviyoSettings

Example

Query
query klaviyoSettings {
  klaviyoSettings {
    ...KlaviyoSettingsFragment
  }
}
Response
{
  "data": {
    "klaviyoSettings": {
      "category": "RATINGS_AND_REVIEWS",
      "description": "abc123",
      "ecommerceTrackingEnabled": false,
      "edmEnabled": true,
      "logoUrl": "xyz789",
      "privateApiKey": "abc123",
      "providerHandle": "abc123",
      "providerName": "abc123",
      "publicApiKey": "abc123",
      "status": "AVAILABLE"
    }
  }
}
Queries

locationSuggestions

Description

Get suggestions for location-based search queries.

Response

Returns [Location!]!

Arguments
Name Description
query - String! Location query string. Can be a city or postcode.

Example

Query
query locationSuggestions($query: String!) {
  locationSuggestions(query: $query) {
    ...LocationFragment
  }
}
Variables
{"query": "xyz789"}
Response
{
  "data": {
    "locationSuggestions": [
      {
        "countryCode": "xyz789",
        "displayName": "xyz789",
        "displayNameFull": "abc123",
        "duplicated": false,
        "locationName": "xyz789",
        "locationSlug": "xyz789",
        "postalCode": "abc123",
        "regionName": "abc123",
        "regionShort": "abc123",
        "regionSlug": "abc123"
      }
    ]
  }
}
Queries

loyaltyProgramLevels

Description

Loyalty program levels.

Response

Returns a LoyaltyProgramLevelsConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query loyaltyProgramLevels(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  loyaltyProgramLevels(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...LoyaltyProgramLevelsConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "loyaltyProgramLevels": {
      "edges": [LoyaltyProgramLevelsEdge],
      "nodes": [LoyaltyProgramLevel],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

mappings

Description

List mappings

Response

Returns a MappingsConnection!

Arguments
Name Description
sellerId - ID ID of the seller. May be omitted if using a seller api key, but is required otherwise
filters - MappingFilters
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query mappings(
  $sellerId: ID,
  $filters: MappingFilters,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  mappings(
    sellerId: $sellerId,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...MappingsConnectionFragment
  }
}
Variables
{
  "sellerId": "4",
  "filters": MappingFilters,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "mappings": {
      "edges": [MappingEdge],
      "nodes": [Mapping],
      "pageInfo": PageInfo,
      "totalCount": 123,
      "unfilteredCounts": MappingCount
    }
  }
}
Queries

measurementUnits

Description

Returns a collection of measurement units available on the marketplace

Response

Returns a MeasurementUnitConnection!

Arguments
Name Description
filters - MeasurementUnitFilters Filters for Measurement Units. Default = {}
sort - MeasurementUnitSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query measurementUnits(
  $filters: MeasurementUnitFilters,
  $sort: MeasurementUnitSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  measurementUnits(
    filters: $filters,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...MeasurementUnitConnectionFragment
  }
}
Variables
{
  "filters": {},
  "sort": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "measurementUnits": {
      "edges": [MeasurementUnitEdge],
      "nodes": [MeasurementUnit],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

node

Description

Fetches an object given its ID.

Response

Returns a Node

Arguments
Name Description
id - ID! ID of the object.

Example

Query
query node($id: ID!) {
  node(id: $id) {
    ...NodeFragment
  }
}
Variables
{"id": 4}
Response
{"data": {"node": {"id": "4"}}}
Queries

nodes

Description

Fetches a list of objects given a list of IDs.

Response

Returns [Node]!

Arguments
Name Description
ids - [ID!]! IDs of the objects.

Example

Query
query nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    ...NodeFragment
  }
}
Variables
{"ids": [4]}
Response
{"data": {"nodes": [{"id": "4"}]}}
Queries

optionTypes

Description

Returns a list of OptionTypes. Only accessible to operator admin users.

Response

Returns an OptionTypesConnection!

Arguments
Name Description
ids - [ID!] Only return OptionTypes matching IDs in array. Default = null
withNoPrototype - Boolean If true, only return OptionTypes which have no prototype. Default = false
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query optionTypes(
  $ids: [ID!],
  $withNoPrototype: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  optionTypes(
    ids: $ids,
    withNoPrototype: $withNoPrototype,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...OptionTypesConnectionFragment
  }
}
Variables
{
  "ids": null,
  "withNoPrototype": false,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "optionTypes": {
      "edges": [OptionTypesEdge],
      "nodes": [OptionType],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

order

Description

Get order details

Response

Returns an Order!

Arguments
Name Description
orderId - ID! ID of the requested order.

Example

Query
query order($orderId: ID!) {
  order(orderId: $orderId) {
    ...OrderFragment
  }
}
Variables
{"orderId": "4"}
Response
{
  "data": {
    "order": {
      "address": Address,
      "aggregateInvoiceStatus": "AWAITING_PAYMENT",
      "aggregateInvoiceStatusFinal": false,
      "billingAddress": Address,
      "billingBusinessRegistrationCode": "xyz789",
      "billingCompanyName": "xyz789",
      "billingEmailAddress": "xyz789",
      "billingFirstName": "abc123",
      "billingPhone": "abc123",
      "billingSurname": "abc123",
      "cartId": 4,
      "companyName": "xyz789",
      "createdAt": ISO8601DateTime,
      "discountCents": 123,
      "discountFormatted": "xyz789",
      "emailAddress": "abc123",
      "expectedDeliveryDate": ISO8601DateTime,
      "expectedDeliverySlot": "abc123",
      "externalId": "xyz789",
      "externalIds": [ExternalID],
      "firstName": "xyz789",
      "id": "4",
      "invoices": InvoiceConnection,
      "isGift": false,
      "legacyId": 123,
      "lineItems": LineItemConnection,
      "messageToGiftRecipient": "abc123",
      "messageToSeller": "xyz789",
      "metadata": [Metadatum],
      "paymentEvents": PaymentEventConnection,
      "paymentGatewayDetails": {},
      "paymentInstrumentType": "abc123",
      "phone": "xyz789",
      "postage": 123.45,
      "purchaseOrderNumber": "xyz789",
      "purgedAt": ISO8601DateTime,
      "shipments": [Shipment],
      "shippingCostCents": 987,
      "shippingCostFormatted": "xyz789",
      "status": "NEW",
      "subtotal": 123.45,
      "subtotalCents": 987,
      "subtotalFormatted": "xyz789",
      "surname": "xyz789",
      "taxTotal": 987.65,
      "taxTotalCents": 987,
      "taxTotalFormatted": "abc123",
      "token": "abc123",
      "total": 987.65,
      "totalCents": 987,
      "totalFormatted": "abc123",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

orderFromCart

Description

Get order details from the cart that it was created from.

Response

Returns an Order

Arguments
Name Description
cartId - ID! ID of the cart that was converted into this order.

Example

Query
query orderFromCart($cartId: ID!) {
  orderFromCart(cartId: $cartId) {
    ...OrderFragment
  }
}
Variables
{"cartId": 4}
Response
{
  "data": {
    "orderFromCart": {
      "address": Address,
      "aggregateInvoiceStatus": "AWAITING_PAYMENT",
      "aggregateInvoiceStatusFinal": true,
      "billingAddress": Address,
      "billingBusinessRegistrationCode": "xyz789",
      "billingCompanyName": "abc123",
      "billingEmailAddress": "xyz789",
      "billingFirstName": "xyz789",
      "billingPhone": "abc123",
      "billingSurname": "xyz789",
      "cartId": "4",
      "companyName": "xyz789",
      "createdAt": ISO8601DateTime,
      "discountCents": 987,
      "discountFormatted": "xyz789",
      "emailAddress": "abc123",
      "expectedDeliveryDate": ISO8601DateTime,
      "expectedDeliverySlot": "abc123",
      "externalId": "abc123",
      "externalIds": [ExternalID],
      "firstName": "xyz789",
      "id": 4,
      "invoices": InvoiceConnection,
      "isGift": false,
      "legacyId": 987,
      "lineItems": LineItemConnection,
      "messageToGiftRecipient": "abc123",
      "messageToSeller": "abc123",
      "metadata": [Metadatum],
      "paymentEvents": PaymentEventConnection,
      "paymentGatewayDetails": {},
      "paymentInstrumentType": "xyz789",
      "phone": "abc123",
      "postage": 123.45,
      "purchaseOrderNumber": "abc123",
      "purgedAt": ISO8601DateTime,
      "shipments": [Shipment],
      "shippingCostCents": 987,
      "shippingCostFormatted": "xyz789",
      "status": "NEW",
      "subtotal": 987.65,
      "subtotalCents": 987,
      "subtotalFormatted": "abc123",
      "surname": "xyz789",
      "taxTotal": 123.45,
      "taxTotalCents": 987,
      "taxTotalFormatted": "xyz789",
      "token": "abc123",
      "total": 987.65,
      "totalCents": 987,
      "totalFormatted": "abc123",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

paymentEvent

Query PaymentEvent with the node resolver instead
Description

Get payment event.

Response

Returns a PaymentEvent

Example

Query
query paymentEvent {
  paymentEvent {
    ...PaymentEventFragment
  }
}
Response
{
  "data": {
    "paymentEvent": {
      "amount": "xyz789",
      "id": "4",
      "paymentInstrumentType": "xyz789",
      "responseMessage": "xyz789",
      "successful": false,
      "transactionId": "xyz789"
    }
  }
}
Queries

paypalCommerceSettings

Description

Paypal Commerce settings

Response

Returns a PaypalCommerceSettings

Example

Query
query paypalCommerceSettings {
  paypalCommerceSettings {
    ...PaypalCommerceSettingsFragment
  }
}
Response
{
  "data": {
    "paypalCommerceSettings": {
      "category": "RATINGS_AND_REVIEWS",
      "creditCardEnabled": false,
      "customMerchantBaseFeeCents": 987,
      "customMerchantBaseFeeFormatted": "abc123",
      "customMerchantFee": 123.45,
      "description": "abc123",
      "logoUrl": "abc123",
      "merchantId": "abc123",
      "overrideCustomMerchantFee": false,
      "paypalEnabled": false,
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "status": "AVAILABLE",
      "testModeEnabled": false
    }
  }
}
Queries

permissionsByCategory

Description

Returns an array of user permissions grouped by category. Only accessible to operator admin users.

Response

Returns [PermissionsByCategory!]!

Example

Query
query permissionsByCategory {
  permissionsByCategory {
    ...PermissionsByCategoryFragment
  }
}
Response
{
  "data": {
    "permissionsByCategory": [
      {
        "categoryName": "SELLERS",
        "children": [PermissionsByCategory],
        "hideCategoryPermissions": false,
        "permissions": [Permission]
      }
    ]
  }
}
Queries

promotions

Description

Returns a list of Promotions.

Response

Returns a PromotionsConnection!

Arguments
Name Description
status - String One of: active, upcoming, expired, all. Defaults to all. Default = "all"
sellerId - ID ID of the seller. If omitted will return promotions for all sellers.
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query promotions(
  $status: String,
  $sellerId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  promotions(
    status: $status,
    sellerId: $sellerId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...PromotionsConnectionFragment
  }
}
Variables
{
  "status": "all",
  "sellerId": 4,
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "promotions": {
      "edges": [PromotionsEdge],
      "nodes": [Promotion],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

prototypes

Description

Returns a list of Prototypes. Only accessible to operator admin users.

Response

Returns a PrototypesConnection!

Arguments
Name Description
ids - [ID!] Only return Prototypes matching IDs in array. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query prototypes(
  $ids: [ID!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  prototypes(
    ids: $ids,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...PrototypesConnectionFragment
  }
}
Variables
{
  "ids": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "prototypes": {
      "edges": [PrototypesEdge],
      "nodes": [Prototype],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

rankedResults

Description

RankedResult records - force first adverts for category/brand

Response

Returns a RankedResultsConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query rankedResults(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  rankedResults(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RankedResultsConnectionFragment
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "rankedResults": {
      "edges": [RankedResultsEdge],
      "nodes": [RankedResult],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

redirects

Description

Returns a list of redirects.

Response

Returns a RedirectConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query redirects(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  redirects(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RedirectConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "redirects": {
      "edges": [RedirectEdge],
      "nodes": [Redirect],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

refundReasons

Description

Pre and Post Refund Reasons.

Response

Returns a RefundReason!

Example

Query
query refundReasons {
  refundReasons {
    ...RefundReasonFragment
  }
}
Response
{
  "data": {
    "refundReasons": {
      "denyRefundReasons": ["xyz789"],
      "id": 4,
      "postDispatchRefundReasons": [
        "abc123"
      ],
      "preDispatchRefundReasons": ["xyz789"]
    }
  }
}
Queries

refundRequestNotes

Description

Refund request notes

Response

Returns a RefundRequestNoteConnection!

Arguments
Name Description
createdSince - ISO8601DateTime Only return refund request notes created after this date. Default = null
createdUntil - ISO8601DateTime Only return refund request notes created before this date. Default = null
newStatus - String Only return refund request notes with this as the new status. Default = null
refundRequestIds - [ID!] Only return refund request notes for associated refund requests. Default = []
refundRequestLineItemIds - [ID!] Only return refund request notes for associated refund request line items. Default = []
retailerIds - [ID!] Only return remittances for associated sellers. (Overridden for seller API keys). Default = []
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query refundRequestNotes(
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $newStatus: String,
  $refundRequestIds: [ID!],
  $refundRequestLineItemIds: [ID!],
  $retailerIds: [ID!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  refundRequestNotes(
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    newStatus: $newStatus,
    refundRequestIds: $refundRequestIds,
    refundRequestLineItemIds: $refundRequestLineItemIds,
    retailerIds: $retailerIds,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RefundRequestNoteConnectionFragment
  }
}
Variables
{
  "createdSince": null,
  "createdUntil": null,
  "newStatus": null,
  "refundRequestIds": [""],
  "refundRequestLineItemIds": [""],
  "retailerIds": [""],
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "refundRequestNotes": {
      "edges": [RefundRequestNoteEdge],
      "nodes": [RefundRequestNote],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

refundRequests

Description

Retrieve refund requests

Response

Returns a RefundRequestConnection!

Arguments
Name Description
sellerId - ID ID of the seller. If omitted will return all refund requests
filters - RefundRequestFilters Filters the list of refund requests with different criteria. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query refundRequests(
  $sellerId: ID,
  $filters: RefundRequestFilters,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  refundRequests(
    sellerId: $sellerId,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RefundRequestConnectionFragment
  }
}
Variables
{
  "sellerId": "4",
  "filters": null,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "refundRequests": {
      "edges": [RefundRequestEdge],
      "nodes": [RefundRequest],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

remittanceAdvices

Description

Get remittance advices.

Response

Returns a RemittanceAdviceConnection!

Arguments
Name Description
legacyIds - [Int!] Only return remittances with these legacy IDs. Default = []
retailerIds - [ID!] Only return remittances for associated sellers. (Overridden for seller API keys). Default = []
retailerLegacyIds - [Int!] Only return remittances for sellers with these legacy IDs. (Overridden for seller API keys). Default = []
retailerNames - [String!] Only return remittances for sellers with these names. (Overridden for seller API keys). Default = []
createdSince - ISO8601DateTime Only return remittance advices created after this date. Default = null
createdUntil - ISO8601DateTime Only return remittance advices created before this date. Default = null
remittanceActionLastRunSince - ISO8601DateTime Only return remittance advices with remittance actions run before this date. Default = null
remittanceActionLastRunUntil - ISO8601DateTime Only return remittance advices with remittance actions run after this date. Default = null
paidSince - ISO8601DateTime Only return remittance advices paid after this date. Default = null
paidUntil - ISO8601DateTime Only return remittance advices paid before this date. Default = null
remittableType - String Only return remittances associated with invoices (if value is 'invoice') or invoice amendments (if value is 'invoice_amendment'). Default = null
total - Float Only return remittances with this total value. Default = null
totalPaid - Float Only return remittances with this total paid value. Default = null
invoiceIds - [ID!] Only return remittances for associated invoices. Default = null
invoiceLegacyIds - [Int!] Only return remittances for invoices with these legacy IDs. Default = null
invoiceAmendmentIds - [ID!] Only return remittances for associated invoice amendments. Default = null
invoiceAmendmentLegacyIds - [Int!] Only return remittances for invoice amendments with these legacy IDs. Default = null
remittanceActions - [String!] Only return remittances with particular remittance actions performed on them. Options available: 'hyperwallet', 'xero'. Default = null
paymentReference - [String!] Only return remittance advices with a specified payment reference. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query remittanceAdvices(
  $legacyIds: [Int!],
  $retailerIds: [ID!],
  $retailerLegacyIds: [Int!],
  $retailerNames: [String!],
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $remittanceActionLastRunSince: ISO8601DateTime,
  $remittanceActionLastRunUntil: ISO8601DateTime,
  $paidSince: ISO8601DateTime,
  $paidUntil: ISO8601DateTime,
  $remittableType: String,
  $total: Float,
  $totalPaid: Float,
  $invoiceIds: [ID!],
  $invoiceLegacyIds: [Int!],
  $invoiceAmendmentIds: [ID!],
  $invoiceAmendmentLegacyIds: [Int!],
  $remittanceActions: [String!],
  $paymentReference: [String!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  remittanceAdvices(
    legacyIds: $legacyIds,
    retailerIds: $retailerIds,
    retailerLegacyIds: $retailerLegacyIds,
    retailerNames: $retailerNames,
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    remittanceActionLastRunSince: $remittanceActionLastRunSince,
    remittanceActionLastRunUntil: $remittanceActionLastRunUntil,
    paidSince: $paidSince,
    paidUntil: $paidUntil,
    remittableType: $remittableType,
    total: $total,
    totalPaid: $totalPaid,
    invoiceIds: $invoiceIds,
    invoiceLegacyIds: $invoiceLegacyIds,
    invoiceAmendmentIds: $invoiceAmendmentIds,
    invoiceAmendmentLegacyIds: $invoiceAmendmentLegacyIds,
    remittanceActions: $remittanceActions,
    paymentReference: $paymentReference,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RemittanceAdviceConnectionFragment
  }
}
Variables
{
  "legacyIds": [""],
  "retailerIds": [""],
  "retailerLegacyIds": [""],
  "retailerNames": [""],
  "createdSince": null,
  "createdUntil": null,
  "remittanceActionLastRunSince": null,
  "remittanceActionLastRunUntil": null,
  "paidSince": null,
  "paidUntil": null,
  "remittableType": null,
  "total": null,
  "totalPaid": null,
  "invoiceIds": null,
  "invoiceLegacyIds": null,
  "invoiceAmendmentIds": null,
  "invoiceAmendmentLegacyIds": null,
  "remittanceActions": null,
  "paymentReference": null,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "remittanceAdvices": {
      "edges": [RemittanceAdviceEdge],
      "nodes": [RemittanceAdvice],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

remittances

Description

Get multiple remittances.

Response

Returns a RemittanceConnection!

Arguments
Name Description
createdSince - ISO8601DateTime Only return remittances made after this date. Default = null
createdUntil - ISO8601DateTime Only return remittances made before this date. Default = null
released - Boolean Only return remittances that are released (if value is 'true') or held (if value is 'false'). Default = null
processed - Boolean Only return remittances where a remittance advice has been generated (if value is 'true') or pending generation (if value is 'false'). Default = null
retailerIds - [ID!] Only return remittances for associated sellers. (you can supply retailerIds OR retailerBusinessNames but not both). Default = []
retailerBusinessNames - [String!] Only return remittances for sellers with these names. (you can supply retailerIds OR retailerBusinessNames but not both). Default = []
remittableType - String Only return remittances associated with invoices (if value is 'invoice') or invoice amendments (if value is 'invoice_amendment'). Default = null
invoiceIds - [ID!] Only return remittances for associated invoices. Default = null
invoiceLegacyIds - [Int!] Only return remittances for invoices with these legacy IDs. Default = null
invoiceAmendmentIds - [ID!] Only return remittances for associated invoice amendments. Default = null
invoiceAmendmentLegacyIds - [Int!] Only return remittances for invoice amendments with these legacy IDs. Default = null
pendingReasons - String Only return remittances that are unprocessed for a particular reason.Options available: 'missing_remittance_details', 'missing_hyperwallet_details', 'zero_or_negative_total_remittance_amount', 'pending_hyperwallet_verification', 'missing_xero_account', 'pending_release'. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query remittances(
  $createdSince: ISO8601DateTime,
  $createdUntil: ISO8601DateTime,
  $released: Boolean,
  $processed: Boolean,
  $retailerIds: [ID!],
  $retailerBusinessNames: [String!],
  $remittableType: String,
  $invoiceIds: [ID!],
  $invoiceLegacyIds: [Int!],
  $invoiceAmendmentIds: [ID!],
  $invoiceAmendmentLegacyIds: [Int!],
  $pendingReasons: String,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  remittances(
    createdSince: $createdSince,
    createdUntil: $createdUntil,
    released: $released,
    processed: $processed,
    retailerIds: $retailerIds,
    retailerBusinessNames: $retailerBusinessNames,
    remittableType: $remittableType,
    invoiceIds: $invoiceIds,
    invoiceLegacyIds: $invoiceLegacyIds,
    invoiceAmendmentIds: $invoiceAmendmentIds,
    invoiceAmendmentLegacyIds: $invoiceAmendmentLegacyIds,
    pendingReasons: $pendingReasons,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...RemittanceConnectionFragment
  }
}
Variables
{
  "createdSince": null,
  "createdUntil": null,
  "released": null,
  "processed": null,
  "retailerIds": [""],
  "retailerBusinessNames": [""],
  "remittableType": null,
  "invoiceIds": null,
  "invoiceLegacyIds": null,
  "invoiceAmendmentIds": null,
  "invoiceAmendmentLegacyIds": null,
  "pendingReasons": null,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "remittances": {
      "edges": [RemittanceEdge],
      "nodes": [Remittance],
      "pageInfo": PageInfo,
      "totalCount": 123,
      "totalRemittanceAmount": Money
    }
  }
}
Queries

sellerCategories

Description

List seller categories.

Response

Returns [SellerCategoryLink!]!

Example

Query
query sellerCategories {
  sellerCategories {
    ...SellerCategoryLinkFragment
  }
}
Response
{
  "data": {
    "sellerCategories": [
      {
        "categoryLabel": "xyz789",
        "categorySlug": "abc123"
      }
    ]
  }
}
Queries

sellerGeographicLocations

Description

Minimal set of attributes required for displaying and filtering Sellers on a map.

Response

Returns [SellerGeolocation!]!

Example

Query
query sellerGeographicLocations {
  sellerGeographicLocations {
    ...SellerGeolocationFragment
  }
}
Response
{
  "data": {
    "sellerGeographicLocations": [
      {
        "address": AddressGeolocation,
        "id": 4,
        "sellerCategorySlug": "xyz789"
      }
    ]
  }
}
Queries

sellerSearch

Description

Query ElasticSearch for sellers.

Response

Returns a SellerSearchResponse!

Arguments
Name Description
attributes - SellerSearchInput Query params to define which sellers to search for.
pagination - SellerSearchPaginationInput Params to define how to paginate search results.

Example

Query
query sellerSearch(
  $attributes: SellerSearchInput,
  $pagination: SellerSearchPaginationInput
) {
  sellerSearch(
    attributes: $attributes,
    pagination: $pagination
  ) {
    ...SellerSearchResponseFragment
  }
}
Variables
{
  "attributes": SellerSearchInput,
  "pagination": SellerSearchPaginationInput
}
Response
{
  "data": {
    "sellerSearch": {
      "pagination": SellerSearchPagination,
      "sellers": SellersConnection,
      "seoContent": SeoContent
    }
  }
}
Queries

sellerStats

Description

Insights & Statistics for a seller

Response

Returns a SellerStats

Arguments
Name Description
sellerId - ID ID of the seller. May be omitted if using a seller api key, but is required otherwise

Example

Query
query sellerStats($sellerId: ID) {
  sellerStats(sellerId: $sellerId) {
    ...SellerStatsFragment
  }
}
Variables
{"sellerId": 4}
Response
{
  "data": {
    "sellerStats": {
      "advertStatisticsSummary": [
        AdvertStatisticsSummary
      ],
      "id": 4,
      "remittanceSummary": RemittanceSummary,
      "salesSummaryV2": SalesSummary,
      "seller": Seller
    }
  }
}
Queries

sellersForChats

Description

Fetch sellers sorted by their latest chat messages' created timestamp. Only accessible to operator admin users.

Response

Returns a SellersForChatsConnection!

Arguments
Name Description
q - String Keywords to search for. (Currently Business Name and Legal Business Name). Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query sellersForChats(
  $q: String,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  sellersForChats(
    q: $q,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...SellersForChatsConnectionFragment
  }
}
Variables
{
  "q": null,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "sellersForChats": {
      "edges": [SellersForChatsEdge],
      "nodes": [Seller],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

sellersWhere

Description

Select sellers with the given attributes. Only sellers that match all queried fields will be returned. If no arguments are given, returns all available sellers.

Response

Returns a SellerConnection!

Arguments
Name Description
q - String Keywords to search for. (Currently Business Name, Email Address, and Legal Business Name). Default = null
retailerIds - [ID!] Filter by ID of the sellers. Default = []
slaRatingRange - SellerSlaRatingRangeInput Filter by the SLA rating range. Default = null
sort - SellersWhereSort Specifies how the list is sorted. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query sellersWhere(
  $q: String,
  $retailerIds: [ID!],
  $slaRatingRange: SellerSlaRatingRangeInput,
  $sort: SellersWhereSort,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  sellersWhere(
    q: $q,
    retailerIds: $retailerIds,
    slaRatingRange: $slaRatingRange,
    sort: $sort,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...SellerConnectionFragment
  }
}
Variables
{
  "q": null,
  "retailerIds": [""],
  "slaRatingRange": null,
  "sort": null,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "sellersWhere": {
      "edges": [SellerEdge],
      "nodes": [Seller],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

sendgridSettings

Description

SendGrid settings.

Response

Returns a SendgridSettings

Example

Query
query sendgridSettings {
  sendgridSettings {
    ...SendgridSettingsFragment
  }
}
Response
{
  "data": {
    "sendgridSettings": {
      "apiKey": "xyz789",
      "category": "RATINGS_AND_REVIEWS",
      "description": "abc123",
      "edmEnabled": true,
      "logoUrl": "xyz789",
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "status": "AVAILABLE",
      "useLegacyCampaigns": true
    }
  }
}
Queries

session

Description

Information about the current session

Response

Returns a SessionData

Example

Query
query session {
  session {
    ...SessionDataFragment
  }
}
Response
{"data": {"session": {"adminLoggedIn": false}}}
Queries

shipmentAddresses

Description

Shipment Addresses.

Response

Returns an AddresssConnection

Arguments
Name Description
sellerId - ID ID of the seller. If omitted will return all shipment addresses for marketplace.
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shipmentAddresses(
  $sellerId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shipmentAddresses(
    sellerId: $sellerId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...AddresssConnectionFragment
  }
}
Variables
{
  "sellerId": 4,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "shipmentAddresses": {
      "edges": [AddresssEdge],
      "nodes": [Address],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

shipmentCarriers

Description

Shipment Carriers.

Response

Returns a ShipmentCarrierConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shipmentCarriers(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shipmentCarriers(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ShipmentCarrierConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "shipmentCarriers": {
      "edges": [ShipmentCarrierEdge],
      "nodes": [ShipmentCarrier],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

shippingOptions

Description

Returns a collection of shipping options available on the marketplace.

Response

Returns a ShippingOptionConnection

Arguments
Name Description
sellerId - ID ID of the seller. If omitted will return all shipping rules including marketplace rules
marketplaceOnly - Boolean If true will return only marketplace rules
filters - ShippingOptionFilters Filters the list of shipping options with different criteria. Default = null
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shippingOptions(
  $sellerId: ID,
  $marketplaceOnly: Boolean,
  $filters: ShippingOptionFilters,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shippingOptions(
    sellerId: $sellerId,
    marketplaceOnly: $marketplaceOnly,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ShippingOptionConnectionFragment
  }
}
Variables
{
  "sellerId": 4,
  "marketplaceOnly": false,
  "filters": null,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "shippingOptions": {
      "edges": [ShippingOptionEdge],
      "nodes": [ShippingOption],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

shippingProfiles

Description

Returns a collection of shipping profiles available on the marketplace.

Response

Returns a ShippingProfileConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shippingProfiles(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shippingProfiles(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ShippingProfileConnectionFragment
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "shippingProfiles": {
      "edges": [ShippingProfileEdge],
      "nodes": [ShippingProfile],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

shippingRates

Description

Returns a collection of shipping rates available on the marketplace.

Response

Returns a ShippingRateConnection

Arguments
Name Description
marketplaceOnly - Boolean If true will return only marketplace rates
sellerId - ID ID of the seller. If omitted will return all shipping rates including marketplace rates
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shippingRates(
  $marketplaceOnly: Boolean,
  $sellerId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shippingRates(
    marketplaceOnly: $marketplaceOnly,
    sellerId: $sellerId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ShippingRateConnectionFragment
  }
}
Variables
{
  "marketplaceOnly": false,
  "sellerId": 4,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "shippingRates": {
      "edges": [ShippingRateEdge],
      "nodes": [ShippingRate],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

shippingZones

Description

Returns a collection of shipping zones available on the marketplace.

Response

Returns a ShippingZoneConnection

Arguments
Name Description
sellerId - ID ID of the seller. If omitted will return all shipping rules including marketplace rules
marketplaceOnly - Boolean If true, only returns marketplace shipping zones
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query shippingZones(
  $sellerId: ID,
  $marketplaceOnly: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  shippingZones(
    sellerId: $sellerId,
    marketplaceOnly: $marketplaceOnly,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...ShippingZoneConnectionFragment
  }
}
Variables
{
  "sellerId": 4,
  "marketplaceOnly": false,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "shippingZones": {
      "edges": [ShippingZoneEdge],
      "nodes": [ShippingZone],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

shippitCredentials

Description

Returns a Shippit Credentials Object for shipping settings.

Response

Returns a ShippitCredentials

Arguments
Name Description
sellerId - ID! ID of the seller. If omitted will return an error

Example

Query
query shippitCredentials($sellerId: ID!) {
  shippitCredentials(sellerId: $sellerId) {
    ...ShippitCredentialsFragment
  }
}
Variables
{"sellerId": 4}
Response
{
  "data": {
    "shippitCredentials": {
      "apiKey": "abc123",
      "enabled": true,
      "useCalculatedShipping": true
    }
  }
}
Queries

siteConfig

Description

Site configuration properties.

Response

Returns a SiteConfig!

Example

Query
query siteConfig {
  siteConfig {
    ...SiteConfigFragment
  }
}
Response
{
  "data": {
    "siteConfig": {
      "accountSettings": AccountSettings,
      "advancedRemittancesEnabled": true,
      "advertAutomapEnabled": true,
      "advertBrandLogoVisible": false,
      "advertSettings": AdvertSettings,
      "advertTileImageFormat": "PADDED",
      "advertTileImageRatio": "RATIO_1_1",
      "availableAdvertSpreadsheetColumns": [
        "xyz789"
      ],
      "betaRemittancesEnabled": false,
      "checkoutEnabled": true,
      "contactDetails": ContactDetails,
      "contactUsLink": TextLink,
      "country": SiteCountry,
      "customisationSettings": CustomisationSettings,
      "displayFavouriteStore": true,
      "externalAccountSettings": ExternalAccountSettings,
      "favouriteStore": 987,
      "financeSettings": FinanceSettings,
      "googleAnalyticsAccountIds": [
        GoogleAnalyticsTracker
      ],
      "googleMaps": GoogleMapsCredentials,
      "googleRecaptcha": GoogleRecaptchaCredentials,
      "googleTagManagerAccountId": "abc123",
      "gtagDebugMode": true,
      "gtagStreamMeasurementId": "xyz789",
      "hideAdvertTileSellerName": true,
      "id": 4,
      "liveSiblingCountries": [SiteCountry],
      "locale": "xyz789",
      "marketfacerPagesEnabled": MarketfacerPagesEnabled,
      "memberSettings": MemberSettings,
      "officialName": "xyz789",
      "productionEnvironment": false,
      "searchSettings": SearchSettings,
      "sellerMfaEnabled": true,
      "sellerMfaRequired": true,
      "showBazaarVoice": false,
      "showRetailerAddress": true,
      "siteEmail": "xyz789",
      "siteName": "xyz789",
      "sitePhone": "xyz789",
      "siteWidePromotion": Promotion,
      "siteWidePromotions": [Promotion],
      "skipConsumerEmails": false,
      "socialLinks": [SocialLink],
      "storeFront": false,
      "storeNewsletterRecipientLink": TextLink,
      "verifyViaTwilio": false,
      "verticalCode": "abc123",
      "verticalLogo": VerticalLogo,
      "wishlistEnabled": true,
      "yotpoSettings": YotpoSettingsSiteConfig
    }
  }
}
Queries

taxCodes

Description

List taxon codes.

Response

Returns [TaxCode!]!

Example

Query
query taxCodes {
  taxCodes {
    ...TaxCodeFragment
  }
}
Response
{
  "data": {
    "taxCodes": [
      {
        "code": "xyz789",
        "id": 4,
        "name": "abc123"
      }
    ]
  }
}
Queries

taxonSearch

Description

Search for Taxons.

Response

Returns a TaxonConnection!

Arguments
Name Description
searchValue - String Filter taxons where the taxon name contains the search value string. Must have a minimum of 2 characters for each search word. Default = ""
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query taxonSearch(
  $searchValue: String,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  taxonSearch(
    searchValue: $searchValue,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...TaxonConnectionFragment
  }
}
Variables
{
  "searchValue": "",
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "taxonSearch": {
      "edges": [TaxonEdge],
      "nodes": [Taxon],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

taxons

Description

List ExternalIds.

Response

Returns a TaxonsConnection!

Arguments
Name Description
parentId - ID Filter taxons that belong to to the selected parent. Default = null
showOnlineOnly - Boolean Filter taxons that have online adverts associated with them. Default = false
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query taxons(
  $parentId: ID,
  $showOnlineOnly: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  taxons(
    parentId: $parentId,
    showOnlineOnly: $showOnlineOnly,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...TaxonsConnectionFragment
  }
}
Variables
{
  "parentId": null,
  "showOnlineOnly": false,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "taxons": {
      "edges": [TaxonsEdge],
      "nodes": [Taxon],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

textQuerySuggestions

Description

Get taxon and brand suggestions for text-based search queries.

Response

Returns [TextQuerySuggestion!]!

Arguments
Name Description
query - String! Query string to be used to find text suggestions.

Example

Query
query textQuerySuggestions($query: String!) {
  textQuerySuggestions(query: $query) {
    ...TextQuerySuggestionFragment
  }
}
Variables
{"query": "xyz789"}
Response
{
  "data": {
    "textQuerySuggestions": [
      {
        "name": "abc123",
        "parentName": "xyz789",
        "slugs": [Slug]
      }
    ]
  }
}
Queries

theme

Description

Return theming attributes from AppConfig.

Response

Returns a Theme!

Example

Query
query theme {
  theme {
    ...ThemeFragment
  }
}
Response
{
  "data": {
    "theme": {
      "bodyFontFamily": "abc123",
      "brandColor": "abc123",
      "brandTextColor": "abc123",
      "ecommerceActionColor": "xyz789",
      "ecommerceActionTextColor": "xyz789",
      "fontUrl": "xyz789",
      "footerBackgroundColor": "xyz789",
      "footerLinkColor": "xyz789",
      "footerTextColor": "abc123",
      "headerBackgroundColor": "xyz789",
      "headerBorderColor": "abc123",
      "headerTextColor": "xyz789",
      "headingFontFamily": "xyz789",
      "leadActionColor": "abc123",
      "leadActionTextColor": "abc123",
      "primaryActionColor": "xyz789",
      "primaryActionTextColor": "abc123",
      "promotionBannerColor": "abc123",
      "promotionBannerTextColor": "abc123"
    }
  }
}
Queries

translations

Description

Fetch I18n translation values by key.

Response

Returns [Translation!]!

Arguments
Name Description
translations - [TranslationInput!]! Params to generate the requested translations.

Example

Query
query translations($translations: [TranslationInput!]!) {
  translations(translations: $translations) {
    ...TranslationFragment
  }
}
Variables
{"translations": [TranslationInput]}
Response
{
  "data": {
    "translations": [
      {
        "translation": "abc123",
        "translationKeyPath": "xyz789"
      }
    ]
  }
}
Queries

updatedCarts

Description

Retrieve carts that have been updated relative a certain timestamp. Either updatedSince or notUpdatedSince must be supplied. If you supply both or neither, you will get no results. . Only accessible to operator admin users.

Response

Returns an UpdatedCartsConnection!

Arguments
Name Description
updatedSince - ISO8601DateTime Only return carts which have been updated since this date
notUpdatedSince - ISO8601DateTime Only return carts which have not been updated since this date
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query updatedCarts(
  $updatedSince: ISO8601DateTime,
  $notUpdatedSince: ISO8601DateTime,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  updatedCarts(
    updatedSince: $updatedSince,
    notUpdatedSince: $notUpdatedSince,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...UpdatedCartsConnectionFragment
  }
}
Variables
{
  "updatedSince": ISO8601DateTime,
  "notUpdatedSince": ISO8601DateTime,
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "updatedCarts": {
      "edges": [UpdatedCartsEdge],
      "nodes": [Cart],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

updatedOrders

Description

Retrieve orders that have been updated after a certain date. Only accessible to operator admin users.

Response

Returns an UpdatedOrdersConnection!

Arguments
Name Description
updatedSince - ISO8601DateTime! Only return orders which have been updated since this date
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query updatedOrders(
  $updatedSince: ISO8601DateTime!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  updatedOrders(
    updatedSince: $updatedSince,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...UpdatedOrdersConnectionFragment
  }
}
Variables
{
  "updatedSince": ISO8601DateTime,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "updatedOrders": {
      "edges": [UpdatedOrdersEdge],
      "nodes": [Order],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

updatedRefundRequests

Description

Retrieve refund requests that have been updated after a certain date. Only accessible to operator and seller admin users.

Response

Returns an UpdatedRefundRequestsConnection!

Arguments
Name Description
updatedSince - ISO8601DateTime! Only return refund requests which have been updated since this date
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query updatedRefundRequests(
  $updatedSince: ISO8601DateTime!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  updatedRefundRequests(
    updatedSince: $updatedSince,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...UpdatedRefundRequestsConnectionFragment
  }
}
Variables
{
  "updatedSince": ISO8601DateTime,
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "updatedRefundRequests": {
      "edges": [UpdatedRefundRequestsEdge],
      "nodes": [RefundRequest],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

user

Description

List users.

Response

Returns a User!

Example

Query
query user {
  user {
    ...UserFragment
  }
}
Response
{
  "data": {
    "user": {
      "cartSessionId": "4",
      "emailAddress": "xyz789",
      "firstName": "abc123",
      "id": "4",
      "legacyId": 123,
      "locationData": UserLocation,
      "loggedIn": true,
      "selectedCurrency": Currency,
      "seller": Seller,
      "surname": "abc123",
      "termsAndConditionsAcceptedAt": ISO8601DateTime,
      "userAccountName": "xyz789",
      "username": "xyz789"
    }
  }
}
Queries

variantsWhere

Description

Select variants with the given attributes. Only variants that match all queried fields will be returned. If no arguments are given, returns an empty response. Only accessible to operator and seller admin users.

Response

Returns a VariantConnection!

Arguments
Name Description
advertFilters - AdvertFilterInput
variantFilters - VariantFilterInput
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query variantsWhere(
  $advertFilters: AdvertFilterInput,
  $variantFilters: VariantFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  variantsWhere(
    advertFilters: $advertFilters,
    variantFilters: $variantFilters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...VariantConnectionFragment
  }
}
Variables
{
  "advertFilters": AdvertFilterInput,
  "variantFilters": VariantFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "variantsWhere": {
      "edges": [VariantEdge],
      "nodes": [Variant],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

webhookEvents

Description

Returns the webhook events associated to webhooks.

Response

Returns a WebhookEventsConnection

Arguments
Name Description
webhookId - ID ID of the webhook, if not provided then all webhook events are returned, ordered by updated_at timestamp
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query webhookEvents(
  $webhookId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  webhookEvents(
    webhookId: $webhookId,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...WebhookEventsConnectionFragment
  }
}
Variables
{
  "webhookId": 4,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "webhookEvents": {
      "edges": [WebhookEventsEdge],
      "nodes": [WebhookEvent],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

webhooks

Description

Returns the webhooks linked to marketplacer events.

Response

Returns a WebhooksConnection

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query webhooks(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  webhooks(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    ...WebhooksConnectionFragment
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "webhooks": {
      "edges": [WebhooksEdge],
      "nodes": [Webhook],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

yotpoSettings

Description

Yotpo settings

Response

Returns a YotpoSettings

Example

Query
query yotpoSettings {
  yotpoSettings {
    ...YotpoSettingsFragment
  }
}
Response
{
  "data": {
    "yotpoSettings": {
      "category": "RATINGS_AND_REVIEWS",
      "description": "xyz789",
      "displayWidgetAdvertPageEnabled": false,
      "displayWidgetSearchPageEnabled": true,
      "displayWidgetShopPageEnabled": false,
      "id": 4,
      "logoUrl": "xyz789",
      "orderCreateForProductsOnCheckoutEnabled": true,
      "orderCreateForSellersOnCheckoutEnabled": true,
      "productSyncEnabled": false,
      "providerHandle": "abc123",
      "providerName": "abc123",
      "secretKey": "xyz789",
      "sellerSyncEnabled": true,
      "status": "AVAILABLE",
      "storeId": "xyz789"
    }
  }
}
Queries

zipSettings

Description

Zip settings

Response

Returns a ZipSettings

Example

Query
query zipSettings {
  zipSettings {
    ...ZipSettingsFragment
  }
}
Response
{
  "data": {
    "zipSettings": {
      "category": "RATINGS_AND_REVIEWS",
      "customMerchantBaseFeeCents": 987,
      "customMerchantBaseFeeFormatted": "abc123",
      "customMerchantFee": 987.65,
      "description": "xyz789",
      "logoUrl": "abc123",
      "merchantApiKey": "abc123",
      "merchantPublicKey": "abc123",
      "overrideCustomMerchantFee": true,
      "providerHandle": "xyz789",
      "providerName": "abc123",
      "status": "AVAILABLE",
      "zipEnabled": false
    }
  }
}
Queries

zoozSettings

Description

Zooz settings

Response

Returns a ZoozSettings

Example

Query
query zoozSettings {
  zoozSettings {
    ...ZoozSettingsFragment
  }
}
Response
{
  "data": {
    "zoozSettings": {
      "appId": "abc123",
      "balotoPaymentMethod": "4",
      "bankReferencedPaymentMethod": "4",
      "bankTransferPaymentMethod": "4",
      "category": "RATINGS_AND_REVIEWS",
      "creditCardPaymentMethod": 4,
      "customMerchantBaseFeeCents": 987,
      "customMerchantBaseFeeFormatted": "xyz789",
      "customMerchantFee": 987.65,
      "description": "xyz789",
      "efectyPaymentMethod": 4,
      "logoUrl": "abc123",
      "overrideCustomMerchantFee": true,
      "payUApiKey": "abc123",
      "payUApiLogin": "xyz789",
      "pendingPaymentConfirmationPageUrl": "xyz789",
      "privateKey": "xyz789",
      "providerHandle": "xyz789",
      "providerName": "xyz789",
      "publicKey": "abc123",
      "status": "AVAILABLE",
      "suRedPaymentMethod": 4
    }
  }
}

Mutations

activityLogDownload

Description

start a background job to download activity log data. Only accessible to operator admin users.

Response

Returns an ActivityLogDownloadMutationPayload

Arguments
Name Description
input - ActivityLogDownloadMutationInput! Parameters for ActivityLogDownloadMutation

Example

Query
mutation activityLogDownload($input: ActivityLogDownloadMutationInput!) {
  activityLogDownload(input: $input) {
    ...ActivityLogDownloadMutationPayloadFragment
  }
}
Variables
{"input": ActivityLogDownloadMutationInput}
Response
{
  "data": {
    "activityLogDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 123
    }
  }
}
Mutations

adminLoginUsername

Description

Initiate a username/password login for an administrator.

May return a session token (in which case no further action is required to complete the login, and the session token can be used as an API key until it expires).

May also return one or more multi-factor authentication (MFA) challenges. If it does, at least one MFA challenge needs to be successfully responded to in order to get the session token.

NOTE: MFA Challenge is not yet implemented in this login, so if it is required, an error will be returned.

Response

Returns an AdminLoginUsernameMutationPayload

Arguments
Name Description
input - AdminLoginUsernameMutationInput! Parameters for AdminLoginUsernameMutation

Example

Query
mutation adminLoginUsername($input: AdminLoginUsernameMutationInput!) {
  adminLoginUsername(input: $input) {
    ...AdminLoginUsernameMutationPayloadFragment
  }
}
Variables
{"input": AdminLoginUsernameMutationInput}
Response
{
  "data": {
    "adminLoginUsername": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "sessionToken": "abc123",
      "status": 123
    }
  }
}
Mutations

adminRoleCreate

Description

Create an Admin Role. Only accessible to operator admin users.

Response

Returns an AdminRoleCreateMutationPayload

Arguments
Name Description
input - AdminRoleCreateMutationInput! Parameters for AdminRoleCreateMutation

Example

Query
mutation adminRoleCreate($input: AdminRoleCreateMutationInput!) {
  adminRoleCreate(input: $input) {
    ...AdminRoleCreateMutationPayloadFragment
  }
}
Variables
{"input": AdminRoleCreateMutationInput}
Response
{
  "data": {
    "adminRoleCreate": {
      "adminRole": AdminRole,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

adminRoleDelete

Description

Delete an Admin Role. Only accessible to operator admin users.

Response

Returns an AdminRoleDeleteMutationPayload

Arguments
Name Description
input - AdminRoleDeleteMutationInput! Parameters for AdminRoleDeleteMutation

Example

Query
mutation adminRoleDelete($input: AdminRoleDeleteMutationInput!) {
  adminRoleDelete(input: $input) {
    ...AdminRoleDeleteMutationPayloadFragment
  }
}
Variables
{"input": AdminRoleDeleteMutationInput}
Response
{
  "data": {
    "adminRoleDelete": {
      "adminRole": AdminRole,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

adminRoleUpdate

Description

Update an Admin Role. Only accessible to operator admin users.

Response

Returns an AdminRoleUpdateMutationPayload

Arguments
Name Description
input - AdminRoleUpdateMutationInput! Parameters for AdminRoleUpdateMutation

Example

Query
mutation adminRoleUpdate($input: AdminRoleUpdateMutationInput!) {
  adminRoleUpdate(input: $input) {
    ...AdminRoleUpdateMutationPayloadFragment
  }
}
Variables
{"input": AdminRoleUpdateMutationInput}
Response
{
  "data": {
    "adminRoleUpdate": {
      "adminRole": AdminRole,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

advertDelete

Description

Mark an existing advert as deleted. Only accessible to operator and seller admin users.

Response

Returns an AdvertDeleteMutationPayload

Arguments
Name Description
input - AdvertDeleteMutationInput! Parameters for AdvertDeleteMutation

Example

Query
mutation advertDelete($input: AdvertDeleteMutationInput!) {
  advertDelete(input: $input) {
    ...AdvertDeleteMutationPayloadFragment
  }
}
Variables
{"input": AdvertDeleteMutationInput}
Response
{
  "data": {
    "advertDelete": {
      "advert": Advert,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

advertPublishedUpdate

Description

Updates the advert's published status. Only accessible to operator and seller admin users.

Response

Returns an AdvertPublishedUpdateMutationPayload

Arguments
Name Description
input - AdvertPublishedUpdateMutationInput! Parameters for AdvertPublishedUpdateMutation

Example

Query
mutation advertPublishedUpdate($input: AdvertPublishedUpdateMutationInput!) {
  advertPublishedUpdate(input: $input) {
    ...AdvertPublishedUpdateMutationPayloadFragment
  }
}
Variables
{"input": AdvertPublishedUpdateMutationInput}
Response
{
  "data": {
    "advertPublishedUpdate": {
      "advert": Advert,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

advertSpreadsheetConfirmImport

Description

start a background job to import adverts. Only accessible to operator and seller admin users.

Response

Returns an AdvertSpreadsheetConfirmImportMutationPayload

Arguments
Name Description
input - AdvertSpreadsheetConfirmImportMutationInput! Parameters for AdvertSpreadsheetConfirmImportMutation

Example

Query
mutation advertSpreadsheetConfirmImport($input: AdvertSpreadsheetConfirmImportMutationInput!) {
  advertSpreadsheetConfirmImport(input: $input) {
    ...AdvertSpreadsheetConfirmImportMutationPayloadFragment
  }
}
Variables
{"input": AdvertSpreadsheetConfirmImportMutationInput}
Response
{
  "data": {
    "advertSpreadsheetConfirmImport": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "import": ImportExport,
      "status": 123
    }
  }
}
Mutations

advertSpreadsheetDownload

Description

start a background job to download adverts. Only accessible to operator and seller admin users.

Response

Returns an AdvertSpreadsheetDownloadMutationPayload

Arguments
Name Description
input - AdvertSpreadsheetDownloadMutationInput! Parameters for AdvertSpreadsheetDownloadMutation

Example

Query
mutation advertSpreadsheetDownload($input: AdvertSpreadsheetDownloadMutationInput!) {
  advertSpreadsheetDownload(input: $input) {
    ...AdvertSpreadsheetDownloadMutationPayloadFragment
  }
}
Variables
{"input": AdvertSpreadsheetDownloadMutationInput}
Response
{
  "data": {
    "advertSpreadsheetDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 987
    }
  }
}
Mutations

advertSpreadsheetUpload

Description

start a background job to upload adverts. Only accessible to operator and seller admin users.

Response

Returns an AdvertSpreadsheetUploadMutationPayload

Arguments
Name Description
input - AdvertSpreadsheetUploadMutationInput! Parameters for AdvertSpreadsheetUploadMutation

Example

Query
mutation advertSpreadsheetUpload($input: AdvertSpreadsheetUploadMutationInput!) {
  advertSpreadsheetUpload(input: $input) {
    ...AdvertSpreadsheetUploadMutationPayloadFragment
  }
}
Variables
{"input": AdvertSpreadsheetUploadMutationInput}
Response
{
  "data": {
    "advertSpreadsheetUpload": {
      "advertCount": 987,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "import": ImportExport,
      "status": 987,
      "variantCount": 987
    }
  }
}
Mutations

advertUpsert

Description

Create an Advert if no ID is passed, otherwise updates existing Advert. Only accessible to operator and seller admin users.

Response

Returns an AdvertUpsertMutationPayload

Arguments
Name Description
input - AdvertUpsertMutationInput! Parameters for AdvertUpsertMutation

Example

Query
mutation advertUpsert($input: AdvertUpsertMutationInput!) {
  advertUpsert(input: $input) {
    ...AdvertUpsertMutationPayloadFragment
  }
}
Variables
{"input": AdvertUpsertMutationInput}
Response
{
  "data": {
    "advertUpsert": {
      "advert": Advert,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

advertVettingApprove

Description

Bulk approves products via vetting. Only accessible to operator admin users.

Response

Returns an AdvertVettingApproveMutationPayload

Arguments
Name Description
input - AdvertVettingApproveInput!

Example

Query
mutation advertVettingApprove($input: AdvertVettingApproveInput!) {
  advertVettingApprove(input: $input) {
    ...AdvertVettingApproveMutationPayloadFragment
  }
}
Variables
{"input": AdvertVettingApproveInput}
Response
{
  "data": {
    "advertVettingApprove": {
      "adverts": AdvertsConnection,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

advertVettingReject

Description

Bulk rejects products via vetting. Only accessible to operator admin users.

Response

Returns an AdvertVettingRejectMutationPayload

Arguments
Name Description
input - AdvertVettingRejectInput!

Example

Query
mutation advertVettingReject($input: AdvertVettingRejectInput!) {
  advertVettingReject(input: $input) {
    ...AdvertVettingRejectMutationPayloadFragment
  }
}
Variables
{"input": AdvertVettingRejectInput}
Response
{
  "data": {
    "advertVettingReject": {
      "adverts": AdvertsConnection,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

advertVettingResubmit

Description

Bulk resubmit adverts for vetting. Only accessible to operator and seller admin users.

Response

Returns an AdvertVettingResubmitMutationPayload

Arguments
Name Description
input - AdvertVettingResubmitInput!

Example

Query
mutation advertVettingResubmit($input: AdvertVettingResubmitInput!) {
  advertVettingResubmit(input: $input) {
    ...AdvertVettingResubmitMutationPayloadFragment
  }
}
Variables
{"input": AdvertVettingResubmitInput}
Response
{
  "data": {
    "advertVettingResubmit": {
      "adverts": AdvertsConnection,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

adyenSettingsCreateOrUpdate

Description

Create or update Adyen settings. Only accessible to operator admin users.

Response

Returns an AdyenSettingsCreateOrUpdateMutationPayload

Arguments
Name Description
input - AdyenSettingsCreateOrUpdateMutationInput! Parameters for AdyenSettingsCreateOrUpdateMutation

Example

Query
mutation adyenSettingsCreateOrUpdate($input: AdyenSettingsCreateOrUpdateMutationInput!) {
  adyenSettingsCreateOrUpdate(input: $input) {
    ...AdyenSettingsCreateOrUpdateMutationPayloadFragment
  }
}
Variables
{"input": AdyenSettingsCreateOrUpdateMutationInput}
Response
{
  "data": {
    "adyenSettingsCreateOrUpdate": {
      "adyenBillingSettings": AdyenBillingSettings,
      "adyenEcommerceSettings": AdyenEcommerceSettings,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

adyenSettingsDelete

Description

Delete Adyen settings. Only accessible to operator admin users.

Response

Returns an AdyenSettingsDeleteMutationPayload

Arguments
Name Description
input - AdyenSettingsDeleteMutationInput! Parameters for AdyenSettingsDeleteMutation

Example

Query
mutation adyenSettingsDelete($input: AdyenSettingsDeleteMutationInput!) {
  adyenSettingsDelete(input: $input) {
    ...AdyenSettingsDeleteMutationPayloadFragment
  }
}
Variables
{"input": AdyenSettingsDeleteMutationInput}
Response
{
  "data": {
    "adyenSettingsDelete": {
      "adyenBillingSettings": AdyenBillingSettings,
      "adyenEcommerceSettings": AdyenEcommerceSettings,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

afterpaySettingsCreateOrUpdate

Description

Create or update Afterpay settings. Only accessible to operator admin users.

Response

Returns an AfterpaySettingsCreateOrUpdateMutationPayload

Arguments
Name Description
input - AfterpaySettingsCreateOrUpdateMutationInput! Parameters for AfterpaySettingsCreateOrUpdateMutation

Example

Query
mutation afterpaySettingsCreateOrUpdate($input: AfterpaySettingsCreateOrUpdateMutationInput!) {
  afterpaySettingsCreateOrUpdate(input: $input) {
    ...AfterpaySettingsCreateOrUpdateMutationPayloadFragment
  }
}
Variables
{"input": AfterpaySettingsCreateOrUpdateMutationInput}
Response
{
  "data": {
    "afterpaySettingsCreateOrUpdate": {
      "afterpaySettings": AfterpaySettings,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

afterpaySettingsDelete

Description

Delete Afterpay settings. Only accessible to operator admin users.

Response

Returns an AfterpaySettingsDeleteMutationPayload

Arguments
Name Description
input - AfterpaySettingsDeleteMutationInput! Parameters for AfterpaySettingsDeleteMutation

Example

Query
mutation afterpaySettingsDelete($input: AfterpaySettingsDeleteMutationInput!) {
  afterpaySettingsDelete(input: $input) {
    ...AfterpaySettingsDeleteMutationPayloadFragment
  }
}
Variables
{"input": AfterpaySettingsDeleteMutationInput}
Response
{
  "data": {
    "afterpaySettingsDelete": {
      "afterpaySettings": AfterpaySettings,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

attemptBillingInvoicePayment

Description

Attempt a payment in Billing Invoice. Only accessible to operator and seller admin users.

Response

Returns an AttemptBillingInvoicePaymentMutationPayload

Arguments
Name Description
input - AttemptBillingInvoicePaymentMutationInput! Parameters for AttemptBillingInvoicePaymentMutation

Example

Query
mutation attemptBillingInvoicePayment($input: AttemptBillingInvoicePaymentMutationInput!) {
  attemptBillingInvoicePayment(input: $input) {
    ...AttemptBillingInvoicePaymentMutationPayloadFragment
  }
}
Variables
{"input": AttemptBillingInvoicePaymentMutationInput}
Response
{
  "data": {
    "attemptBillingInvoicePayment": {
      "billing": Billing,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

billingHistoryDownload

Description

start a background job to download billing history. Only accessible to operator and seller admin users.

Response

Returns a BillingHistoryDownloadMutationPayload

Arguments
Name Description
input - BillingHistoryDownloadMutationInput! Parameters for BillingHistoryDownloadMutation

Example

Query
mutation billingHistoryDownload($input: BillingHistoryDownloadMutationInput!) {
  billingHistoryDownload(input: $input) {
    ...BillingHistoryDownloadMutationPayloadFragment
  }
}
Variables
{"input": BillingHistoryDownloadMutationInput}
Response
{
  "data": {
    "billingHistoryDownload": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 123
    }
  }
}
Mutations

braintreeSettingsCreateOrUpdate

Description

Create or update Braintree settings. Only accessible to operator admin users.

Response

Returns a BraintreeSettingsCreateOrUpdateMutationPayload

Arguments
Name Description
input - BraintreeSettingsCreateOrUpdateMutationInput! Parameters for BraintreeSettingsCreateOrUpdateMutation

Example

Query
mutation braintreeSettingsCreateOrUpdate($input: BraintreeSettingsCreateOrUpdateMutationInput!) {
  braintreeSettingsCreateOrUpdate(input: $input) {
    ...BraintreeSettingsCreateOrUpdateMutationPayloadFragment
  }
}
Variables
{"input": BraintreeSettingsCreateOrUpdateMutationInput}
Response
{
  "data": {
    "braintreeSettingsCreateOrUpdate": {
      "braintreeBillingSettings": BraintreeBillingSettings,
      "braintreeEcommerceSettings": BraintreeEcommerceSettings,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

braintreeSettingsDelete

Description

Delete Braintree settings. Only accessible to operator admin users.

Response

Returns a BraintreeSettingsDeleteMutationPayload

Arguments
Name Description
input - BraintreeSettingsDeleteMutationInput! Parameters for BraintreeSettingsDeleteMutation

Example

Query
mutation braintreeSettingsDelete($input: BraintreeSettingsDeleteMutationInput!) {
  braintreeSettingsDelete(input: $input) {
    ...BraintreeSettingsDeleteMutationPayloadFragment
  }
}
Variables
{"input": BraintreeSettingsDeleteMutationInput}
Response
{
  "data": {
    "braintreeSettingsDelete": {
      "braintreeBillingSettings": BraintreeBillingSettings,
      "braintreeEcommerceSettings": BraintreeEcommerceSettings,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

cancelBillingInvoice

Description

Cancel a billing record. Only accessible to operator and seller admin users.

Response

Returns a CancelBillingInvoiceMutationPayload

Arguments
Name Description
input - CancelBillingInvoiceMutationInput! Parameters for CancelBillingInvoiceMutation

Example

Query
mutation cancelBillingInvoice($input: CancelBillingInvoiceMutationInput!) {
  cancelBillingInvoice(input: $input) {
    ...CancelBillingInvoiceMutationPayloadFragment
  }
}
Variables
{"input": CancelBillingInvoiceMutationInput}
Response
{
  "data": {
    "cancelBillingInvoice": {
      "billing": Billing,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

cartAddCartItem

Description

Add an item to a order. Currently only supports product variants.

Response

Returns a CartAddCartItemMutationPayload

Arguments
Name Description
input - CartAddCartItemMutationInput! Parameters for CartAddCartItemMutation

Example

Query
mutation cartAddCartItem($input: CartAddCartItemMutationInput!) {
  cartAddCartItem(input: $input) {
    ...CartAddCartItemMutationPayloadFragment
  }
}
Variables
{"input": CartAddCartItemMutationInput}
Response
{
  "data": {
    "cartAddCartItem": {
      "cart": Cart,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

cartAddItem

Description

Add an item to current session cart. Only supports product variants.

Response

Returns a CartAddItemMutationPayload

Arguments
Name Description
input - CartAddItemMutationInput! Parameters for CartAddItemMutation

Example

Query
mutation cartAddItem($input: CartAddItemMutationInput!) {
  cartAddItem(input: $input) {
    ...CartAddItemMutationPayloadFragment
  }
}
Variables
{"input": CartAddItemMutationInput}
Response
{
  "data": {
    "cartAddItem": {
      "cart": Cart,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

cartCheckout

Description

Checkout a cart using the cart ID. This checkout can be used with Braintree payment provider and can only be used if Braintree is set up on the marketplace. Will receive order once cart has been processed successfully.

Response

Returns a CartCheckoutMutationPayload

Arguments
Name Description
input - CartCheckoutMutationInput! Parameters for CartCheckoutMutation

Example

Query
mutation cartCheckout($input: CartCheckoutMutationInput!) {
  cartCheckout(input: $input) {
    ...CartCheckoutMutationPayloadFragment
  }
}
Variables
{"input": CartCheckoutMutationInput}
Response
{
  "data": {
    "cartCheckout": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "order": Order,
      "redirectUrl": "abc123",
      "status": 987
    }
  }
}
Mutations

cartCreate

Description

Create a mutable cart to keep track of items that a user maybe wants to purchase.

Response

Returns a CartCreateMutationPayload

Arguments
Name Description
input - CartCreateMutationInput! Parameters for CartCreateMutation

Example

Query
mutation cartCreate($input: CartCreateMutationInput!) {
  cartCreate(input: $input) {
    ...CartCreateMutationPayloadFragment
  }
}
Variables
{"input": CartCreateMutationInput}
Response
{
  "data": {
    "cartCreate": {
      "cart": Cart,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

cartDelete

Description

Delete a cart.

Response

Returns a CartDeleteMutationPayload

Arguments
Name Description
input - CartDeleteMutationInput! Parameters for CartDeleteMutation

Example

Query
mutation cartDelete($input: CartDeleteMutationInput!) {
  cartDelete(input: $input) {
    ...CartDeleteMutationPayloadFragment
  }
}
Variables
{"input": CartDeleteMutationInput}
Response
{
  "data": {
    "cartDelete": {
      "cart": Cart,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

cartRemoveCartItem

Description

Remove a line item from a cart.

Response

Returns a CartRemoveCartItemMutationPayload

Arguments
Name Description
input - CartRemoveCartItemMutationInput! Parameters for CartRemoveCartItemMutation

Example

Query
mutation cartRemoveCartItem($input: CartRemoveCartItemMutationInput!) {
  cartRemoveCartItem(input: $input) {
    ...CartRemoveCartItemMutationPayloadFragment
  }
}
Variables
{"input": CartRemoveCartItemMutationInput}
Response
{
  "data": {
    "cartRemoveCartItem": {
      "cart": Cart,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

cartUpdate

Description

Update a mutable cart to keep track of items that a user maybe wants to purchase.

Response

Returns a CartUpdateMutationPayload

Arguments
Name Description
input - CartUpdateMutationInput! Parameters for CartUpdateMutation

Example

Query
mutation cartUpdate($input: CartUpdateMutationInput!) {
  cartUpdate(input: $input) {
    ...CartUpdateMutationPayloadFragment
  }
}
Variables
{"input": CartUpdateMutationInput}
Response
{
  "data": {
    "cartUpdate": {
      "cart": Cart,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

cartUpdateCartItem

Description

Update cart item details for a cart.

Response

Returns a CartUpdateCartItemMutationPayload

Arguments
Name Description
input - CartUpdateCartItemMutationInput! Parameters for CartUpdateCartItemMutation

Example

Query
mutation cartUpdateCartItem($input: CartUpdateCartItemMutationInput!) {
  cartUpdateCartItem(input: $input) {
    ...CartUpdateCartItemMutationPayloadFragment
  }
}
Variables
{"input": CartUpdateCartItemMutationInput}
Response
{
  "data": {
    "cartUpdateCartItem": {
      "cart": Cart,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

catalogRuleCreate

Description

Create a Catalog Rule. Only accessible to operator admin users.

Response

Returns a CatalogRuleCreateMutationPayload

Arguments
Name Description
input - CatalogRuleCreateMutationInput! Parameters for CatalogRuleCreateMutation

Example

Query
mutation catalogRuleCreate($input: CatalogRuleCreateMutationInput!) {
  catalogRuleCreate(input: $input) {
    ...CatalogRuleCreateMutationPayloadFragment
  }
}
Variables
{"input": CatalogRuleCreateMutationInput}
Response
{
  "data": {
    "catalogRuleCreate": {
      "catalogRule": CatalogRule,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

catalogRuleDelete

Description

Delete a Catalog rule. Only accessible to operator admin users.

Response

Returns a CatalogRuleDeleteMutationPayload

Arguments
Name Description
input - CatalogRuleDeleteMutationInput! Parameters for CatalogRuleDeleteMutation

Example

Query
mutation catalogRuleDelete($input: CatalogRuleDeleteMutationInput!) {
  catalogRuleDelete(input: $input) {
    ...CatalogRuleDeleteMutationPayloadFragment
  }
}
Variables
{"input": CatalogRuleDeleteMutationInput}
Response
{
  "data": {
    "catalogRuleDelete": {
      "catalogRule": CatalogRule,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

catalogRuleUpdate

Description

Update a Catalog Rule. Only accessible to operator admin users.

Response

Returns a CatalogRuleUpdateMutationPayload

Arguments
Name Description
input - CatalogRuleUpdateMutationInput! Parameters for CatalogRuleUpdateMutation

Example

Query
mutation catalogRuleUpdate($input: CatalogRuleUpdateMutationInput!) {
  catalogRuleUpdate(input: $input) {
    ...CatalogRuleUpdateMutationPayloadFragment
  }
}
Variables
{"input": CatalogRuleUpdateMutationInput}
Response
{
  "data": {
    "catalogRuleUpdate": {
      "catalogRule": CatalogRule,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

chatMessageCreate

Description

Create a chat message between operator and seller. Only accessible to operator and seller admin users.

Response

Returns a ChatMessageCreateMutationPayload

Arguments
Name Description
input - ChatMessageCreateMutationInput! Parameters for ChatMessageCreateMutation

Example

Query
mutation chatMessageCreate($input: ChatMessageCreateMutationInput!) {
  chatMessageCreate(input: $input) {
    ...ChatMessageCreateMutationPayloadFragment
  }
}
Variables
{"input": ChatMessageCreateMutationInput}
Response
{
  "data": {
    "chatMessageCreate": {
      "chatMessage": ChatMessage,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

chatMessageRead

Description

Mark a chat message as read. Only accessible to operator and seller admin users.

Response

Returns a ChatMessageReadMutationPayload

Arguments
Name Description
input - ChatMessageReadMutationInput! Parameters for ChatMessageReadMutation

Example

Query
mutation chatMessageRead($input: ChatMessageReadMutationInput!) {
  chatMessageRead(input: $input) {
    ...ChatMessageReadMutationPayloadFragment
  }
}
Variables
{"input": ChatMessageReadMutationInput}
Response
{
  "data": {
    "chatMessageRead": {
      "chatMessage": ChatMessage,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

clickAndCollectStatusUpdate

Description

Updates status of invoice that have click_and_collect delivery type. Only accessible to operator and seller admin users.

Response

Returns a ClickAndCollectStatusUpdateMutationPayload

Arguments
Name Description
input - ClickAndCollectStatusUpdateMutationInput! Parameters for ClickAndCollectStatusUpdateMutation

Example

Query
mutation clickAndCollectStatusUpdate($input: ClickAndCollectStatusUpdateMutationInput!) {
  clickAndCollectStatusUpdate(input: $input) {
    ...ClickAndCollectStatusUpdateMutationPayloadFragment
  }
}
Variables
{"input": ClickAndCollectStatusUpdateMutationInput}
Response
{
  "data": {
    "clickAndCollectStatusUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "invoice": Invoice,
      "status": 123
    }
  }
}
Mutations

commissionPackageCreate

Description

Create a Commission Package. Only accessible to operator admin users.

Response

Returns a CommissionPackageCreateMutationPayload

Arguments
Name Description
input - CommissionPackageCreateMutationInput! Parameters for CommissionPackageCreateMutation

Example

Query
mutation commissionPackageCreate($input: CommissionPackageCreateMutationInput!) {
  commissionPackageCreate(input: $input) {
    ...CommissionPackageCreateMutationPayloadFragment
  }
}
Variables
{"input": CommissionPackageCreateMutationInput}
Response
{
  "data": {
    "commissionPackageCreate": {
      "clientMutationId": "xyz789",
      "commissionPackage": CommissionPackage,
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

commissionPackageDelete

Description

Mark an existing commission package as deleted. Only accessible to operator admin users.

Response

Returns a CommissionPackageDeleteMutationPayload

Arguments
Name Description
input - CommissionPackageDeleteMutationInput! Parameters for CommissionPackageDeleteMutation

Example

Query
mutation commissionPackageDelete($input: CommissionPackageDeleteMutationInput!) {
  commissionPackageDelete(input: $input) {
    ...CommissionPackageDeleteMutationPayloadFragment
  }
}
Variables
{"input": CommissionPackageDeleteMutationInput}
Response
{
  "data": {
    "commissionPackageDelete": {
      "clientMutationId": "abc123",
      "commissionPackage": CommissionPackage,
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

commissionPackageScheduleDelete

Description

Delete an existing commission package schedule. Only accessible to operator admin users.

Response

Returns a CommissionPackageScheduleDeleteMutationPayload

Arguments
Name Description
input - CommissionPackageScheduleDeleteMutationInput! Parameters for CommissionPackageScheduleDeleteMutation

Example

Query
mutation commissionPackageScheduleDelete($input: CommissionPackageScheduleDeleteMutationInput!) {
  commissionPackageScheduleDelete(input: $input) {
    ...CommissionPackageScheduleDeleteMutationPayloadFragment
  }
}
Variables
{"input": CommissionPackageScheduleDeleteMutationInput}
Response
{
  "data": {
    "commissionPackageScheduleDelete": {
      "clientMutationId": "abc123",
      "commissionPackageSchedule": CommissionPackageSchedule,
      "errors": [ValidationError],
      "status": 987
    }
  }
}
Mutations

commissionPackageScheduleSpreadsheetDownload

Description

Start a background job to download a commission package schedule. Only accessible to operator admin users.

Response

Returns a CommissionPackageScheduleSpreadsheetDownloadMutationPayload

Arguments
Name Description
input - CommissionPackageScheduleSpreadsheetDownloadMutationInput! Parameters for CommissionPackageScheduleSpreadsheetDownloadMutation

Example

Query
mutation commissionPackageScheduleSpreadsheetDownload($input: CommissionPackageScheduleSpreadsheetDownloadMutationInput!) {
  commissionPackageScheduleSpreadsheetDownload(input: $input) {
    ...CommissionPackageScheduleSpreadsheetDownloadMutationPayloadFragment
  }
}
Variables
{
  "input": CommissionPackageScheduleSpreadsheetDownloadMutationInput
}
Response
{
  "data": {
    "commissionPackageScheduleSpreadsheetDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExportCommissionPackageSchedule,
      "status": 987
    }
  }
}
Mutations

commissionPackageScheduleSpreadsheetUpload

Description

Start a background job to upload a commission package schedule. Only accessible to operator admin users.

Response

Returns a CommissionPackageScheduleSpreadsheetUploadMutationPayload

Arguments
Name Description
input - CommissionPackageScheduleSpreadsheetUploadMutationInput! Parameters for CommissionPackageScheduleSpreadsheetUploadMutation

Example

Query
mutation commissionPackageScheduleSpreadsheetUpload($input: CommissionPackageScheduleSpreadsheetUploadMutationInput!) {
  commissionPackageScheduleSpreadsheetUpload(input: $input) {
    ...CommissionPackageScheduleSpreadsheetUploadMutationPayloadFragment
  }
}
Variables
{
  "input": CommissionPackageScheduleSpreadsheetUploadMutationInput
}
Response
{
  "data": {
    "commissionPackageScheduleSpreadsheetUpload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "import": ImportExportCommissionPackageSchedule,
      "status": 987
    }
  }
}
Mutations

commissionPackageUpdate

Description

Update a commission package. Only accessible to operator admin users.

Response

Returns a CommissionPackageUpdateMutationPayload

Arguments
Name Description
input - CommissionPackageUpdateMutationInput! Parameters for CommissionPackageUpdateMutation

Example

Query
mutation commissionPackageUpdate($input: CommissionPackageUpdateMutationInput!) {
  commissionPackageUpdate(input: $input) {
    ...CommissionPackageUpdateMutationPayloadFragment
  }
}
Variables
{"input": CommissionPackageUpdateMutationInput}
Response
{
  "data": {
    "commissionPackageUpdate": {
      "clientMutationId": "abc123",
      "commissionPackage": CommissionPackage,
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

customFieldCreateOrUpdate

Description

Creates a CustomField if no ID is passed, otherwise updates existing CustomField (note: CustomFieldGroup must be created prior to creating CustomField). Only accessible to operator admin users.

Response

Returns a CustomFieldCreateOrUpdateMutationPayload

Arguments
Name Description
input - CustomFieldCreateOrUpdateMutationInput! Parameters for CustomFieldCreateOrUpdateMutation

Example

Query
mutation customFieldCreateOrUpdate($input: CustomFieldCreateOrUpdateMutationInput!) {
  customFieldCreateOrUpdate(input: $input) {
    ...CustomFieldCreateOrUpdateMutationPayloadFragment
  }
}
Variables
{"input": CustomFieldCreateOrUpdateMutationInput}
Response
{
  "data": {
    "customFieldCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "customField": CustomField,
      "errors": [ValidationError],
      "status": 123
    }
  }
}
Mutations

customFieldDelete

Description

Deletes an existing CustomField. Only accessible to operator admin users.

Response

Returns a CustomFieldDeleteMutationPayload

Arguments
Name Description
input - CustomFieldDeleteMutationInput! Parameters for CustomFieldDeleteMutation

Example

Query
mutation customFieldDelete($input: CustomFieldDeleteMutationInput!) {
  customFieldDelete(input: $input) {
    ...CustomFieldDeleteMutationPayloadFragment
  }
}