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

`footer`

Description

Site footer data.

Response

Returns a Footer!

Example

Query

query footer {
  footer {
    ...FooterFragment
  }
}

Response

{
  "data": {
    "footer": {
      "columns": [FooterColumn],
      "edmSubscriptionEnabled": true,
      "id": "4",
      "showLegalInfo": false
    }
  }
}

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

`thirdPartyLoginLinks`

Description

Third-party login links

Response

Returns a ThirdPartyLoginLinkConnection!

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.
`scope` - `ThirdPartyLoginLinkScopeEnum!`	What kind of login provider?

Example

Query

query thirdPartyLoginLinks(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $scope: ThirdPartyLoginLinkScopeEnum!
) {
  thirdPartyLoginLinks(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    scope: $scope
  ) {
    ...ThirdPartyLoginLinkConnectionFragment
  }
}

Variables

{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 987,
  "scope": "OPERATOR"
}

Response

{
  "data": {
    "thirdPartyLoginLinks": {
      "edges": [ThirdPartyLoginLinkEdge],
      "nodes": [ThirdPartyLoginLink],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

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
  }
}

Variables

{"input": CustomFieldDeleteMutationInput}

Response

{
  "data": {
    "customFieldDelete": {
      "clientMutationId": "xyz789",
      "customField": CustomField,
      "errors": [ValidationError],
      "status": 987
    }
  }
}

Mutations

`customFieldGroupCreateOrUpdate`

Description

Creates a CustomFieldGroup if no ID is passed, otherwise updates existing CustomFieldGroup. Only accessible to operator admin users.

Response

Returns a CustomFieldGroupCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `CustomFieldGroupCreateOrUpdateMutationInput!`	Parameters for CustomFieldGroupCreateOrUpdateMutation

Example

Query

mutation customFieldGroupCreateOrUpdate($input: CustomFieldGroupCreateOrUpdateMutationInput!) {
  customFieldGroupCreateOrUpdate(input: $input) {
    ...CustomFieldGroupCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": CustomFieldGroupCreateOrUpdateMutationInput}

Response

{
  "data": {
    "customFieldGroupCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "customFieldGroup": CustomFieldGroup,
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`customFieldGroupDelete`

Description

Deletes an existing CustomFieldGroup and associated CustomFields. Only accessible to operator admin users.

Response

Returns a CustomFieldGroupDeleteMutationPayload

Arguments

Name	Description
`input` - `CustomFieldGroupDeleteMutationInput!`	Parameters for CustomFieldGroupDeleteMutation

Example

Query

mutation customFieldGroupDelete($input: CustomFieldGroupDeleteMutationInput!) {
  customFieldGroupDelete(input: $input) {
    ...CustomFieldGroupDeleteMutationPayloadFragment
  }
}

Variables

{"input": CustomFieldGroupDeleteMutationInput}

Response

{
  "data": {
    "customFieldGroupDelete": {
      "clientMutationId": "abc123",
      "customFieldGroup": CustomFieldGroup,
      "errors": [ValidationError],
      "status": 987
    }
  }
}

Mutations

`enrolAuthenticator`

Feature in development, subject to change without notice

Description

Enrol an authenticator for a user or admin. Users and Admins can only do this for themselves. Only accessible to seller and operator admin users.

Response

Returns an EnrolAuthenticatorMutationPayload

Arguments

Name	Description
`input` - `EnrolAuthenticatorMutationInput!`	Parameters for EnrolAuthenticatorMutation

Example

Query

mutation enrolAuthenticator($input: EnrolAuthenticatorMutationInput!) {
  enrolAuthenticator(input: $input) {
    ...EnrolAuthenticatorMutationPayloadFragment
  }
}

Variables

{"input": EnrolAuthenticatorMutationInput}

Response

{
  "data": {
    "enrolAuthenticator": {
      "authenticator": TOTP,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`externalIdUpsert`

Description

Create an association between an existing Object (eg. Advert) and external IDs. Only accessible to operator admin users.

Response

Returns an ExternalIDUpsertMutationPayload

Arguments

Name	Description
`input` - `ExternalIDUpsertMutationInput!`	Parameters for ExternalIDUpsertMutation

Example

Query

mutation externalIdUpsert($input: ExternalIDUpsertMutationInput!) {
  externalIdUpsert(input: $input) {
    ...ExternalIDUpsertMutationPayloadFragment
  }
}

Variables

{"input": ExternalIDUpsertMutationInput}

Response

{
  "data": {
    "externalIdUpsert": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "externalId": ExternalID,
      "status": 987
    }
  }
}

Mutations

`externalIdsUpsert`

Description

Create an association between an existing Object (eg. Advert) and external IDs ExternalID's owner/key will be unique. For example, owner: 'Advert', key: 'my_store', value: '23'. If an ExternalID exists with an owner of 'Advert' and a key of 'my_store', this record will be found and updated with the new value, or created if it does not exist. . Only accessible to operator admin users.

Response

Returns an ExternalIdsUpsertMutationPayload

Arguments

Name	Description
`input` - `ExternalIdsUpsertMutationInput!`	Parameters for ExternalIdsUpsertMutation

Example

Query

mutation externalIdsUpsert($input: ExternalIdsUpsertMutationInput!) {
  externalIdsUpsert(input: $input) {
    ...ExternalIdsUpsertMutationPayloadFragment
  }
}

Variables

{"input": ExternalIdsUpsertMutationInput}

Response

{
  "data": {
    "externalIdsUpsert": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "externalIds": [ExternalID],
      "status": 987
    }
  }
}

Mutations

`givexSettingsCreateOrUpdate`

Description

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

Response

Returns a GivexSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `GivexSettingsCreateOrUpdateMutationInput!`	Parameters for GivexSettingsCreateOrUpdateMutation

Example

Query

mutation givexSettingsCreateOrUpdate($input: GivexSettingsCreateOrUpdateMutationInput!) {
  givexSettingsCreateOrUpdate(input: $input) {
    ...GivexSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": GivexSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "givexSettingsCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "givexSettings": GivexSettings,
      "status": 987
    }
  }
}

Mutations

`givexSettingsDelete`

Description

Delete Givex settings. Only accessible to operator admin users.

Response

Returns a GivexSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `GivexSettingsDeleteMutationInput!`	Parameters for GivexSettingsDeleteMutation

Example

Query

mutation givexSettingsDelete($input: GivexSettingsDeleteMutationInput!) {
  givexSettingsDelete(input: $input) {
    ...GivexSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": GivexSettingsDeleteMutationInput}

Response

{
  "data": {
    "givexSettingsDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "givexSettings": GivexSettings,
      "status": 123
    }
  }
}

Mutations

`goldenProductCreate`

Description

Create a Golden Product. Only accessible to operator admin users.

Response

Returns a GoldenProductCreateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductCreateMutationInput!`	Parameters for GoldenProductCreateMutation

Example

Query

mutation goldenProductCreate($input: GoldenProductCreateMutationInput!) {
  goldenProductCreate(input: $input) {
    ...GoldenProductCreateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductCreateMutationInput}

Response

{
  "data": {
    "goldenProductCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProduct": GoldenProduct,
      "status": 123
    }
  }
}

Mutations

`goldenProductDelete`

Description

Delete a Golden product. Only accessible to operator admin users.

Response

Returns a GoldenProductDeleteMutationPayload

Arguments

Name	Description
`input` - `GoldenProductDeleteMutationInput!`	Parameters for GoldenProductDeleteMutation

Example

Query

mutation goldenProductDelete($input: GoldenProductDeleteMutationInput!) {
  goldenProductDelete(input: $input) {
    ...GoldenProductDeleteMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductDeleteMutationInput}

Response

{
  "data": {
    "goldenProductDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "goldenProduct": GoldenProduct,
      "status": 987
    }
  }
}

Mutations

`goldenProductUpdate`

Description

Update a Golden Product. Only accessible to operator admin users.

Response

Returns a GoldenProductUpdateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductUpdateMutationInput!`	Parameters for GoldenProductUpdateMutation

Example

Query

mutation goldenProductUpdate($input: GoldenProductUpdateMutationInput!) {
  goldenProductUpdate(input: $input) {
    ...GoldenProductUpdateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductUpdateMutationInput}

Response

{
  "data": {
    "goldenProductUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProduct": GoldenProduct,
      "status": 987
    }
  }
}

Mutations

`goldenProductVariantCreate`

Description

Create a golden product variant. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantCreateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantCreateMutationInput!`	Parameters for GoldenProductVariantCreateMutation

Example

Query

mutation goldenProductVariantCreate($input: GoldenProductVariantCreateMutationInput!) {
  goldenProductVariantCreate(input: $input) {
    ...GoldenProductVariantCreateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantCreateMutationInput}

Response

{
  "data": {
    "goldenProductVariantCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProductVariant": GoldenProductVariant,
      "status": 123
    }
  }
}

Mutations

`goldenProductVariantDelete`

Description

Delete a Golden product variant record. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantDeleteMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantDeleteMutationInput!`	Parameters for GoldenProductVariantDeleteMutation

Example

Query

mutation goldenProductVariantDelete($input: GoldenProductVariantDeleteMutationInput!) {
  goldenProductVariantDelete(input: $input) {
    ...GoldenProductVariantDeleteMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantDeleteMutationInput}

Response

{
  "data": {
    "goldenProductVariantDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "goldenProductVariant": GoldenProductVariant,
      "status": 987
    }
  }
}

Mutations

`goldenProductVariantLinkVariants`

Description

Link the provided variants to the golden product variants by appending to existing association. Also links the advert to the golden product if a link is not already established. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantLinkVariantsMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantLinkVariantsMutationInput!`	Parameters for GoldenProductVariantLinkVariantsMutation

Example

Query

mutation goldenProductVariantLinkVariants($input: GoldenProductVariantLinkVariantsMutationInput!) {
  goldenProductVariantLinkVariants(input: $input) {
    ...GoldenProductVariantLinkVariantsMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantLinkVariantsMutationInput}

Response

{
  "data": {
    "goldenProductVariantLinkVariants": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProductVariant": GoldenProductVariant,
      "status": 123
    }
  }
}

Mutations

`goldenProductVariantUnlinkVariants`

Description

Unlink the provided variants from the golden product variant. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantUnlinkVariantsMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantUnlinkVariantsMutationInput!`	Parameters for GoldenProductVariantUnlinkVariantsMutation

Example

Query

mutation goldenProductVariantUnlinkVariants($input: GoldenProductVariantUnlinkVariantsMutationInput!) {
  goldenProductVariantUnlinkVariants(input: $input) {
    ...GoldenProductVariantUnlinkVariantsMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantUnlinkVariantsMutationInput}

Response

{
  "data": {
    "goldenProductVariantUnlinkVariants": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProductVariant": GoldenProductVariant,
      "status": 987
    }
  }
}

Mutations

`goldenProductVariantUpdate`

Description

Update a golden product variant. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantUpdateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantUpdateMutationInput!`	Parameters for GoldenProductVariantUpdateMutation

Example

Query

mutation goldenProductVariantUpdate($input: GoldenProductVariantUpdateMutationInput!) {
  goldenProductVariantUpdate(input: $input) {
    ...GoldenProductVariantUpdateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantUpdateMutationInput}

Response

{
  "data": {
    "goldenProductVariantUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "goldenProductVariant": GoldenProductVariant,
      "status": 987
    }
  }
}

Mutations

`goldenProductVariantsActivate`

Description

Activates Golden product variants. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantsActivateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantsActivateMutationInput!`	Parameters for GoldenProductVariantsActivateMutation

Example

Query

mutation goldenProductVariantsActivate($input: GoldenProductVariantsActivateMutationInput!) {
  goldenProductVariantsActivate(input: $input) {
    ...GoldenProductVariantsActivateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantsActivateMutationInput}

Response

{
  "data": {
    "goldenProductVariantsActivate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "goldenProductVariants": [GoldenProductVariant],
      "status": 123
    }
  }
}

Mutations

`goldenProductVariantsDeactivate`

Description

Deactivate Golden Product Variants. Only accessible to operator admin users.

Response

Returns a GoldenProductVariantsDeactivateMutationPayload

Arguments

Name	Description
`input` - `GoldenProductVariantsDeactivateMutationInput!`	Parameters for GoldenProductVariantsDeactivateMutation

Example

Query

mutation goldenProductVariantsDeactivate($input: GoldenProductVariantsDeactivateMutationInput!) {
  goldenProductVariantsDeactivate(input: $input) {
    ...GoldenProductVariantsDeactivateMutationPayloadFragment
  }
}

Variables

{"input": GoldenProductVariantsDeactivateMutationInput}

Response

{
  "data": {
    "goldenProductVariantsDeactivate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "goldenProductVariants": [GoldenProductVariant],
      "status": 987
    }
  }
}

Mutations

`imageUpload`

Description

Upload an image to be attached elsewhere. Only accessible to operator and seller admin users.

Response

Returns an ImageUploadMutationPayload

Arguments

Name	Description
`input` - `ImageUploadMutationInput!`	Parameters for ImageUploadMutation

Example

Query

mutation imageUpload($input: ImageUploadMutationInput!) {
  imageUpload(input: $input) {
    ...ImageUploadMutationPayloadFragment
  }
}

Variables

{"input": ImageUploadMutationInput}

Response

{
  "data": {
    "imageUpload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "sourceUrl": "xyz789",
      "status": 987
    }
  }
}

Mutations

`inquiryCreate`

Description

Create an inquiry to the seller. Only accessible to operator admin users.

Response

Returns an InquiryCreateMutationPayload

Arguments

Name	Description
`input` - `InquiryCreateMutationInput!`	Parameters for InquiryCreateMutation

Example

Query

mutation inquiryCreate($input: InquiryCreateMutationInput!) {
  inquiryCreate(input: $input) {
    ...InquiryCreateMutationPayloadFragment
  }
}

Variables

{"input": InquiryCreateMutationInput}

Response

{
  "data": {
    "inquiryCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "inquiry": Inquiry,
      "status": 123
    }
  }
}

Mutations

`invoiceAmendmentCreate`

Description

Create an invoice amendment. Only accessible to operator admin users.

Response

Returns an InvoiceAmendmentCreateMutationPayload

Arguments

Name	Description
`input` - `InvoiceAmendmentCreateMutationInput!`	Parameters for InvoiceAmendmentCreateMutation

Example

Query

mutation invoiceAmendmentCreate($input: InvoiceAmendmentCreateMutationInput!) {
  invoiceAmendmentCreate(input: $input) {
    ...InvoiceAmendmentCreateMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAmendmentCreateMutationInput}

Response

{
  "data": {
    "invoiceAmendmentCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAmendment": InvoiceAmendment,
      "status": 123
    }
  }
}

Mutations

`invoiceAnnotationCreate`

Description

Annotate an invoice.

Response

Returns an InvoiceAnnotationCreateMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationCreateMutationInput!`	Parameters for InvoiceAnnotationCreateMutation

Example

Query

mutation invoiceAnnotationCreate($input: InvoiceAnnotationCreateMutationInput!) {
  invoiceAnnotationCreate(input: $input) {
    ...InvoiceAnnotationCreateMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationCreateMutationInput}

Response

{
  "data": {
    "invoiceAnnotationCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotation": InvoiceAnnotation,
      "status": 123
    }
  }
}

Mutations

`invoiceAnnotationResolve`

Description

Resolve an invoice annotation.

Response

Returns an InvoiceAnnotationResolveMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationResolveMutationInput!`	Parameters for InvoiceAnnotationResolveMutation

Example

Query

mutation invoiceAnnotationResolve($input: InvoiceAnnotationResolveMutationInput!) {
  invoiceAnnotationResolve(input: $input) {
    ...InvoiceAnnotationResolveMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationResolveMutationInput}

Response

{
  "data": {
    "invoiceAnnotationResolve": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotation": InvoiceAnnotation,
      "status": 987
    }
  }
}

Mutations

`invoiceAnnotationTypeCreate`

Description

Create an invoice annotation type. Only accessible to operator admin users.

Response

Returns an InvoiceAnnotationTypeCreateMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationTypeCreateMutationInput!`	Parameters for InvoiceAnnotationTypeCreateMutation

Example

Query

mutation invoiceAnnotationTypeCreate($input: InvoiceAnnotationTypeCreateMutationInput!) {
  invoiceAnnotationTypeCreate(input: $input) {
    ...InvoiceAnnotationTypeCreateMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationTypeCreateMutationInput}

Response

{
  "data": {
    "invoiceAnnotationTypeCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotationType": InvoiceAnnotationType,
      "status": 987
    }
  }
}

Mutations

`invoiceAnnotationTypeDiscard`

Description

Discard an invoice annotation type. Only accessible to operator admin users.

Response

Returns an InvoiceAnnotationTypeDiscardMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationTypeDiscardMutationInput!`	Parameters for InvoiceAnnotationTypeDiscardMutation

Example

Query

mutation invoiceAnnotationTypeDiscard($input: InvoiceAnnotationTypeDiscardMutationInput!) {
  invoiceAnnotationTypeDiscard(input: $input) {
    ...InvoiceAnnotationTypeDiscardMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationTypeDiscardMutationInput}

Response

{
  "data": {
    "invoiceAnnotationTypeDiscard": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotationType": InvoiceAnnotationType,
      "status": 123
    }
  }
}

Mutations

`invoiceAnnotationTypeUpdate`

Description

Update an invoice annotation type. Only accessible to operator admin users.

Response

Returns an InvoiceAnnotationTypeUpdateMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationTypeUpdateMutationInput!`	Parameters for InvoiceAnnotationTypeUpdateMutation

Example

Query

mutation invoiceAnnotationTypeUpdate($input: InvoiceAnnotationTypeUpdateMutationInput!) {
  invoiceAnnotationTypeUpdate(input: $input) {
    ...InvoiceAnnotationTypeUpdateMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationTypeUpdateMutationInput}

Response

{
  "data": {
    "invoiceAnnotationTypeUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotationType": InvoiceAnnotationType,
      "status": 123
    }
  }
}

Mutations

`invoiceAnnotationUpdate`

Description

Update an invoice annotation.

Response

Returns an InvoiceAnnotationUpdateMutationPayload

Arguments

Name	Description
`input` - `InvoiceAnnotationUpdateMutationInput!`	Parameters for InvoiceAnnotationUpdateMutation

Example

Query

mutation invoiceAnnotationUpdate($input: InvoiceAnnotationUpdateMutationInput!) {
  invoiceAnnotationUpdate(input: $input) {
    ...InvoiceAnnotationUpdateMutationPayloadFragment
  }
}

Variables

{"input": InvoiceAnnotationUpdateMutationInput}

Response

{
  "data": {
    "invoiceAnnotationUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "invoiceAnnotation": InvoiceAnnotation,
      "status": 987
    }
  }
}

Mutations

`klaviyoSettingsCreateOrUpdate`

Description

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

Response

Returns a KlaviyoSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `KlaviyoSettingsCreateOrUpdateMutationInput!`	Parameters for KlaviyoSettingsCreateOrUpdateMutation

Example

Query

mutation klaviyoSettingsCreateOrUpdate($input: KlaviyoSettingsCreateOrUpdateMutationInput!) {
  klaviyoSettingsCreateOrUpdate(input: $input) {
    ...KlaviyoSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": KlaviyoSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "klaviyoSettingsCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "klaviyoSettings": KlaviyoSettings,
      "status": 987
    }
  }
}

Mutations

`klaviyoSettingsDelete`

Description

Delete Klaviyo settings. Only accessible to operator admin users.

Response

Returns a KlaviyoSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `KlaviyoSettingsDeleteMutationInput!`	Parameters for KlaviyoSettingsDeleteMutation

Example

Query

mutation klaviyoSettingsDelete($input: KlaviyoSettingsDeleteMutationInput!) {
  klaviyoSettingsDelete(input: $input) {
    ...KlaviyoSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": KlaviyoSettingsDeleteMutationInput}

Response

{
  "data": {
    "klaviyoSettingsDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "klaviyoSettings": KlaviyoSettings,
      "status": 987
    }
  }
}

Mutations

`lineItemsForShipmentsSpreadsheetDownload`

Description

start a background job to download line items that have not yet been shipped. Only accessible to operator and seller admin users.

Response

Returns a LineItemsForShipmentsSpreadsheetDownloadMutationPayload

Arguments

Name	Description
`input` - `LineItemsForShipmentsSpreadsheetDownloadMutationInput!`	Parameters for LineItemsForShipmentsSpreadsheetDownloadMutation

Example

Query

mutation lineItemsForShipmentsSpreadsheetDownload($input: LineItemsForShipmentsSpreadsheetDownloadMutationInput!) {
  lineItemsForShipmentsSpreadsheetDownload(input: $input) {
    ...LineItemsForShipmentsSpreadsheetDownloadMutationPayloadFragment
  }
}

Variables

{
  "input": LineItemsForShipmentsSpreadsheetDownloadMutationInput
}

Response

{
  "data": {
    "lineItemsForShipmentsSpreadsheetDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 987
    }
  }
}

Mutations

`lineItemsForShipmentsSpreadsheetUpload`

Description

start a background job to bulk dispatch line items. Only accessible to operator and seller admin users.

Response

Returns a LineItemsForShipmentsSpreadsheetUploadMutationPayload

Arguments

Name	Description
`input` - `LineItemsForShipmentsSpreadsheetUploadMutationInput!`	Parameters for LineItemsForShipmentsSpreadsheetUploadMutation

Example

Query

mutation lineItemsForShipmentsSpreadsheetUpload($input: LineItemsForShipmentsSpreadsheetUploadMutationInput!) {
  lineItemsForShipmentsSpreadsheetUpload(input: $input) {
    ...LineItemsForShipmentsSpreadsheetUploadMutationPayloadFragment
  }
}

Variables

{
  "input": LineItemsForShipmentsSpreadsheetUploadMutationInput
}

Response

{
  "data": {
    "lineItemsForShipmentsSpreadsheetUpload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "import": ImportExport,
      "status": 987
    }
  }
}

Mutations

`logOut`

Description

Logs a user out, based on a session cookie.

Response

Returns a UserLogOutMutationPayload

Arguments

Name	Description
`input` - `UserLogOutMutationInput!`	Parameters for UserLogOutMutation

Example

Query

mutation logOut($input: UserLogOutMutationInput!) {
  logOut(input: $input) {
    ...UserLogOutMutationPayloadFragment
  }
}

Variables

{"input": UserLogOutMutationInput}

Response

{
  "data": {
    "logOut": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "loggedOut": false,
      "status": 123
    }
  }
}

Mutations

`mappingSet`

Description

Set the mapping value. Only accessible to operator and seller admin users.

Response

Returns a MappingSetMutationPayload

Arguments

Name	Description
`input` - `MappingSetMutationInput!`	Parameters for MappingSetMutation

Example

Query

mutation mappingSet($input: MappingSetMutationInput!) {
  mappingSet(input: $input) {
    ...MappingSetMutationPayloadFragment
  }
}

Variables

{"input": MappingSetMutationInput}

Response

{
  "data": {
    "mappingSet": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "mapping": Mapping,
      "status": 987
    }
  }
}

Mutations

`marketplacerApiKeyCreate`

Description

Generate API keys. Only accessible to operator and seller admin users.

Response

Returns a MarketplacerAPIKeyCreateMutationPayload

Arguments

Name	Description
`input` - `MarketplacerAPIKeyCreateMutationInput!`	Parameters for MarketplacerAPIKeyCreateMutation

Example

Query

mutation marketplacerApiKeyCreate($input: MarketplacerAPIKeyCreateMutationInput!) {
  marketplacerApiKeyCreate(input: $input) {
    ...MarketplacerAPIKeyCreateMutationPayloadFragment
  }
}

Variables

{"input": MarketplacerAPIKeyCreateMutationInput}

Response

{
  "data": {
    "marketplacerApiKeyCreate": {
      "apiKey": "xyz789",
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "marketplacerApiKey": MarketplacerAPIKey,
      "status": 123
    }
  }
}

Mutations

`measurementUnitCreate`

Description

Create a Measurement Unit. Only accessible to operator admin users.

Response

Returns a MeasurementUnitCreateMutationPayload

Arguments

Name	Description
`input` - `MeasurementUnitCreateMutationInput!`	Parameters for MeasurementUnitCreateMutation

Example

Query

mutation measurementUnitCreate($input: MeasurementUnitCreateMutationInput!) {
  measurementUnitCreate(input: $input) {
    ...MeasurementUnitCreateMutationPayloadFragment
  }
}

Variables

{"input": MeasurementUnitCreateMutationInput}

Response

{
  "data": {
    "measurementUnitCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "measurementUnit": MeasurementUnit,
      "status": 987
    }
  }
}

Mutations

`measurementUnitDelete`

Description

Delete a measurement unit. Only accessible to operator admin users.

Response

Returns a MeasurementUnitDeleteMutationPayload

Arguments

Name	Description
`input` - `MeasurementUnitDeleteMutationInput!`	Parameters for MeasurementUnitDeleteMutation

Example

Query

mutation measurementUnitDelete($input: MeasurementUnitDeleteMutationInput!) {
  measurementUnitDelete(input: $input) {
    ...MeasurementUnitDeleteMutationPayloadFragment
  }
}

Variables

{"input": MeasurementUnitDeleteMutationInput}

Response

{
  "data": {
    "measurementUnitDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "measurementUnit": MeasurementUnit,
      "status": 123
    }
  }
}

Mutations

`measurementUnitUpdate`

Description

Update a Measurement Unit. Only accessible to operator admin users.

Response

Returns a MeasurementUnitUpdateMutationPayload

Arguments

Name	Description
`input` - `MeasurementUnitUpdateMutationInput!`	Parameters for MeasurementUnitUpdateMutation

Example

Query

mutation measurementUnitUpdate($input: MeasurementUnitUpdateMutationInput!) {
  measurementUnitUpdate(input: $input) {
    ...MeasurementUnitUpdateMutationPayloadFragment
  }
}

Variables

{"input": MeasurementUnitUpdateMutationInput}

Response

{
  "data": {
    "measurementUnitUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "measurementUnit": MeasurementUnit,
      "status": 123
    }
  }
}

Mutations

`metadata2Upsert`

Description

Create an association between an existing Object (eg. Advert) and multiple Metadata objects Metadata's owner/key will be unique. For example, owner: 'Advert', key: 'my_store', value: '23'. If a Metadata exists with an owner of 'Advert' and a key of 'my_store', this record will be found and updated with the new value, or created if it does not exist. . Only accessible to operator admin users.

Response

Returns a Metadata2UpsertMutationPayload

Arguments

Name	Description
`input` - `Metadata2UpsertMutationInput!`	Parameters for Metadata2UpsertMutation

Example

Query

mutation metadata2Upsert($input: Metadata2UpsertMutationInput!) {
  metadata2Upsert(input: $input) {
    ...Metadata2UpsertMutationPayloadFragment
  }
}

Variables

{"input": Metadata2UpsertMutationInput}

Response

{
  "data": {
    "metadata2Upsert": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "metadata": [Metadatum],
      "status": 987
    }
  }
}

Mutations

`metadataUpsert`

Description

Create an association between an existing Object (eg. Order/Invoice/Seller) and Metadata. Only accessible to operator admin users.

Response

Returns a MetadataUpsertMutationPayload

Arguments

Name	Description
`input` - `MetadataUpsertMutationInput!`	Parameters for MetadataUpsertMutation

Example

Query

mutation metadataUpsert($input: MetadataUpsertMutationInput!) {
  metadataUpsert(input: $input) {
    ...MetadataUpsertMutationPayloadFragment
  }
}

Variables

{"input": MetadataUpsertMutationInput}

Response

{
  "data": {
    "metadataUpsert": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "metadata": Metadatum,
      "status": 987
    }
  }
}

Mutations

`newsletterSubscribe`

Description

Subscribe the given email to the marketing newsletter.

Response

Returns a NewsletterSubscribeMutationPayload

Arguments

Name	Description
`input` - `NewsletterSubscribeMutationInput!`	Parameters for NewsletterSubscribeMutation

Example

Query

mutation newsletterSubscribe($input: NewsletterSubscribeMutationInput!) {
  newsletterSubscribe(input: $input) {
    ...NewsletterSubscribeMutationPayloadFragment
  }
}

Variables

{"input": NewsletterSubscribeMutationInput}

Response

{
  "data": {
    "newsletterSubscribe": {
      "clientMutationId": "abc123",
      "email": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}

Mutations

`optionTypeCreateOrUpdate`

Description

Create an OptionType if no ID is passed, otherwise updates existing Prototype. Only accessible to operator admin users.

Response

Returns an OptionTypeCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `OptionTypeCreateOrUpdateMutationInput!`	Parameters for OptionTypeCreateOrUpdateMutation

Example

Query

mutation optionTypeCreateOrUpdate($input: OptionTypeCreateOrUpdateMutationInput!) {
  optionTypeCreateOrUpdate(input: $input) {
    ...OptionTypeCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": OptionTypeCreateOrUpdateMutationInput}

Response

{
  "data": {
    "optionTypeCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "optionType": OptionType,
      "status": 123
    }
  }
}

Mutations

`optionValueCreateOrUpdate`

Description

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

Response

Returns an OptionValueCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `OptionValueCreateOrUpdateMutationInput!`	Parameters for OptionValueCreateOrUpdateMutation

Example

Query

mutation optionValueCreateOrUpdate($input: OptionValueCreateOrUpdateMutationInput!) {
  optionValueCreateOrUpdate(input: $input) {
    ...OptionValueCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": OptionValueCreateOrUpdateMutationInput}

Response

{
  "data": {
    "optionValueCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "optionValue": OptionValue,
      "status": 987
    }
  }
}

Mutations

`optionValueDelete`

Description

Delete an existing OptionValue. Only accessible to operator admin users.

Response

Returns an OptionValueDeleteMutationPayload

Arguments

Name	Description
`input` - `OptionValueDeleteMutationInput!`	Parameters for OptionValueDeleteMutation

Example

Query

mutation optionValueDelete($input: OptionValueDeleteMutationInput!) {
  optionValueDelete(input: $input) {
    ...OptionValueDeleteMutationPayloadFragment
  }
}

Variables

{"input": OptionValueDeleteMutationInput}

Response

{
  "data": {
    "optionValueDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "optionValue": OptionValue,
      "status": 123
    }
  }
}

Mutations

`orderCreate`

Description

Create an order. Only accessible to operator admin users.

Response

Returns an OrderCreateMutationPayload

Arguments

Name	Description
`input` - `OrderCreateMutationInput!`	Parameters for OrderCreateMutation

Example

Query

mutation orderCreate($input: OrderCreateMutationInput!) {
  orderCreate(input: $input) {
    ...OrderCreateMutationPayloadFragment
  }
}

Variables

{"input": OrderCreateMutationInput}

Response

{
  "data": {
    "orderCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "order": Order,
      "status": 123
    }
  }
}

Mutations

`orderHistoryDownload`

Description

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

Response

Returns an OrderHistoryDownloadMutationPayload

Arguments

Name	Description
`input` - `OrderHistoryDownloadMutationInput!`	Parameters for OrderHistoryDownloadMutation

Example

Query

mutation orderHistoryDownload($input: OrderHistoryDownloadMutationInput!) {
  orderHistoryDownload(input: $input) {
    ...OrderHistoryDownloadMutationPayloadFragment
  }
}

Variables

{"input": OrderHistoryDownloadMutationInput}

Response

{
  "data": {
    "orderHistoryDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 123
    }
  }
}

Mutations

`orderUpdate`

Description

Update a finalized order. Only accessible to operator admin users.

Response

Returns an OrderUpdateMutationPayload

Arguments

Name	Description
`input` - `OrderUpdateMutationInput!`	Parameters for OrderUpdateMutation

Example

Query

mutation orderUpdate($input: OrderUpdateMutationInput!) {
  orderUpdate(input: $input) {
    ...OrderUpdateMutationPayloadFragment
  }
}

Variables

{"input": OrderUpdateMutationInput}

Response

{
  "data": {
    "orderUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "order": Order,
      "status": 987
    }
  }
}

Mutations

`partnerIntegrationToggleEventCreate`

Description

Create a partner integration toggle event. Only accessible to operator and seller admin users.

Response

Returns a PartnerIntegrationToggleEventCreateMutationPayload

Arguments

Name	Description
`input` - `PartnerIntegrationToggleEventCreateMutationInput!`	Parameters for PartnerIntegrationToggleEventCreateMutation

Example

Query

mutation partnerIntegrationToggleEventCreate($input: PartnerIntegrationToggleEventCreateMutationInput!) {
  partnerIntegrationToggleEventCreate(input: $input) {
    ...PartnerIntegrationToggleEventCreateMutationPayloadFragment
  }
}

Variables

{
  "input": PartnerIntegrationToggleEventCreateMutationInput
}

Response

{
  "data": {
    "partnerIntegrationToggleEventCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "partnerIntegrationToggleEvent": PartnerIntegrationToggleEvent,
      "status": 123
    }
  }
}

Mutations

`passwordReset`

Description

Resets password for a user or admin.

Response

Returns a PasswordResetMutationPayload

Arguments

Name	Description
`input` - `PasswordResetMutationInput!`	Parameters for PasswordResetMutation

Example

Query

mutation passwordReset($input: PasswordResetMutationInput!) {
  passwordReset(input: $input) {
    ...PasswordResetMutationPayloadFragment
  }
}

Variables

{"input": PasswordResetMutationInput}

Response

{
  "data": {
    "passwordReset": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`paymentMethodCreate`

Description

Create a payment method. Only accessible to operator admin users.

Response

Returns a PaymentMethodCreateMutationPayload

Arguments

Name	Description
`input` - `PaymentMethodCreateMutationInput!`	Parameters for PaymentMethodCreateMutation

Example

Query

mutation paymentMethodCreate($input: PaymentMethodCreateMutationInput!) {
  paymentMethodCreate(input: $input) {
    ...PaymentMethodCreateMutationPayloadFragment
  }
}

Variables

{"input": PaymentMethodCreateMutationInput}

Response

{
  "data": {
    "paymentMethodCreate": {
      "braintreeBillingSettings": BraintreeBillingSettings,
      "braintreeEcommerceSettings": BraintreeEcommerceSettings,
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "paymentMethod": PaymentMethod,
      "status": 123
    }
  }
}

Mutations

`paymentMethodDelete`

Description

Delete a payment method. Only accessible to operator admin users.

Response

Returns a PaymentMethodDeleteMutationPayload

Arguments

Name	Description
`input` - `PaymentMethodDeleteMutationInput!`	Parameters for PaymentMethodDeleteMutation

Example

Query

mutation paymentMethodDelete($input: PaymentMethodDeleteMutationInput!) {
  paymentMethodDelete(input: $input) {
    ...PaymentMethodDeleteMutationPayloadFragment
  }
}

Variables

{"input": PaymentMethodDeleteMutationInput}

Response

{
  "data": {
    "paymentMethodDelete": {
      "braintreeBillingSettings": BraintreeBillingSettings,
      "braintreeEcommerceSettings": BraintreeEcommerceSettings,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "paymentMethod": PaymentMethod,
      "status": 987
    }
  }
}

Mutations

`paypalCommerceSettingsCreateOrUpdate`

Description

Create or update PayPal Commerce settings. Only accessible to operator admin users.

Response

Returns a PaypalCommerceSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `PaypalCommerceSettingsCreateOrUpdateMutationInput!`	Parameters for PaypalCommerceSettingsCreateOrUpdateMutation

Example

Query

mutation paypalCommerceSettingsCreateOrUpdate($input: PaypalCommerceSettingsCreateOrUpdateMutationInput!) {
  paypalCommerceSettingsCreateOrUpdate(input: $input) {
    ...PaypalCommerceSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{
  "input": PaypalCommerceSettingsCreateOrUpdateMutationInput
}

Response

{
  "data": {
    "paypalCommerceSettingsCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "paypalCommerceSettings": PaypalCommerceSettings,
      "status": 123
    }
  }
}

Mutations

`paypalCommerceSettingsDelete`

Description

Delete PayPal Commerce settings. Only accessible to operator admin users.

Response

Returns a PaypalCommerceSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `PaypalCommerceSettingsDeleteMutationInput!`	Parameters for PaypalCommerceSettingsDeleteMutation

Example

Query

mutation paypalCommerceSettingsDelete($input: PaypalCommerceSettingsDeleteMutationInput!) {
  paypalCommerceSettingsDelete(input: $input) {
    ...PaypalCommerceSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": PaypalCommerceSettingsDeleteMutationInput}

Response

{
  "data": {
    "paypalCommerceSettingsDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "paypalCommerceSettings": PaypalCommerceSettings,
      "status": 987
    }
  }
}

Mutations

`processPaymentGatewayRedirect`

Description

Confirm an order using order ID. This order confirmation is used only for redirect based payment providers such as Afterpay, Zip. Will receive order once order has been processed successfully.

Response

Returns a ProcessPaymentGatewayRedirectMutationPayload

Arguments

Name	Description
`input` - `ProcessPaymentGatewayRedirectMutationInput!`	Parameters for ProcessPaymentGatewayRedirectMutation

Example

Query

mutation processPaymentGatewayRedirect($input: ProcessPaymentGatewayRedirectMutationInput!) {
  processPaymentGatewayRedirect(input: $input) {
    ...ProcessPaymentGatewayRedirectMutationPayloadFragment
  }
}

Variables

{"input": ProcessPaymentGatewayRedirectMutationInput}

Response

{
  "data": {
    "processPaymentGatewayRedirect": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "order": Order,
      "status": 123
    }
  }
}

Mutations

`promotionUpsert`

Description

Create or update a promotion. Only accessible to operator and seller admin users.

Response

Returns a PromotionUpsertMutationPayload

Arguments

Name	Description
`input` - `PromotionUpsertMutationInput!`	Parameters for PromotionUpsertMutation

Example

Query

mutation promotionUpsert($input: PromotionUpsertMutationInput!) {
  promotionUpsert(input: $input) {
    ...PromotionUpsertMutationPayloadFragment
  }
}

Variables

{"input": PromotionUpsertMutationInput}

Response

{
  "data": {
    "promotionUpsert": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "promotion": Promotion,
      "status": 123
    }
  }
}

Mutations

`prototypeCreateOrUpdate`

Description

Create a Prototype if no ID is passed, otherwise updates existing Prototype. Only accessible to operator admin users.

Response

Returns a PrototypeCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `PrototypeCreateOrUpdateMutationInput!`	Parameters for PrototypeCreateOrUpdateMutation

Example

Query

mutation prototypeCreateOrUpdate($input: PrototypeCreateOrUpdateMutationInput!) {
  prototypeCreateOrUpdate(input: $input) {
    ...PrototypeCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": PrototypeCreateOrUpdateMutationInput}

Response

{
  "data": {
    "prototypeCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "prototype": Prototype,
      "status": 123
    }
  }
}

Mutations

`purgeOrderData`

Description

Purge the sensitive user data from an order. Only accessible to operator admin users.

Response

Returns a PurgeOrderDataMutationPayload

Arguments

Name	Description
`input` - `PurgeOrderDataMutationInput!`	Parameters for PurgeOrderDataMutation

Example

Query

mutation purgeOrderData($input: PurgeOrderDataMutationInput!) {
  purgeOrderData(input: $input) {
    ...PurgeOrderDataMutationPayloadFragment
  }
}

Variables

{"input": PurgeOrderDataMutationInput}

Response

{
  "data": {
    "purgeOrderData": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`rankedResultDelete`

Description

Delete a ranked result. Only accessible to operator admin users.

Response

Returns a RankedResultDeleteMutationPayload

Arguments

Name	Description
`input` - `RankedResultDeleteMutationInput!`	Parameters for RankedResultDeleteMutation

Example

Query

mutation rankedResultDelete($input: RankedResultDeleteMutationInput!) {
  rankedResultDelete(input: $input) {
    ...RankedResultDeleteMutationPayloadFragment
  }
}

Variables

{"input": RankedResultDeleteMutationInput}

Response

{
  "data": {
    "rankedResultDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "rankedResult": RankedResult,
      "status": 987
    }
  }
}

Mutations

`rankedResultUpsert`

Description

Upsert a ranked result. Only accessible to operator admin users.

Response

Returns a RankedResultUpsertMutationPayload

Arguments

Name	Description
`input` - `RankedResultUpsertMutationInput!`	Parameters for RankedResultUpsertMutation

Example

Query

mutation rankedResultUpsert($input: RankedResultUpsertMutationInput!) {
  rankedResultUpsert(input: $input) {
    ...RankedResultUpsertMutationPayloadFragment
  }
}

Variables

{"input": RankedResultUpsertMutationInput}

Response

{
  "data": {
    "rankedResultUpsert": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "rankedResult": RankedResult,
      "status": 123
    }
  }
}

Mutations

`refundRequestApprove`

Description

Approve the refund request. Only accessible to operator admin users.

Response

Returns a RefundRequestApproveMutationPayload

Arguments

Name	Description
`input` - `RefundRequestApproveInput!`

Example

Query

mutation refundRequestApprove($input: RefundRequestApproveInput!) {
  refundRequestApprove(input: $input) {
    ...RefundRequestApproveMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestApproveInput}

Response

{
  "data": {
    "refundRequestApprove": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 123
    }
  }
}

Mutations

`refundRequestCreate`

Description

Create a refund request. Only accessible to operator and seller admin users.

Response

Returns a RefundRequestCreateMutationPayload

Arguments

Name	Description
`input` - `RefundRequestCreateMutationInput!`	Parameters for RefundRequestCreateMutation

Example

Query

mutation refundRequestCreate($input: RefundRequestCreateMutationInput!) {
  refundRequestCreate(input: $input) {
    ...RefundRequestCreateMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestCreateMutationInput}

Response

{
  "data": {
    "refundRequestCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 987
    }
  }
}

Mutations

`refundRequestDeny`

Description

Deny a refund request. Only accessible to operator admin users.

Response

Returns a RefundRequestDenyMutationPayload

Arguments

Name	Description
`input` - `RefundRequestDenyMutationInput!`	Parameters for RefundRequestDenyMutation

Example

Query

mutation refundRequestDeny($input: RefundRequestDenyMutationInput!) {
  refundRequestDeny(input: $input) {
    ...RefundRequestDenyMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestDenyMutationInput}

Response

{
  "data": {
    "refundRequestDeny": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 123
    }
  }
}

Mutations

`refundRequestLineItemAccept`

Description

Accept the refund request line item. Only accessible to operator and seller admin users.

Response

Returns a RefundRequestLineItemAcceptMutationPayload

Arguments

Name	Description
`input` - `RefundRequestLineItemAcceptMutationInput!`	Parameters for RefundRequestLineItemAcceptMutation

Example

Query

mutation refundRequestLineItemAccept($input: RefundRequestLineItemAcceptMutationInput!) {
  refundRequestLineItemAccept(input: $input) {
    ...RefundRequestLineItemAcceptMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestLineItemAcceptMutationInput}

Response

{
  "data": {
    "refundRequestLineItemAccept": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequestLineItem": RefundRequestLineItem,
      "status": 987
    }
  }
}

Mutations

`refundRequestLineItemDeny`

Description

Deny the refund request line item. Only accessible to operator and seller admin users.

Response

Returns a RefundRequestLineItemDenyMutationPayload

Arguments

Name	Description
`input` - `RefundRequestLineItemDenyMutationInput!`	Parameters for RefundRequestLineItemDenyMutation

Example

Query

mutation refundRequestLineItemDeny($input: RefundRequestLineItemDenyMutationInput!) {
  refundRequestLineItemDeny(input: $input) {
    ...RefundRequestLineItemDenyMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestLineItemDenyMutationInput}

Response

{
  "data": {
    "refundRequestLineItemDeny": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "refundRequestLineItem": RefundRequestLineItem,
      "status": 987
    }
  }
}

Mutations

`refundRequestLineItemReturn`

Description

Return the refund request line item. Only accessible to operator and seller admin users.

Response

Returns a RefundRequestLineItemReturnMutationPayload

Arguments

Name	Description
`input` - `RefundRequestLineItemReturnMutationInput!`	Parameters for RefundRequestLineItemReturnMutation

Example

Query

mutation refundRequestLineItemReturn($input: RefundRequestLineItemReturnMutationInput!) {
  refundRequestLineItemReturn(input: $input) {
    ...RefundRequestLineItemReturnMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestLineItemReturnMutationInput}

Response

{
  "data": {
    "refundRequestLineItemReturn": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequestLineItem": RefundRequestLineItem,
      "status": 987
    }
  }
}

Mutations

`refundRequestRefund`

Description

Refund a refund request. Only accessible to operator admin users.

Response

Returns a RefundRequestRefundMutationPayload

Arguments

Name	Description
`input` - `RefundRequestRefundMutationInput!`	Parameters for RefundRequestRefundMutation

Example

Query

mutation refundRequestRefund($input: RefundRequestRefundMutationInput!) {
  refundRequestRefund(input: $input) {
    ...RefundRequestRefundMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestRefundMutationInput}

Response

{
  "data": {
    "refundRequestRefund": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 987
    }
  }
}

Mutations

`refundRequestReturn`

Description

Mark a refund request as having been returned. Only accessible to operator and seller admin users.

Response

Returns a RefundRequestReturnMutationPayload

Arguments

Name	Description
`input` - `RefundRequestReturnMutationInput!`	Parameters for RefundRequestReturnMutation

Example

Query

mutation refundRequestReturn($input: RefundRequestReturnMutationInput!) {
  refundRequestReturn(input: $input) {
    ...RefundRequestReturnMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestReturnMutationInput}

Response

{
  "data": {
    "refundRequestReturn": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 987
    }
  }
}

Mutations

`refundRequestRevertDenial`

Description

Revert a refund request denial. Only accessible to operator admin users.

Response

Returns a RefundRequestRevertDenialMutationPayload

Arguments

Name	Description
`input` - `RefundRequestRevertDenialMutationInput!`	Parameters for RefundRequestRevertDenialMutation

Example

Query

mutation refundRequestRevertDenial($input: RefundRequestRevertDenialMutationInput!) {
  refundRequestRevertDenial(input: $input) {
    ...RefundRequestRevertDenialMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestRevertDenialMutationInput}

Response

{
  "data": {
    "refundRequestRevertDenial": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "refundRequest": RefundRequest,
      "status": 123
    }
  }
}

Mutations

`refundRequestSpreadsheetDownload`

Description

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

Response

Returns a RefundRequestSpreadsheetDownloadMutationPayload

Arguments

Name	Description
`input` - `RefundRequestSpreadsheetDownloadMutationInput!`	Parameters for RefundRequestSpreadsheetDownloadMutation

Example

Query

mutation refundRequestSpreadsheetDownload($input: RefundRequestSpreadsheetDownloadMutationInput!) {
  refundRequestSpreadsheetDownload(input: $input) {
    ...RefundRequestSpreadsheetDownloadMutationPayloadFragment
  }
}

Variables

{"input": RefundRequestSpreadsheetDownloadMutationInput}

Response

{
  "data": {
    "refundRequestSpreadsheetDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 123
    }
  }
}

Mutations

`remittanceAdviceUpdate`

Description

Update Remittance Advice. Only accessible to operator admin users.

Response

Returns a RemittanceAdviceUpdateMutationPayload

Arguments

Name	Description
`input` - `RemittanceAdviceUpdateMutationInput!`	Parameters for RemittanceAdviceUpdateMutation

Example

Query

mutation remittanceAdviceUpdate($input: RemittanceAdviceUpdateMutationInput!) {
  remittanceAdviceUpdate(input: $input) {
    ...RemittanceAdviceUpdateMutationPayloadFragment
  }
}

Variables

{"input": RemittanceAdviceUpdateMutationInput}

Response

{
  "data": {
    "remittanceAdviceUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "remittanceAdvice": RemittanceAdvice,
      "status": 123
    }
  }
}

Mutations

`remittancesRelease`

Description

Remittances Release. Only accessible to operator admin users.

Response

Returns a RemittancesReleaseMutationPayload

Arguments

Name	Description
`input` - `RemittancesReleaseMutationInput!`	Parameters for RemittancesReleaseMutation

Example

Query

mutation remittancesRelease($input: RemittancesReleaseMutationInput!) {
  remittancesRelease(input: $input) {
    ...RemittancesReleaseMutationPayloadFragment
  }
}

Variables

{"input": RemittancesReleaseMutationInput}

Response

{
  "data": {
    "remittancesRelease": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "remittances": [Remittance],
      "status": 987
    }
  }
}

Mutations

`resetUserPassword`

Description

Sends a reset password email to the logged in user.

Response

Returns a ResetUserPasswordMutationPayload

Arguments

Name	Description
`input` - `ResetUserPasswordMutationInput!`	Parameters for ResetUserPasswordMutation

Example

Query

mutation resetUserPassword($input: ResetUserPasswordMutationInput!) {
  resetUserPassword(input: $input) {
    ...ResetUserPasswordMutationPayloadFragment
  }
}

Variables

{"input": ResetUserPasswordMutationInput}

Response

{
  "data": {
    "resetUserPassword": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}

Mutations

`returnShipmentCreate`

Description

Create a return shipment for a refund request. Only accessible to operator and seller admin users.

Response

Returns a ReturnShipmentCreateMutationPayload

Arguments

Name	Description
`input` - `ReturnShipmentCreateMutationInput!`	Parameters for ReturnShipmentCreateMutation

Example

Query

mutation returnShipmentCreate($input: ReturnShipmentCreateMutationInput!) {
  returnShipmentCreate(input: $input) {
    ...ReturnShipmentCreateMutationPayloadFragment
  }
}

Variables

{"input": ReturnShipmentCreateMutationInput}

Response

{
  "data": {
    "returnShipmentCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "shipment": ReturnShipment,
      "status": 987
    }
  }
}

Mutations

`returnShipmentUpdate`

Description

Update a return shipment for a refund request. Only accessible to operator and seller admin users.

Response

Returns a ReturnShipmentUpdateMutationPayload

Arguments

Name	Description
`input` - `ReturnShipmentUpdateMutationInput!`	Parameters for ReturnShipmentUpdateMutation

Example

Query

mutation returnShipmentUpdate($input: ReturnShipmentUpdateMutationInput!) {
  returnShipmentUpdate(input: $input) {
    ...ReturnShipmentUpdateMutationPayloadFragment
  }
}

Variables

{"input": ReturnShipmentUpdateMutationInput}

Response

{
  "data": {
    "returnShipmentUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shipment": ReturnShipment,
      "status": 987
    }
  }
}

Mutations

`rithumApiKeyCreate`

Description

Generate Rithum API key for a Seller. Only accessible to operator and seller admin users.

Response

Returns a RithumAPIKeyCreateMutationPayload

Arguments

Name	Description
`input` - `RithumAPIKeyCreateMutationInput!`	Parameters for RithumAPIKeyCreateMutation

Example

Query

mutation rithumApiKeyCreate($input: RithumAPIKeyCreateMutationInput!) {
  rithumApiKeyCreate(input: $input) {
    ...RithumAPIKeyCreateMutationPayloadFragment
  }
}

Variables

{"input": RithumAPIKeyCreateMutationInput}

Response

{
  "data": {
    "rithumApiKeyCreate": {
      "apiKey": "abc123",
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "rithumApiKey": RithumAPIKey,
      "status": 987
    }
  }
}

Mutations

`sellerAdyenBillingPaymentMethodUpdate`

Description

Updates adyen billing payment method for seller. Only accessible to operator and seller admin users.

Response

Returns a SellerAdyenBillingPaymentMethodUpdateMutationPayload

Arguments

Name	Description
`input` - `SellerAdyenBillingPaymentMethodUpdateMutationInput!`	Parameters for SellerAdyenBillingPaymentMethodUpdateMutation

Example

Query

mutation sellerAdyenBillingPaymentMethodUpdate($input: SellerAdyenBillingPaymentMethodUpdateMutationInput!) {
  sellerAdyenBillingPaymentMethodUpdate(input: $input) {
    ...SellerAdyenBillingPaymentMethodUpdateMutationPayloadFragment
  }
}

Variables

{
  "input": SellerAdyenBillingPaymentMethodUpdateMutationInput
}

Response

{
  "data": {
    "sellerAdyenBillingPaymentMethodUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "response": AdyenResponse,
      "seller": Seller,
      "status": 123
    }
  }
}

Mutations

`sellerBraintreeBillingPaymentMethodUpdate`

Description

Updates braintree billing payment method for seller. Only accessible to operator and seller admin users.

Response

Returns a SellerBraintreeBillingPaymentMethodUpdateMutationPayload

Arguments

Name	Description
`input` - `SellerBraintreeBillingPaymentMethodUpdateMutationInput!`	Parameters for SellerBraintreeBillingPaymentMethodUpdateMutation

Example

Query

mutation sellerBraintreeBillingPaymentMethodUpdate($input: SellerBraintreeBillingPaymentMethodUpdateMutationInput!) {
  sellerBraintreeBillingPaymentMethodUpdate(input: $input) {
    ...SellerBraintreeBillingPaymentMethodUpdateMutationPayloadFragment
  }
}

Variables

{
  "input": SellerBraintreeBillingPaymentMethodUpdateMutationInput
}

Response

{
  "data": {
    "sellerBraintreeBillingPaymentMethodUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "seller": Seller,
      "status": 123
    }
  }
}

Mutations

`sellerCreate`

Description

Create prospective seller accounts. Only accessible to operator admin users.

Response

Returns a SellerCreateMutationPayload

Arguments

Name	Description
`input` - `SellerCreateMutationInput!`	Parameters for SellerCreateMutation

Example

Query

mutation sellerCreate($input: SellerCreateMutationInput!) {
  sellerCreate(input: $input) {
    ...SellerCreateMutationPayloadFragment
  }
}

Variables

{"input": SellerCreateMutationInput}

Response

{
  "data": {
    "sellerCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "seller": Seller,
      "status": 123,
      "user": User
    }
  }
}

Mutations

`sellerSendInvoiceToCustomer`

Description

Sends an invoice to the customer. Only accessible to operator and seller admin users.

Response

Returns a SellerSendInvoiceToCustomerMutationPayload

Arguments

Name	Description
`input` - `SellerSendInvoiceToCustomerMutationInput!`	Parameters for SellerSendInvoiceToCustomerMutation

Example

Query

mutation sellerSendInvoiceToCustomer($input: SellerSendInvoiceToCustomerMutationInput!) {
  sellerSendInvoiceToCustomer(input: $input) {
    ...SellerSendInvoiceToCustomerMutationPayloadFragment
  }
}

Variables

{"input": SellerSendInvoiceToCustomerMutationInput}

Response

{
  "data": {
    "sellerSendInvoiceToCustomer": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`sellerSlaExportMetricMutation`

Description

Download seller sla metrics as a csv file. Only accessible to operator admin users.

Response

Returns a SellerSlaExportMetricMutationPayload

Arguments

Name	Description
`input` - `SellerSlaExportMetricMutationInput!`	Parameters for SellerSlaExportMetricMutation

Example

Query

mutation sellerSlaExportMetricMutation($input: SellerSlaExportMetricMutationInput!) {
  sellerSlaExportMetricMutation(input: $input) {
    ...SellerSlaExportMetricMutationPayloadFragment
  }
}

Variables

{"input": SellerSlaExportMetricMutationInput}

Response

{
  "data": {
    "sellerSlaExportMetricMutation": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 123
    }
  }
}

Mutations

`sellerUpdate`

Description

Update a seller. Requires an authenticated user to use mutation. Only accessible to operator and seller admin users.

Response

Returns a SellerUpdateMutationPayload

Arguments

Name	Description
`input` - `SellerUpdateMutationInput!`	Parameters for SellerUpdateMutation

Example

Query

mutation sellerUpdate($input: SellerUpdateMutationInput!) {
  sellerUpdate(input: $input) {
    ...SellerUpdateMutationPayloadFragment
  }
}

Variables

{"input": SellerUpdateMutationInput}

Response

{
  "data": {
    "sellerUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "seller": Seller,
      "status": 123
    }
  }
}

Mutations

`sendgridSettingsCreateOrUpdate`

Description

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

Response

Returns a SendgridSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `SendgridSettingsCreateOrUpdateMutationInput!`	Parameters for SendgridSettingsCreateOrUpdateMutation

Example

Query

mutation sendgridSettingsCreateOrUpdate($input: SendgridSettingsCreateOrUpdateMutationInput!) {
  sendgridSettingsCreateOrUpdate(input: $input) {
    ...SendgridSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": SendgridSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "sendgridSettingsCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "sendgridSettings": SendgridSettings,
      "status": 987
    }
  }
}

Mutations

`sendgridSettingsDelete`

Description

Delete SendGrid settings. Only accessible to operator admin users.

Response

Returns a SendgridSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `SendgridSettingsDeleteMutationInput!`	Parameters for SendgridSettingsDeleteMutation

Example

Query

mutation sendgridSettingsDelete($input: SendgridSettingsDeleteMutationInput!) {
  sendgridSettingsDelete(input: $input) {
    ...SendgridSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": SendgridSettingsDeleteMutationInput}

Response

{
  "data": {
    "sendgridSettingsDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "sendgridSettings": SendgridSettings,
      "status": 123
    }
  }
}

Mutations

`sessionLocationInformationUpdateMutation`

Description

Updates the user session with location information.

Response

Returns a SessionLocationInformationUpdateMutationPayload

Arguments

Name	Description
`input` - `SessionLocationInformationUpdateMutationInput!`	Parameters for SessionLocationInformationUpdateMutation

Example

Query

mutation sessionLocationInformationUpdateMutation($input: SessionLocationInformationUpdateMutationInput!) {
  sessionLocationInformationUpdateMutation(input: $input) {
    ...SessionLocationInformationUpdateMutationPayloadFragment
  }
}

Variables

{"input": SessionLocationInformationUpdateMutationInput}

Response

{
  "data": {
    "sessionLocationInformationUpdateMutation": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "locationSlug": "abc123",
      "postcode": "abc123",
      "regionName": "abc123",
      "showLocationModal": "xyz789",
      "status": 987
    }
  }
}

Mutations

`sessionTokenLogOut`

Description

Logs a user out, based on a session token. Only accessible to operator and seller admin users.

Response

Returns a SessionTokenLogOutMutationPayload

Arguments

Name	Description
`input` - `SessionTokenLogOutMutationInput!`	Parameters for SessionTokenLogOutMutation

Example

Query

mutation sessionTokenLogOut($input: SessionTokenLogOutMutationInput!) {
  sessionTokenLogOut(input: $input) {
    ...SessionTokenLogOutMutationPayloadFragment
  }
}

Variables

{"input": SessionTokenLogOutMutationInput}

Response

{
  "data": {
    "sessionTokenLogOut": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "loggedOut": true,
      "status": 987
    }
  }
}

Mutations

`shipmentAddressCreate`

Description

Create an address to ship items from. Only accessible to operator and seller admin users.

Response

Returns a ShipmentAddressCreateMutationPayload

Arguments

Name	Description
`input` - `ShipmentAddressCreateMutationInput!`	Parameters for ShipmentAddressCreateMutation

Example

Query

mutation shipmentAddressCreate($input: ShipmentAddressCreateMutationInput!) {
  shipmentAddressCreate(input: $input) {
    ...ShipmentAddressCreateMutationPayloadFragment
  }
}

Variables

{"input": ShipmentAddressCreateMutationInput}

Response

{
  "data": {
    "shipmentAddressCreate": {
      "address": Address,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`shipmentAddressSort`

Description

Change the sort order for a retailer's shipment addresses. Only accessible to operator and seller admin users.

Response

Returns a ShipmentAddressSortMutationPayload

Arguments

Name	Description
`input` - `ShipmentAddressSortMutationInput!`	Parameters for ShipmentAddressSortMutation

Example

Query

mutation shipmentAddressSort($input: ShipmentAddressSortMutationInput!) {
  shipmentAddressSort(input: $input) {
    ...ShipmentAddressSortMutationPayloadFragment
  }
}

Variables

{"input": ShipmentAddressSortMutationInput}

Response

{
  "data": {
    "shipmentAddressSort": {
      "addresses": [Address],
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`shipmentCreate`

Description

Create a shipment. Only accessible to operator and seller admin users.

Response

Returns a ShipmentCreateMutationPayload

Arguments

Name	Description
`input` - `ShipmentCreateMutationInput!`	Parameters for ShipmentCreateMutation

Example

Query

mutation shipmentCreate($input: ShipmentCreateMutationInput!) {
  shipmentCreate(input: $input) {
    ...ShipmentCreateMutationPayloadFragment
  }
}

Variables

{"input": ShipmentCreateMutationInput}

Response

{
  "data": {
    "shipmentCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shipment": Shipment,
      "status": 987
    }
  }
}

Mutations

`shipmentStatusCreate`

Description

Add a status to the shipment status log. Only accessible to operator and seller admin users.

Response

Returns a ShipmentStatusCreateMutationPayload

Arguments

Name	Description
`input` - `ShipmentStatusCreateMutationInput!`	Parameters for ShipmentStatusCreateMutation

Example

Query

mutation shipmentStatusCreate($input: ShipmentStatusCreateMutationInput!) {
  shipmentStatusCreate(input: $input) {
    ...ShipmentStatusCreateMutationPayloadFragment
  }
}

Variables

{"input": ShipmentStatusCreateMutationInput}

Response

{
  "data": {
    "shipmentStatusCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "shipmentStatus": ShipmentStatus,
      "status": 123
    }
  }
}

Mutations

`shipmentUpdate`

Description

Update a shipment. Only accessible to operator and seller admin users.

Response

Returns a ShipmentUpdateMutationPayload

Arguments

Name	Description
`input` - `ShipmentUpdateMutationInput!`	Parameters for ShipmentUpdateMutation

Example

Query

mutation shipmentUpdate($input: ShipmentUpdateMutationInput!) {
  shipmentUpdate(input: $input) {
    ...ShipmentUpdateMutationPayloadFragment
  }
}

Variables

{"input": ShipmentUpdateMutationInput}

Response

{
  "data": {
    "shipmentUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shipment": Shipment,
      "status": 123
    }
  }
}

Mutations

`shippingOptionDelete`

Description

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

Response

Returns a ShippingOptionDeleteMutationPayload

Arguments

Name	Description
`input` - `ShippingOptionDeleteMutationInput!`	Parameters for ShippingOptionDeleteMutation

Example

Query

mutation shippingOptionDelete($input: ShippingOptionDeleteMutationInput!) {
  shippingOptionDelete(input: $input) {
    ...ShippingOptionDeleteMutationPayloadFragment
  }
}

Variables

{"input": ShippingOptionDeleteMutationInput}

Response

{
  "data": {
    "shippingOptionDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shippingOption": ShippingOption,
      "status": 987
    }
  }
}

Mutations

`shippingOptionUpsert`

Description

Create or update shipping rules. Only accessible to operator and seller admin users.

Response

Returns a ShippingOptionUpsertMutationPayload

Arguments

Name	Description
`input` - `ShippingOptionUpsertMutationInput!`	Parameters for ShippingOptionUpsertMutation

Example

Query

mutation shippingOptionUpsert($input: ShippingOptionUpsertMutationInput!) {
  shippingOptionUpsert(input: $input) {
    ...ShippingOptionUpsertMutationPayloadFragment
  }
}

Variables

{"input": ShippingOptionUpsertMutationInput}

Response

{
  "data": {
    "shippingOptionUpsert": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "shippingOption": ShippingOption,
      "status": 987
    }
  }
}

Mutations

`shippingRateCreateOrUpdate`

Description

Create or Update Shipping Rates. Only accessible to operator and seller admin users.

Response

Returns a ShippingRateCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `ShippingRateCreateOrUpdateMutationInput!`	Parameters for ShippingRateCreateOrUpdateMutation

Example

Query

mutation shippingRateCreateOrUpdate($input: ShippingRateCreateOrUpdateMutationInput!) {
  shippingRateCreateOrUpdate(input: $input) {
    ...ShippingRateCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": ShippingRateCreateOrUpdateMutationInput}

Response

{
  "data": {
    "shippingRateCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shippingRate": ShippingRate,
      "status": 123
    }
  }
}

Mutations

`shippingRateDelete`

Description

Delete a shipping rate. Only accessible to operator and seller admin users.

Response

Returns a ShippingRateDeleteMutationPayload

Arguments

Name	Description
`input` - `ShippingRateDeleteMutationInput!`	Parameters for ShippingRateDeleteMutation

Example

Query

mutation shippingRateDelete($input: ShippingRateDeleteMutationInput!) {
  shippingRateDelete(input: $input) {
    ...ShippingRateDeleteMutationPayloadFragment
  }
}

Variables

{"input": ShippingRateDeleteMutationInput}

Response

{
  "data": {
    "shippingRateDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "shippingRate": ShippingRate,
      "status": 987
    }
  }
}

Mutations

`shippingZoneCreateOrUpdate`

Description

Create or Update Shipping Zones. Only accessible to operator and seller admin users.

Response

Returns a ShippingZoneCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `ShippingZoneCreateOrUpdateMutationInput!`	Parameters for ShippingZoneCreateOrUpdateMutation

Example

Query

mutation shippingZoneCreateOrUpdate($input: ShippingZoneCreateOrUpdateMutationInput!) {
  shippingZoneCreateOrUpdate(input: $input) {
    ...ShippingZoneCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": ShippingZoneCreateOrUpdateMutationInput}

Response

{
  "data": {
    "shippingZoneCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shippingZone": ShippingZone,
      "status": 123
    }
  }
}

Mutations

`shippingZoneDelete`

Description

Delete a shipping zone. Only accessible to operator and seller admin users.

Response

Returns a ShippingZoneDeleteMutationPayload

Arguments

Name	Description
`input` - `ShippingZoneDeleteMutationInput!`	Parameters for ShippingZoneDeleteMutation

Example

Query

mutation shippingZoneDelete($input: ShippingZoneDeleteMutationInput!) {
  shippingZoneDelete(input: $input) {
    ...ShippingZoneDeleteMutationPayloadFragment
  }
}

Variables

{"input": ShippingZoneDeleteMutationInput}

Response

{
  "data": {
    "shippingZoneDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "shippingZone": ShippingZone,
      "status": 123
    }
  }
}

Mutations

`shippingZoneSpreadsheetDownload`

Description

start a background job to download shipping zone postcodes. Only accessible to operator and seller admin users.

Response

Returns a ShippingZoneSpreadsheetDownloadMutationPayload

Arguments

Name	Description
`input` - `ShippingZoneSpreadsheetDownloadMutationInput!`	Parameters for ShippingZoneSpreadsheetDownloadMutation

Example

Query

mutation shippingZoneSpreadsheetDownload($input: ShippingZoneSpreadsheetDownloadMutationInput!) {
  shippingZoneSpreadsheetDownload(input: $input) {
    ...ShippingZoneSpreadsheetDownloadMutationPayloadFragment
  }
}

Variables

{"input": ShippingZoneSpreadsheetDownloadMutationInput}

Response

{
  "data": {
    "shippingZoneSpreadsheetDownload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "export": ImportExport,
      "shippingZone": ShippingZone,
      "status": 987
    }
  }
}

Mutations

`shippitCredentialsUpsert`

Description

Update Shippit API credentials. Only accessible to operator and seller admin users.

Response

Returns a ShippitCredentialsUpsertMutationPayload

Arguments

Name	Description
`input` - `ShippitCredentialsUpsertMutationInput!`	Parameters for ShippitCredentialsUpsertMutation

Example

Query

mutation shippitCredentialsUpsert($input: ShippitCredentialsUpsertMutationInput!) {
  shippitCredentialsUpsert(input: $input) {
    ...ShippitCredentialsUpsertMutationPayloadFragment
  }
}

Variables

{"input": ShippitCredentialsUpsertMutationInput}

Response

{
  "data": {
    "shippitCredentialsUpsert": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "shippitCredentials": ShippitCredentials,
      "status": 123
    }
  }
}

Mutations

`stockLevelsSpreadsheetDownload`

Description

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

Response

Returns a StockLevelsSpreadsheetDownloadMutationPayload

Arguments

Name	Description
`input` - `StockLevelsSpreadsheetDownloadMutationInput!`	Parameters for StockLevelsSpreadsheetDownloadMutation

Example

Query

mutation stockLevelsSpreadsheetDownload($input: StockLevelsSpreadsheetDownloadMutationInput!) {
  stockLevelsSpreadsheetDownload(input: $input) {
    ...StockLevelsSpreadsheetDownloadMutationPayloadFragment
  }
}

Variables

{"input": StockLevelsSpreadsheetDownloadMutationInput}

Response

{
  "data": {
    "stockLevelsSpreadsheetDownload": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "export": ImportExport,
      "status": 987
    }
  }
}

Mutations

`stockLevelsSpreadsheetUpload`

Description

start a background job to update stock levels of variants or inventories. Only accessible to operator and seller admin users.

Response

Returns a StockLevelsSpreadsheetUploadMutationPayload

Arguments

Name	Description
`input` - `StockLevelsSpreadsheetUploadMutationInput!`	Parameters for StockLevelsSpreadsheetUploadMutation

Example

Query

mutation stockLevelsSpreadsheetUpload($input: StockLevelsSpreadsheetUploadMutationInput!) {
  stockLevelsSpreadsheetUpload(input: $input) {
    ...StockLevelsSpreadsheetUploadMutationPayloadFragment
  }
}

Variables

{"input": StockLevelsSpreadsheetUploadMutationInput}

Response

{
  "data": {
    "stockLevelsSpreadsheetUpload": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "import": ImportExport,
      "status": 987
    }
  }
}

Mutations

`taxCodeCreateOrUpdate`

Description

Create or update tax codes. Only accessible to operator admin users.

Response

Returns a TaxCodeCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `TaxCodeCreateOrUpdateMutationInput!`	Parameters for TaxCodeCreateOrUpdateMutation

Example

Query

mutation taxCodeCreateOrUpdate($input: TaxCodeCreateOrUpdateMutationInput!) {
  taxCodeCreateOrUpdate(input: $input) {
    ...TaxCodeCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": TaxCodeCreateOrUpdateMutationInput}

Response

{
  "data": {
    "taxCodeCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123,
      "taxCode": TaxCode
    }
  }
}

Mutations

`taxonCreateOrUpdate`

Description

Create a Taxon if no ID is passed, otherwise updates existing Taxon. Only accessible to operator admin users.

Response

Returns a TaxonCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `TaxonCreateOrUpdateMutationInput!`	Parameters for TaxonCreateOrUpdateMutation

Example

Query

mutation taxonCreateOrUpdate($input: TaxonCreateOrUpdateMutationInput!) {
  taxonCreateOrUpdate(input: $input) {
    ...TaxonCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": TaxonCreateOrUpdateMutationInput}

Response

{
  "data": {
    "taxonCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987,
      "taxon": Taxon
    }
  }
}

Mutations

`userCreate`

Description

Create a mutable user. Only primary user for a seller can perform this. Only accessible to operator and seller admin users.

Response

Returns a UserCreateMutationPayload

Arguments

Name	Description
`input` - `UserCreateMutationInput!`	Parameters for UserCreateMutation

Example

Query

mutation userCreate($input: UserCreateMutationInput!) {
  userCreate(input: $input) {
    ...UserCreateMutationPayloadFragment
  }
}

Variables

{"input": UserCreateMutationInput}

Response

{
  "data": {
    "userCreate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 123,
      "user": User
    }
  }
}

Mutations

`userCurrencySelect`

Description

Updates the session currency.

Response

Returns a UserCurrencySelectMutationPayload

Arguments

Name	Description
`input` - `UserCurrencySelectMutationInput!`	Parameters for UserCurrencySelectMutation

Example

Query

mutation userCurrencySelect($input: UserCurrencySelectMutationInput!) {
  userCurrencySelect(input: $input) {
    ...UserCurrencySelectMutationPayloadFragment
  }
}

Variables

{"input": UserCurrencySelectMutationInput}

Response

{
  "data": {
    "userCurrencySelect": {
      "clientMutationId": "xyz789",
      "currencyChangedNotice": "abc123",
      "errors": [ValidationError],
      "selectedCurrency": Currency,
      "status": 987
    }
  }
}

Mutations

`userDelete`

Description

Delete a mutable user. Only primary user for a seller can perform this. Only accessible to operator and seller admin users.

Response

Returns a UserDeleteMutationPayload

Arguments

Name	Description
`input` - `UserDeleteMutationInput!`	Parameters for UserDeleteMutation

Example

Query

mutation userDelete($input: UserDeleteMutationInput!) {
  userDelete(input: $input) {
    ...UserDeleteMutationPayloadFragment
  }
}

Variables

{"input": UserDeleteMutationInput}

Response

{
  "data": {
    "userDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987
    }
  }
}

Mutations

`userLoginToken`

Description

Initiate a token login for a seller.

Returns a session token which can be used as an API key until it expires).

Response

Returns a UserLoginTokenMutationPayload

Arguments

Name	Description
`input` - `UserLoginTokenMutationInput!`	Parameters for UserLoginTokenMutation

Example

Query

mutation userLoginToken($input: UserLoginTokenMutationInput!) {
  userLoginToken(input: $input) {
    ...UserLoginTokenMutationPayloadFragment
  }
}

Variables

{"input": UserLoginTokenMutationInput}

Response

{
  "data": {
    "userLoginToken": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "sessionToken": "xyz789",
      "status": 123
    }
  }
}

Mutations

`userLoginUsername`

Description

Initiate a username/password login for a seller.

Returns a session token which can be used as an API key until it expires).

Response

Returns a UserLoginUsernameMutationPayload

Arguments

Name	Description
`input` - `UserLoginUsernameMutationInput!`	Parameters for UserLoginUsernameMutation

Example

Query

mutation userLoginUsername($input: UserLoginUsernameMutationInput!) {
  userLoginUsername(input: $input) {
    ...UserLoginUsernameMutationPayloadFragment
  }
}

Variables

{"input": UserLoginUsernameMutationInput}

Response

{
  "data": {
    "userLoginUsername": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "sessionToken": "xyz789",
      "status": 123
    }
  }
}

Mutations

`userUpdate`

Description

Update a mutable user. Requires an authenticated user to use mutation.

Response

Returns a UserUpdateMutationPayload

Arguments

Name	Description
`input` - `UserUpdateMutationInput!`	Parameters for UserUpdateMutation

Example

Query

mutation userUpdate($input: UserUpdateMutationInput!) {
  userUpdate(input: $input) {
    ...UserUpdateMutationPayloadFragment
  }
}

Variables

{"input": UserUpdateMutationInput}

Response

{
  "data": {
    "userUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123,
      "user": User
    }
  }
}

Mutations

`userUpdateFavouriteStore`

Description

Updates the favourite store of the current user.

Response

Returns a UserUpdateFavouriteStoreMutationPayload

Arguments

Name	Description
`input` - `UserUpdateFavouriteStoreMutationInput!`	Parameters for UserUpdateFavouriteStoreMutation

Example

Query

mutation userUpdateFavouriteStore($input: UserUpdateFavouriteStoreMutationInput!) {
  userUpdateFavouriteStore(input: $input) {
    ...UserUpdateFavouriteStoreMutationPayloadFragment
  }
}

Variables

{"input": UserUpdateFavouriteStoreMutationInput}

Response

{
  "data": {
    "userUpdateFavouriteStore": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "favouriteStoreAssigned": false,
      "status": 123
    }
  }
}

Mutations

`variantDelete`

Description

Delete a variant. Only accessible to operator and seller admin users.

Response

Returns a VariantDeleteMutationPayload

Arguments

Name	Description
`input` - `VariantDeleteMutationInput!`	Parameters for VariantDeleteMutation

Example

Query

mutation variantDelete($input: VariantDeleteMutationInput!) {
  variantDelete(input: $input) {
    ...VariantDeleteMutationPayloadFragment
  }
}

Variables

{"input": VariantDeleteMutationInput}

Response

{
  "data": {
    "variantDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987,
      "variant": Variant
    }
  }
}

Mutations

`variantUpdate`

Description

Update a variant. Only accessible to operator and seller admin users.

Response

Returns a VariantUpdateMutationPayload

Arguments

Name	Description
`input` - `VariantUpdateMutationInput!`	Parameters for VariantUpdateMutation

Example

Query

mutation variantUpdate($input: VariantUpdateMutationInput!) {
  variantUpdate(input: $input) {
    ...VariantUpdateMutationPayloadFragment
  }
}

Variables

{"input": VariantUpdateMutationInput}

Response

{
  "data": {
    "variantUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987,
      "variant": Variant
    }
  }
}

Mutations

`verifyAuthenticator`

Feature in development, subject to change without notice

Description

Verify an authenticator for a user or admin. Users and Admins can only do this for themselves. Only accessible to seller and operator admin users.

Response

Returns a VerifyAuthenticatorMutationPayload

Arguments

Name	Description
`input` - `VerifyAuthenticatorMutationInput!`	Parameters for VerifyAuthenticatorMutation

Example

Query

mutation verifyAuthenticator($input: VerifyAuthenticatorMutationInput!) {
  verifyAuthenticator(input: $input) {
    ...VerifyAuthenticatorMutationPayloadFragment
  }
}

Variables

{"input": VerifyAuthenticatorMutationInput}

Response

{
  "data": {
    "verifyAuthenticator": {
      "authenticator": TOTP,
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123
    }
  }
}

Mutations

`webhookCreate`

Description

Create a webhook. Only accessible to operator and seller admin users.

Response

Returns a WebhookCreateMutationPayload

Arguments

Name	Description
`input` - `WebhookCreateMutationInput!`	Parameters for WebhookCreateMutation

Example

Query

mutation webhookCreate($input: WebhookCreateMutationInput!) {
  webhookCreate(input: $input) {
    ...WebhookCreateMutationPayloadFragment
  }
}

Variables

{"input": WebhookCreateMutationInput}

Response

{
  "data": {
    "webhookCreate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123,
      "webhook": Webhook
    }
  }
}

Mutations

`webhookUpdate`

Description

Update a webhook. Only accessible to operator and seller admin users.

Response

Returns a WebhookUpdateMutationPayload

Arguments

Name	Description
`input` - `WebhookUpdateMutationInput!`	Parameters for WebhookUpdateMutation

Example

Query

mutation webhookUpdate($input: WebhookUpdateMutationInput!) {
  webhookUpdate(input: $input) {
    ...WebhookUpdateMutationPayloadFragment
  }
}

Variables

{"input": WebhookUpdateMutationInput}

Response

{
  "data": {
    "webhookUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987,
      "webhook": Webhook
    }
  }
}

Mutations

`yotpoSettingsCreateOrUpdate`

Description

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

Response

Returns a YotpoSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `YotpoSettingsCreateOrUpdateMutationInput!`	Parameters for YotpoSettingsCreateOrUpdateMutation

Example

Query

mutation yotpoSettingsCreateOrUpdate($input: YotpoSettingsCreateOrUpdateMutationInput!) {
  yotpoSettingsCreateOrUpdate(input: $input) {
    ...YotpoSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": YotpoSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "yotpoSettingsCreateOrUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987,
      "yotpoSettings": YotpoSettings
    }
  }
}

Mutations

`yotpoSettingsDelete`

Description

Delete Yotpo settings. Only accessible to operator admin users.

Response

Returns a YotpoSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `YotpoSettingsDeleteMutationInput!`	Parameters for YotpoSettingsDeleteMutation

Example

Query

mutation yotpoSettingsDelete($input: YotpoSettingsDeleteMutationInput!) {
  yotpoSettingsDelete(input: $input) {
    ...YotpoSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": YotpoSettingsDeleteMutationInput}

Response

{
  "data": {
    "yotpoSettingsDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123,
      "yotpoSettings": YotpoSettings
    }
  }
}

Mutations

`zipSettingsCreateOrUpdate`

Description

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

Response

Returns a ZipSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `ZipSettingsCreateOrUpdateMutationInput!`	Parameters for ZipSettingsCreateOrUpdateMutation

Example

Query

mutation zipSettingsCreateOrUpdate($input: ZipSettingsCreateOrUpdateMutationInput!) {
  zipSettingsCreateOrUpdate(input: $input) {
    ...ZipSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": ZipSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "zipSettingsCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123,
      "zipSettings": ZipSettings
    }
  }
}

Mutations

`zipSettingsDelete`

Description

Delete Zip settings. Only accessible to operator admin users.

Response

Returns a ZipSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `ZipSettingsDeleteMutationInput!`	Parameters for ZipSettingsDeleteMutation

Example

Query

mutation zipSettingsDelete($input: ZipSettingsDeleteMutationInput!) {
  zipSettingsDelete(input: $input) {
    ...ZipSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": ZipSettingsDeleteMutationInput}

Response

{
  "data": {
    "zipSettingsDelete": {
      "clientMutationId": "xyz789",
      "errors": [ValidationError],
      "status": 987,
      "zipSettings": ZipSettings
    }
  }
}

Mutations

`zoozSettingsCreateOrUpdate`

Description

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

Response

Returns a ZoozSettingsCreateOrUpdateMutationPayload

Arguments

Name	Description
`input` - `ZoozSettingsCreateOrUpdateMutationInput!`	Parameters for ZoozSettingsCreateOrUpdateMutation

Example

Query

mutation zoozSettingsCreateOrUpdate($input: ZoozSettingsCreateOrUpdateMutationInput!) {
  zoozSettingsCreateOrUpdate(input: $input) {
    ...ZoozSettingsCreateOrUpdateMutationPayloadFragment
  }
}

Variables

{"input": ZoozSettingsCreateOrUpdateMutationInput}

Response

{
  "data": {
    "zoozSettingsCreateOrUpdate": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 987,
      "zoozSettings": ZoozSettings
    }
  }
}

Mutations

`zoozSettingsDelete`

Description

Delete Zooz settings. Only accessible to operator admin users.

Response

Returns a ZoozSettingsDeleteMutationPayload

Arguments

Name	Description
`input` - `ZoozSettingsDeleteMutationInput!`	Parameters for ZoozSettingsDeleteMutation

Example

Query

mutation zoozSettingsDelete($input: ZoozSettingsDeleteMutationInput!) {
  zoozSettingsDelete(input: $input) {
    ...ZoozSettingsDeleteMutationPayloadFragment
  }
}

Variables

{"input": ZoozSettingsDeleteMutationInput}

Response

{
  "data": {
    "zoozSettingsDelete": {
      "clientMutationId": "abc123",
      "errors": [ValidationError],
      "status": 123,
      "zoozSettings": ZoozSettings
    }
  }
}

Types

APIKeyPrincipal

Description

Logged in principal from API Key

Fields

Field Name	Description
`emailAddress` - `String`
`name` - `String`
`seller` - `Seller`	The associated seller. Only if this user is a seller
`user` - `User`
`username` - `String`

Example

{
  "emailAddress": "xyz789",
  "name": "xyz789",
  "seller": Seller,
  "user": User,
  "username": "abc123"
}

Types

AccountSettings

Description

Site wide customization settings for a marketplace

Fields

Field Name	Description
`availableCurrencies` - `[Currency!]!`	Currency options that can be displayed to the user to set as the session currency.
`customPostFooterPoweredByHtml` - `String!`	Custom "Powered by" footer, if defined
`displayPoweredByText` - `Boolean!`	Display "Powered by" text?
`experimentalAiEnabled` - `Boolean!`	Pre-release AI features are enabled This field will go away when the AI features are released.
`id` - `ID!`
`requireLoginToViewFrontend` - `Boolean!`	If true requires the user to be logged in to view any frontend pages
`useMarketplacerFrontend` - `Boolean!`

Example

{
  "availableCurrencies": [Currency],
  "customPostFooterPoweredByHtml": "xyz789",
  "displayPoweredByText": false,
  "experimentalAiEnabled": false,
  "id": 4,
  "requireLoginToViewFrontend": true,
  "useMarketplacerFrontend": false
}

Types

ActivityLogDownloadMutationInput

Description

Autogenerated input type of ActivityLogDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`contextualHistoryIds` - `[ID!]!`	Contextual History IDs for the needed download. Default = `[]`

Example

{
  "clientMutationId": "abc123",
  "contextualHistoryIds": [4]
}

Types

ActivityLogDownloadMutationPayload

Description

Autogenerated return type of ActivityLogDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 987
}

Types

AddCartItemInput

Description

Arguments for finding variants and adding them to a cart.

Fields

Input Field	Description
`quantity` - `Int!`	Update the quantity of the item held in the cart to this number.
`deliveryMethod` - `DeliveryMethodEnum`	The way in which the buyer will receive the good or service. Default = `null`
`variantBarcode` - `String`	Barcodes of variants to add to the cart. The given barcodes must be unique. If a barcode is associated with multiple variants, it will raise an error. Default = `""`
`variantId` - `ID`	IDs of the variants to add to the cart. Default = `""`
`formData` - `JSON`	Custom form data to add to the cart

Example

{
  "quantity": 123,
  "deliveryMethod": "DELIVER",
  "variantBarcode": "xyz789",
  "variantId": 4,
  "formData": {}
}

Types

Address

Description

All information necessary for a complete address.

Fields

Field Name	Description
`address` - `String!`	Building number, unit number (optional), and street
`city` - `String!`
`country` - `Country!`
`fullAddress` - `String!`	Full address of the seller
`id` - `ID!`
`lat` - `Float`	Latitude of an address.
`lng` - `Float`	Longitude of an address.
`location` - `String`	Latitude and longitude of the seller
`mapUrl` - `String`	Url showing the location of the seller on google maps
`postcode` - `String!`	Also known as 'zip code'.
`state` - `State`
`subaddress` - `String`	Second line for address info. Sometimes used for apartment number or something similar

Example

{
  "address": "abc123",
  "city": "abc123",
  "country": Country,
  "fullAddress": "xyz789",
  "id": "4",
  "lat": 123.45,
  "lng": 123.45,
  "location": "xyz789",
  "mapUrl": "abc123",
  "postcode": "xyz789",
  "state": State,
  "subaddress": "xyz789"
}

Types

AddressGeolocation

Description

Coordinates and their associated DB ID

Fields

Field Name	Description
`id` - `ID!`
`lat` - `Float!`	Latitude
`lng` - `Float!`	Longitude

Example

{"id": "4", "lat": 987.65, "lng": 987.65}

Types

AddressInput

Description

Input attributes for creating or updating an address.

Fields

Input Field	Description
`address` - `String`	Building number, unit number, and street. Required for creation.
`city` - `String`	Required for creation.
`country` - `CountryInput`	An identifying value for looking up the relevant country. Can be a DB ID or two-character country abbreviation. Defaults to the sites home country.
`id` - `ID`	Required for update.
`postcode` - `String`	Required for creation.
`state` - `StateInput`	Required for creation.
`subaddress` - `String`	Second line for address info. Sometimes used for apartment number or something similar. Required for creation.

Example

{
  "address": "abc123",
  "city": "xyz789",
  "country": CountryInput,
  "id": 4,
  "postcode": "xyz789",
  "state": StateInput,
  "subaddress": "xyz789"
}

Types

AddresssConnection

Description

The connection type for Address.

Fields

Field Name	Description
`edges` - `[AddresssEdge]`	A list of edges.
`nodes` - `[Address]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AddresssEdge],
  "nodes": [Address],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

AddresssEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Address`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Address
}

Types

Adjustment

Description

Adjustments to a line item or invoice, e.g. promotion discounts, fees, etc.

Fields

Field Name	Description
`adjustmentType` - `AdjustmentTypeEnum`
`amountCents` - `Int`	The amount adjusted. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountFormatted` - `String`	The amount adjusted. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`amountToWithholdFromSellerRemittanceCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountToWithholdFromSellerRemittanceFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`appliesTo` - `AdjustmentAppliesToEnum`	The type of discount this adjustment applies to
`description` - `String`	The description of the adjustment.
`id` - `ID!`

Example

{
  "adjustmentType": "PROMOTION",
  "amountCents": 987,
  "amountFormatted": "xyz789",
  "amountToWithholdFromSellerRemittanceCents": 123,
  "amountToWithholdFromSellerRemittanceFormatted": "xyz789",
  "appliesTo": "SUBTOTAL_DISCOUNT",
  "description": "xyz789",
  "id": "4"
}

Types

AdjustmentAppliesToEnum

Description

The target that the adjustment applies to.

Values

Enum Value	Description
`SUBTOTAL_DISCOUNT`	Applies the discount to the subtotal.
`FREE_SHIPPING_DISCOUNT`	Applies a free shipping discount.

Example

"SUBTOTAL_DISCOUNT"

Types

AdjustmentInput

Description

Apply one or more adjustments to a line item or invoice.

Fields

Input Field	Description
`amountCents` - `Int!`	Amount of the adjustment. Denominated in cents.
`amountToWithholdFromSellerRemittanceCents` - `Int!`	The amount to be remitted to the seller. Denominated in cents. Must be less than the absolute value of the amount
`description` - `String!`	The description of the adjustment.
`sourceId` - `ID`	Allows associating the adjustment with the source of the adjustment, e.g. the ID of the promotion.
`adjustmentType` - `AdjustmentTypeEnum!`	The type of adjustment, available options: PROMOTION, FEE.

Example

{
  "amountCents": 987,
  "amountToWithholdFromSellerRemittanceCents": 987,
  "description": "abc123",
  "sourceId": "4",
  "adjustmentType": "PROMOTION"
}

Types

AdjustmentTypeEnum

Description

The type of adjustment to apply.

Values

Enum Value	Description
`PROMOTION`	Promotion adjustment type.
`FEE`	Fee adjustment type

Example

"PROMOTION"

Types

Admin

Description

Properties of an admin

Fields

Field Name	Description
`emailAddress` - `String`	Email address
`id` - `ID!`
`name` - `String`	Name

Example

{
  "emailAddress": "abc123",
  "id": "4",
  "name": "xyz789"
}

Types

AdminLoginUsernameMutationInput

Description

Autogenerated input type of AdminLoginUsernameMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`username` - `String!`	The administrator's username or email address
`password` - `String!`	The administrator's password

Example

{
  "clientMutationId": "abc123",
  "username": "xyz789",
  "password": "abc123"
}

Types

AdminLoginUsernameMutationPayload

Description

Autogenerated return type of AdminLoginUsernameMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sessionToken` - `String`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "sessionToken": "abc123",
  "status": 987
}

Types

AdminOrUser

Types

Union Types
`Admin`
`User`

Example

Admin

Types

AdminRole

Description

Admin role

Fields

Field Name	Description
`adminCount` - `Int!`	Number of admins associated with this admin role
`description` - `String`	Description of the admin role
`id` - `ID!`
`legacyId` - `Int!`
`name` - `String!`	Name of the admin role
`permissions` - `[String!]!`	Permissions available to this admin role

Example

{
  "adminCount": 987,
  "description": "xyz789",
  "id": "4",
  "legacyId": 987,
  "name": "xyz789",
  "permissions": ["abc123"]
}

Types

AdminRoleCreateMutationInput

Description

Autogenerated input type of AdminRoleCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `AdminRoleInput!`

Example

{
  "clientMutationId": "xyz789",
  "attributes": AdminRoleInput
}

Types

AdminRoleCreateMutationPayload

Description

Autogenerated return type of AdminRoleCreateMutation.

Fields

Field Name	Description
`adminRole` - `AdminRole`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adminRole": AdminRole,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

AdminRoleDeleteMutationInput

Description

Autogenerated input type of AdminRoleDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the admin role

Example

{
  "clientMutationId": "abc123",
  "id": "4"
}

Types

AdminRoleDeleteMutationPayload

Description

Autogenerated return type of AdminRoleDeleteMutation.

Fields

Field Name	Description
`adminRole` - `AdminRole`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adminRole": AdminRole,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

AdminRoleInput

Fields

Input Field	Description
`name` - `String!`	Name of the admin role
`description` - `String!`	Description of the admin role
`permissions` - `[String!]!`	List of permissions associated to the admin role

Example

{
  "name": "abc123",
  "description": "abc123",
  "permissions": ["abc123"]
}

Types

AdminRoleUpdateInput

Description

Attributes for updating an admin role

Fields

Input Field	Description
`description` - `String`	Description of the admin role
`permissions` - `[String!]`	Permissions available to this admin role

Example

{
  "description": "abc123",
  "permissions": ["xyz789"]
}

Types

AdminRoleUpdateMutationInput

Description

Autogenerated input type of AdminRoleUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`adminRoleId` - `ID!`	ID of the admin role
`attributes` - `AdminRoleUpdateInput!`

Example

{
  "clientMutationId": "abc123",
  "adminRoleId": 4,
  "attributes": AdminRoleUpdateInput
}

Types

AdminRoleUpdateMutationPayload

Description

Autogenerated return type of AdminRoleUpdateMutation.

Fields

Field Name	Description
`adminRole` - `AdminRole`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adminRole": AdminRole,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

AdminRolesConnection

Description

The connection type for AdminRole.

Fields

Field Name	Description
`edges` - `[AdminRolesEdge]`	A list of edges.
`nodes` - `[AdminRole]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AdminRolesEdge],
  "nodes": [AdminRole],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

AdminRolesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AdminRole`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": AdminRole
}

Types

Advert

Description

An advert

Fields

Field Name	Description
`advertOptionValues` - `AdvertOptionValueConnection!`	This field returns option type values set to the advert.
Arguments `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.
`availability` - `[AdvertAvailabilityEnum!]!`	Availability of the advert
`baseDomesticShippingCost` - `Float`	The additional cost of shipping the advert domestically, which is added to the Sellers base domestic shipping rate.
`baseInternationalShippingCost` - `Float`	The additional cost of shipping the advert internationally, which is added to the Sellers base international shipping rate.
`bookingTerms` - `String`	Terms & conditions text to display on the advert.
`brand` - `Brand`
`brandBeforeMapping` - `[String!]!`	Brand labels before being mapped to a canonical brand. (Includes the original values for both unmapped and mapped brands)
`catalogRulesErrors` - `[CatalogRulesError!]`
`categorySuggestions` - `[AdvertCategorySuggestion!]`	AI-powered category suggestions, if any Experimental, will change without notice.
`code` - `String`	Optional product code for the advert.
`condition` - `AdvertConditionEnum!`
`createdAt` - `ISO8601DateTime!`
`customFormTemplate` - `CustomFormTemplate`	Custom form template information for the advert
`customIframeThumbnail` - `Image`	A thumbnail image for an associated customIframeUrl
`customIframeUrl` - `String`	A link to a video hosted on one of a number of supported custom domains. Contact Marketplacer support for a full list of supported domains.If supplying a customIframeUrl, you must also supply a customIframeThumbnail.
`description` - `String`	Description provided by seller as markdown
`descriptionHtml` - `String`	Description converted to HTML
`displayImage` - `Image`	Image to display on the advert tile.
`displayable` - `Boolean!`	Whether to display the given advert.
`documents` - `AdvertDocumentsConnection`	PDF documents for information on advert
Arguments `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.
`domesticShippingCost` - `Float`	Use `base_domestic_shipping_cost` instead.
`dropdownOptionValues` - `OptionalOptionValueConnection!`	This field returns option values from single-select option types. This field is deprecated in favour of AdvertOptionValues.
Arguments `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.
`editablePrice` - `Decimal`	Price used for editing by sellers
`editablePriceCents` - `Int`	Price used for editing by sellers Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`editablePriceFormatted` - `String`	Price used for editing by sellers In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`editableSalePrice` - `Decimal`	Price used for editing by sellers
`editableSalePriceCents` - `Int`	Price used for editing by sellers Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`editableSalePriceFormatted` - `String`	Price used for editing by sellers In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`errorMessages` - `[ErrorMessage!]!`
`externalId` - `String`	An ID that is managed the retailer.
`externalIds` - `[ExternalID!]!`	A collection of key / value pair external IDs that can be added to the Advert using externalIdUpsert and advertUpsert.
`featureOptionValues` - `OptionValueConnection!`	This field returns option values from multi-select option types. This field is deprecated in favour of AdvertOptionValues.
Arguments `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.
`freetextOptionValues` - `FreetextOptionValueConnection!`	This field returns values from free-text option types. This field is deprecated in favour of AdvertOptionValues.
Arguments `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.
`fullTitle` - `String!`	Title for display (may include Brand and Model Year depending on configuration)
`gender` - `AdvertGenderEnum`
`goldenProduct` - `GoldenProduct`	Golden Product associated to this advert
`hasDuplicateBarcodes` - `Boolean`	Do any of the variants have duplicate barcodes Only accessible to users: admin_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`hasFreeDomesticShipping` - `Boolean`
`hasFreeInternationalPostage` - `Boolean`	Use `has_free_international_shipping` instead.
`hasFreeInternationalShipping` - `Boolean`
`hasFreePostage` - `Boolean`	Use `has_free_domestic_shipping` instead.
`hasInvalidVariants` - `Boolean!`	Whether advert has invalid variants
`id` - `ID!`
`images` - `ImagesConnection!`
Arguments `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.
`internationalShippingCost` - `Float`	Use `base_international_shipping_cost` instead.
`internationalShippingEnabled` - `Boolean`
`isFeatured` - `Boolean`	Whether the advert is to be featured above other adverts. Only used in Full Stack configurations.
`isPromoted` - `Boolean`	Whether the advert is currently part of an active promotion.
`itemTaxRate` - `Decimal`	The individual item tax rate on advert.
`legacyId` - `Int!`	Human readable version of the ID.
`lowestOriginalPrice` - `String`	Lowest non-sale price available for the item.
`lowestOriginalPriceCents` - `Int`	Lowest non-sale price available for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use lowestOriginalPrice instead. This field will be removed no earlier than July 1st, 2025.
`lowestOriginalPriceInSessionCurrency` - `String`	Lowest non-sale price available for the item in session currency. Useful for display purpose only as all monetary transactions will be charged in the marketplace currency.
`lowestPrice` - `String`	Absolute lowest price (sale price or original price) available for the item.
`lowestPriceCents` - `Int`	Absolute lowest price (sale price or original price) available for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use lowestPrice instead. This field will be removed no earlier than July 1st, 2025.
`lowestPriceInSessionCurrency` - `String`	Absolute lowest price (sale price or original price) available for the item in session currency. Useful for display purpose only as all monetary transactions will be charged in the marketplace currency.
`maxPurchaseQuantity` - `Int`	Maximum purchase quantity allowed for successful checkout
`measurementPriceUnit` - `MeasurementUnit`	Price Unit as a Configurable Unit of Measure
`metadata` - `[Metadatum!]!`	Metadata key/values Only accessible to users: admin_authorized, seller_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`minPurchaseQuantity` - `Int`	Minimum purchase quantity required for successful checkout
`model` - `Model`	Represents an associated Golden Record as defined in the Central Product Database (CPD). An advert will only have an associated model if it was created as part of the CPD backfill process, otherwise it will be null.
`online` - `Boolean!`	The status of an advert, determined by the relationship of the advert and it's sellers online status
`originCountryCode` - `String`	Country of origin in ISO 2 format
`originalPriceFormatted` - `String`	Original price formatted as a string (e.g. 'From $30') Using this field may trigger significant slowdowns. Deprecated in favour of the `original_price_formatted` on ES Adverts
`pagePath` - `String!`
`priceType` - `AdvertPriceTypeEnum`	Used when the price of an advert can vary, e.g. prices starting from etc.
`priceUnit` - `AdvertPriceUnitEnum`	Unit of measure or time associated with the advert.
`productDetails` - `[KeyValue!]`	This field returns key-value pairs of single-select and free-text option type values. This field is deprecated in favour of AdvertOptionValues.
`productFeatures` - `[String!]`
`promotionText` - `String`	The name of the most recent active promotion that this advert is part of.
`published` - `Boolean!`	Whether seller published an advert.
`rating` - `AdvertRating`	Rating reviews
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the item.
`recommendedRetailPriceCents` - `Int`	The recommended retail price (RRP) for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`recommendedRetailPriceFormatted` - `String`	The recommended retail price (RRP) for the item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`requiresVetting` - `Boolean!`	Does this advert require vetting. (See "vetted" field) Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`requiresVettingAt` - `ISO8601DateTime`	Time when requires vetting is set to true Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`salePriceEndAt` - `ISO8601DateTime`	End of the period in which the sale price is valid (or null) Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`salePriceFormatted` - `String`	Sale price formatted as a string e.g. ('Now from $21') Using this field may trigger significant slowdowns. Deprecated in favour of the `sale_price_formatted` on ES Adverts
`salePriceStartAt` - `ISO8601DateTime`	Start of the period in which the sale price is valid (or null) Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`saleType` - `AdvertSaleTypeEnum`	The channels where the advert can be purchased, e.g. on-line, click and collect etc.
`secondaryTaxons` - `TaxonConnection!`	Additional taxons to permit the advert to appear in a wider variety of search results.
Arguments `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.
`seller` - `Seller!`
`shippingParcel` - `ShippingParcel`	The direct shipping parcel information for the advert
`shippingParcelToUse` - `ShippingParcel`	Either a direct parcel information or inferred from taxon
`sizeMatrix` - `SizeMatrix`	Brand Sizing Chart. Warning: this can be slow for many records.
`specifications` - `String`	Text descriptions of advert specifications.
`specificationsHtml` - `String`	HTML descriptions of advert specifications.
`statusText` - `String`	System generated value that represents the overall status of the advert, e.g. "Online" Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`taxCode` - `String`
`taxon` - `Taxon!`	The Taxon (or Category) that an Advert belongs to - eg. Bikes, Shoes, Wigs This field will error if we display an Advert that does not have a Taxon - ie. the Advert has been importedfrom an external source and not yet mapped to a Taxon. Deprecated in favour of taxonNullable. Will be removed 2022-05-01
`taxonBeforeMapping` - `[String!]!`	Taxon labels before being mapped to a canonical taxon. (Includes the original values for both unmapped and mapped taxons)
`taxonNullable` - `Taxon`	The Taxon (or Category) that an Advert belongs to - eg. Bikes, Shoes, Wigs.
`therapeuticGoodsLabellingEnabled` - `Boolean!`	Whether therapeutic goods labelling is enabled on variants.
`therapeuticGoodsLabellingVisible` - `Boolean!`	Whether therapeutic goods labelling is enabled on the vertical.
`title` - `String!`	Title of the advert, excludes auto appended fields like Brand.
`totalDomesticShippingCostCents` - `Int`	The total cost of shipping one item domestically. Denominated in cents. Each additional item in an order will incur the shipping cost returned in the baseDomesticShippingCost field
`totalInternationalShippingCostCents` - `Int`	The total cost of shipping one item internationally. Denominated in cents. Each additional item in an order will incur the shipping cost returned in the baseInternationalShippingCost field
`updatedAt` - `ISO8601DateTime!`
`url` - `String`
`variants` - `VariantConnection!`	Variants returned are ordered by position
Arguments `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. `displayableOnly` - `Boolean` Whether to only fetch variants that are displayable (e.g. are valid, have inventory available)
`vetted` - `Boolean!`	Has this advert been vetted. NOTE: Is only relevant if requiresVetting is true Only accessible to users: admin_authorized, seller_authorized, api_key_users. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`vettingRejected` - `Boolean!`	Whether the advert has undergone vetting and been rejected.
`vettingRejectedReason` - `String`	The reason why the advert was rejected.
`wholesalePrice` - `String`	The wholesale price for the item.
`wholesalePriceCents` - `Int`	The wholesale price for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`wholesalePriceFormatted` - `String`	The wholesale price for the item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`wholesalePromoPrice` - `Decimal`	Wholesale promo price of the advert
`wholesalePromoPriceCents` - `Int`	Wholesale promo price of the advert Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`wholesalePromoPriceEndAt` - `ISO8601DateTime`	End of the period in which the wholesale promo price is valid (or null)
`wholesalePromoPriceFormatted` - `String`	Wholesale promo price of the advert In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`wholesalePromoPriceStartAt` - `ISO8601DateTime`	Start of the period in which the wholesale promo price is valid (or null)
`year` - `Int`	When relevant, the model year of the product.
`youtubeVideoId` - `String`
`youtubeVideoUrl` - `String`

Example

{
  "advertOptionValues": AdvertOptionValueConnection,
  "availability": ["HIRE"],
  "baseDomesticShippingCost": 123.45,
  "baseInternationalShippingCost": 987.65,
  "bookingTerms": "xyz789",
  "brand": Brand,
  "brandBeforeMapping": ["abc123"],
  "catalogRulesErrors": [CatalogRulesError],
  "categorySuggestions": [AdvertCategorySuggestion],
  "code": "abc123",
  "condition": "NEW",
  "createdAt": ISO8601DateTime,
  "customFormTemplate": CustomFormTemplate,
  "customIframeThumbnail": Image,
  "customIframeUrl": "abc123",
  "description": "abc123",
  "descriptionHtml": "abc123",
  "displayImage": Image,
  "displayable": true,
  "documents": AdvertDocumentsConnection,
  "domesticShippingCost": 987.65,
  "dropdownOptionValues": OptionalOptionValueConnection,
  "editablePrice": Decimal,
  "editablePriceCents": 987,
  "editablePriceFormatted": "abc123",
  "editableSalePrice": Decimal,
  "editableSalePriceCents": 987,
  "editableSalePriceFormatted": "xyz789",
  "errorMessages": [ErrorMessage],
  "externalId": "xyz789",
  "externalIds": [ExternalID],
  "featureOptionValues": OptionValueConnection,
  "freetextOptionValues": FreetextOptionValueConnection,
  "fullTitle": "xyz789",
  "gender": "UNISEX",
  "goldenProduct": GoldenProduct,
  "hasDuplicateBarcodes": false,
  "hasFreeDomesticShipping": false,
  "hasFreeInternationalPostage": false,
  "hasFreeInternationalShipping": true,
  "hasFreePostage": false,
  "hasInvalidVariants": false,
  "id": "4",
  "images": ImagesConnection,
  "internationalShippingCost": 123.45,
  "internationalShippingEnabled": true,
  "isFeatured": false,
  "isPromoted": true,
  "itemTaxRate": Decimal,
  "legacyId": 123,
  "lowestOriginalPrice": "abc123",
  "lowestOriginalPriceCents": 123,
  "lowestOriginalPriceInSessionCurrency": "abc123",
  "lowestPrice": "xyz789",
  "lowestPriceCents": 987,
  "lowestPriceInSessionCurrency": "abc123",
  "maxPurchaseQuantity": 123,
  "measurementPriceUnit": MeasurementUnit,
  "metadata": [Metadatum],
  "minPurchaseQuantity": 987,
  "model": Model,
  "online": true,
  "originCountryCode": "xyz789",
  "originalPriceFormatted": "abc123",
  "pagePath": "abc123",
  "priceType": "FROM",
  "priceUnit": "METRE",
  "productDetails": [KeyValue],
  "productFeatures": ["abc123"],
  "promotionText": "xyz789",
  "published": true,
  "rating": AdvertRating,
  "recommendedRetailPrice": "abc123",
  "recommendedRetailPriceCents": 987,
  "recommendedRetailPriceFormatted": "abc123",
  "requiresVetting": true,
  "requiresVettingAt": ISO8601DateTime,
  "salePriceEndAt": ISO8601DateTime,
  "salePriceFormatted": "abc123",
  "salePriceStartAt": ISO8601DateTime,
  "saleType": "BUY_ONLINE",
  "secondaryTaxons": TaxonConnection,
  "seller": Seller,
  "shippingParcel": ShippingParcel,
  "shippingParcelToUse": ShippingParcel,
  "sizeMatrix": SizeMatrix,
  "specifications": "abc123",
  "specificationsHtml": "abc123",
  "statusText": "xyz789",
  "taxCode": "abc123",
  "taxon": Taxon,
  "taxonBeforeMapping": ["xyz789"],
  "taxonNullable": Taxon,
  "therapeuticGoodsLabellingEnabled": true,
  "therapeuticGoodsLabellingVisible": true,
  "title": "xyz789",
  "totalDomesticShippingCostCents": 123,
  "totalInternationalShippingCostCents": 123,
  "updatedAt": ISO8601DateTime,
  "url": "xyz789",
  "variants": VariantConnection,
  "vetted": true,
  "vettingRejected": false,
  "vettingRejectedReason": "xyz789",
  "wholesalePrice": "xyz789",
  "wholesalePriceCents": 123,
  "wholesalePriceFormatted": "xyz789",
  "wholesalePromoPrice": Decimal,
  "wholesalePromoPriceCents": 987,
  "wholesalePromoPriceEndAt": ISO8601DateTime,
  "wholesalePromoPriceFormatted": "xyz789",
  "wholesalePromoPriceStartAt": ISO8601DateTime,
  "year": 987,
  "youtubeVideoId": "abc123",
  "youtubeVideoUrl": "xyz789"
}

Types

AdvertAvailabilityEnum

Description

The availability of the product.

Values

Enum Value	Description
`HIRE`	For rentable items.
`CLASSIFIED`	Being sold by a private seller (i.e. not a store).
`IN_STORE`	Can be purchased in the store.
`BUY_ONLINE`	Can be purchased via the website.
`CLICK_AND_COLLECT`	Can be purchased via the website then picked up in store.

Example

"HIRE"

Types

AdvertCategorySuggestion

Description

An advert category suggestion generated by an AI.

Fields

Field Name	Description
`advert` - `Advert!`	The advert for which this suggestion has been generated.
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`taxon` - `Taxon`	The category which has been suggested.
`updatedAt` - `ISO8601DateTime!`
`validated` - `Boolean!`	Are we confident this is a good suggestion?
`validatorResult` - `String`	What did the validation AI say about this suggestion?

Example

{
  "advert": Advert,
  "createdAt": ISO8601DateTime,
  "id": 4,
  "taxon": Taxon,
  "updatedAt": ISO8601DateTime,
  "validated": true,
  "validatorResult": "xyz789"
}

Types

AdvertConditionEnum

Description

Condition of the product being advertised.

Values

Enum Value	Description
`NEW`
`USED`

Example

"NEW"

Types

AdvertConnection

Description

The connection type for Advert.

Fields

Field Name	Description
`edges` - `[AdvertEdge]`	A list of edges.
`nodes` - `[Advert]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AdvertEdge],
  "nodes": [Advert],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

AdvertDeleteMutationInput

Description

Autogenerated input type of AdvertDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the advert to mark as deleted

Example

{
  "clientMutationId": "abc123",
  "id": "4"
}

Types

AdvertDeleteMutationPayload

Description

Autogenerated return type of AdvertDeleteMutation.

Fields

Field Name	Description
`advert` - `Advert`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "advert": Advert,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AdvertDocument

Description

PDF documents relating to the advert

Fields

Field Name	Description
`filename` - `String`	The name of the PDF
`id` - `ID!`
`size` - `Int`	The file size of the attached document in bytes.
`url` - `String`	The Adverts attached PDF documents

Example

{
  "filename": "abc123",
  "id": 4,
  "size": 123,
  "url": "xyz789"
}

Types

AdvertDocumentInput

Description

Advert document upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.

Fields

Input Field	Description
`dataBase64` - `String`	The document data, base64 encoded.
`filename` - `String`	The filename that will be used to label this document.
`sourceUrl` - `String`	A URL from which the document data can be fetched.
`documentId` - `ID`	The ID from an existing document
`size` - `Int`	The file size of the document in bytes.

Example

{
  "dataBase64": "xyz789",
  "filename": "xyz789",
  "sourceUrl": "abc123",
  "documentId": "4",
  "size": 123
}

Types

AdvertDocumentsConnection

Description

The connection type for AdvertDocument.

Fields

Field Name	Description
`edges` - `[AdvertDocumentsEdge]`	A list of edges.
`nodes` - `[AdvertDocument]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AdvertDocumentsEdge],
  "nodes": [AdvertDocument],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

AdvertDocumentsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AdvertDocument`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": AdvertDocument
}

Types

AdvertDurationPeriodEnum

Description

Represents the length of an event broken up into periods of days.

Values

Enum Value	Description
`DAYS_0`	0 Days or field is null
`DAYS_1_TO_5`	1-5 Days
`DAYS_6_TO_10`	6-10 Days
`DAYS_11_TO_15`	11-15 Days
`DAYS_16_TO_19`	16-19 Days
`DAYS_20_PLUS`	20 Days or more

Example

"DAYS_0"

Types

AdvertEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Advert`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Advert
}

Types

AdvertFilterInput

Fields

Input Field	Description
`q` - `String`	Keywords to search for. (Currently Title and Product ID). Default = `null`
`brandIds` - `[ID!]`
`externalId` - `ExternalIDInput`	Select variants where the advert has a particular External ID. Default = `null`
`legacyIds` - `[Int!]`
`status` - `AdvertStatusEnum`
`taxonIds` - `[ID!]`
`title` - `String`
`year` - `Int`

Example

{
  "q": "abc123",
  "brandIds": [4],
  "externalId": ExternalIDInput,
  "legacyIds": [123],
  "status": "DISPLAYED",
  "taxonIds": ["4"],
  "title": "xyz789",
  "year": 987
}

Types

AdvertFilters

Description

Attributes for filtering adverts

Fields

Input Field	Description
`legacyId` - `Int`	Advert with matching marketplacer database ID
`barcode` - `String`	Variants with matching barcode
`sku` - `String`	Advert with variant with matching sku
`title` - `String`	Advert with matching title
`brandId` - `ID`	Advert with matching brand
`taxonId` - `ID`	Advert with matching category
`rejectedViaVetting` - `Boolean`	Advert that have been rejected via vetting
`status` - `AdvertStatusEnum`	Advert with matching status
`createdSince` - `ISO8601DateTime`	Select adverts created since this time. Default = `null`
`createdUntil` - `ISO8601DateTime`	Select adverts created until this time. Default = `null`
`withFailedCatalogRules` - `Boolean`	Adverts that have catalog rule errors

Example

{
  "legacyId": 123,
  "barcode": "abc123",
  "sku": "xyz789",
  "title": "xyz789",
  "brandId": 4,
  "taxonId": "4",
  "rejectedViaVetting": true,
  "status": "DISPLAYED",
  "createdSince": ISO8601DateTime,
  "createdUntil": ISO8601DateTime,
  "withFailedCatalogRules": false
}

Types

AdvertGenderEnum

Description

The intended gender of the product when applicable.

Values

Enum Value	Description
`UNISEX`
`MALE`
`FEMALE`

Example

"UNISEX"

Types

AdvertInput

Fields

Input Field	Description
`title` - `String`
`brandId` - `ID`
`brandMappings` - `[String!]`	Will create a source mapping and attempt auto mapping of brand. You can use either brandId or brandMappings but not both. brandMappings accepts a collection of strings, where the 1st successful match will be used. A successful match is where we have a match to an existing brand mapping, or the string matches the brand name exactly. NOTE: this was called map_brand in the v2 API.
`taxonId` - `ID`
`taxonMappings` - `[String!]`	Will create a source mapping and attempt auto mapping of taxon. You can use either taxonId or taxonMappings but not both. taxonMappings accepts a collection of strings, where the 1st successful match will be used. A successful match is where we have a match to an existing taxon mapping. NOTE: this was called map_taxon in the v2 API.
`description` - `String`
`price` - `String`
`salePrice` - `String`
`saleType` - `AdvertSaleTypeEnum`
`priceType` - `AdvertPriceTypeEnum`
`priceUnit` - `AdvertPriceUnitEnum`
`measurementPriceUnitId` - `ID`	The configurable measurement unit.
`specifications` - `String`
`productFeatures` - `[String!]`
`youtubeVideoUrl` - `String`
`customIframeUrl` - `String`
`code` - `String`	Optional product code for the advert.
`externalId` - `String`	Optional external id to identify the product
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`gender` - `AdvertGenderEnum`	Optional gender that is attributed to the product
`maxPurchaseQuantity` - `Int`	Maximum purchase quantity allowed for successful checkout
`minPurchaseQuantity` - `Int`	Minimum purchase quantity allowed for successful checkout
`baseDomesticShippingCost` - `String`	The additional cost of shipping the product domestically, which is added to the Sellers base domestic shipping rate.
`baseInternationalShippingCost` - `String`	The additional cost of shipping the product internationally, which is added to the Sellers base international shipping rate.
`attemptAutoPublish` - `Boolean`
`vetted` - `Boolean`
`vettingRejectedReason` - `String`
`customIframeThumbnail` - `ImageInput`
`variants` - `[VariantInput!]`
`images` - `[ImageInput!]`
`documents` - `[AdvertDocumentInput!]`	PDF documents relating to the advert
`featureOptionValueIds` - `[ID!]`	DEPRECATED: This argument is deprecated in favour of AdvertOptionValues. Option value ids for multi-select option types
`productDetails` - `[KeyValueInput!]`	DEPRECATED: This argument is deprecated in favour of AdvertOptionValues. Key-value pairs of single-select and free-text option type values.
`advertOptionValues` - `[AdvertOptionValueInput!]`	Advert option values of the advert. If this argument is given, advert option values will be updated to match the input and delete the missing ones.
`shippingParcelAttributes` - `ShippingParcelInput`
`recommendedRetailPrice` - `String`
`wholesalePrice` - `String`
`salePriceStartAt` - `ISO8601DateTime`
`salePriceEndAt` - `ISO8601DateTime`
`wholesalePromoPrice` - `String`
`wholesalePromoPriceStartAt` - `ISO8601DateTime`
`wholesalePromoPriceEndAt` - `ISO8601DateTime`
`therapeuticGoodsLabellingEnabled` - `Boolean`
`taxCode` - `String`
`itemTaxRate` - `Decimal`
`hasFreeDomesticShipping` - `Boolean`

Example

{
  "title": "xyz789",
  "brandId": "4",
  "brandMappings": ["xyz789"],
  "taxonId": 4,
  "taxonMappings": ["xyz789"],
  "description": "abc123",
  "price": "abc123",
  "salePrice": "xyz789",
  "saleType": "BUY_ONLINE",
  "priceType": "FROM",
  "priceUnit": "METRE",
  "measurementPriceUnitId": "4",
  "specifications": "xyz789",
  "productFeatures": ["xyz789"],
  "youtubeVideoUrl": "abc123",
  "customIframeUrl": "xyz789",
  "code": "abc123",
  "externalId": "xyz789",
  "metadata": [KeyValueInput],
  "externalIds": [KeyValueInput],
  "gender": "UNISEX",
  "maxPurchaseQuantity": 987,
  "minPurchaseQuantity": 123,
  "baseDomesticShippingCost": "abc123",
  "baseInternationalShippingCost": "abc123",
  "attemptAutoPublish": false,
  "vetted": true,
  "vettingRejectedReason": "xyz789",
  "customIframeThumbnail": ImageInput,
  "variants": [VariantInput],
  "images": [ImageInput],
  "documents": [AdvertDocumentInput],
  "featureOptionValueIds": [4],
  "productDetails": [KeyValueInput],
  "advertOptionValues": [AdvertOptionValueInput],
  "shippingParcelAttributes": ShippingParcelInput,
  "recommendedRetailPrice": "xyz789",
  "wholesalePrice": "abc123",
  "salePriceStartAt": ISO8601DateTime,
  "salePriceEndAt": ISO8601DateTime,
  "wholesalePromoPrice": "xyz789",
  "wholesalePromoPriceStartAt": ISO8601DateTime,
  "wholesalePromoPriceEndAt": ISO8601DateTime,
  "therapeuticGoodsLabellingEnabled": false,
  "taxCode": "abc123",
  "itemTaxRate": Decimal,
  "hasFreeDomesticShipping": false
}

Types

AdvertOptionValue

Description

Advert option value for an advert's option type supporting all field types.

Fields

Field Name	Description
`id` - `ID!`	ID for the value. This value is less likely to change when the field values are unchanged but cannot guaranty.
`optionType` - `OptionType!`	Option Type the value belongs to
`optionValue` - `OptionValue`	Option value for single-select or multi-select Option Type
`textValue` - `String`	Value for free-text Option Type

Example

{
  "id": 4,
  "optionType": OptionType,
  "optionValue": OptionValue,
  "textValue": "abc123"
}

Types

AdvertOptionValueConnection

Description

The connection type for AdvertOptionValue.

Fields

Field Name	Description
`edges` - `[AdvertOptionValueEdge]`	A list of edges.
`nodes` - `[AdvertOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AdvertOptionValueEdge],
  "nodes": [AdvertOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

AdvertOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AdvertOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": AdvertOptionValue
}

Types

AdvertOptionValueInput

Description

Input for updating an advert option value. Set only optionValueId for single-select and multi-select option types, and set only optionTypeId and textValue for a free-text option type.

Fields

Input Field	Description
`optionValueId` - `ID`	Option Value ID used for single-select and multi-select option types
`textValue` - `String`	Free-text value used for a free-text option type
`optionTypeId` - `ID`	Option Type ID required for a free-text option type

Example

{
  "optionValueId": "4",
  "textValue": "abc123",
  "optionTypeId": "4"
}

Types

AdvertPriceTypeEnum

Description

Labels for products or services with non-standard or non-fixed pricing.

Values

Enum Value	Description
`FROM`	For adverts with a minimum price, but whose final price may vary.
`POA`	Price On Application. For adverts whose price cannot be determined without first contacting the seller.

Example

"FROM"

Types

AdvertPriceUnitEnum

Description

Units of time or measurement by which products or services can be priced.

Values

Enum Value	Description
`METRE`
`SQUARE_METRE`
`CUBIC_METRE`
`PACK`
`KILOGRAM`
`LITRE`
`SQUARE_FEET`
`FEET`
`CUBIC_FEET`
`POUND`
`PER_HOUR`
`PER_DAY`
`PER_WEEK`
`PER_FORTNIGHT`
`PER_MONTH`

Example

"METRE"

Types

AdvertPublishedUpdateMutationInput

Description

Autogenerated input type of AdvertPublishedUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the advert
`published` - `Boolean!`

Example

{
  "clientMutationId": "xyz789",
  "id": "4",
  "published": true
}

Types

AdvertPublishedUpdateMutationPayload

Description

Autogenerated return type of AdvertPublishedUpdateMutation.

Fields

Field Name	Description
`advert` - `Advert`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "advert": Advert,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

AdvertRating

Description

rating data for Advert

Fields

Field Name	Description
`count` - `Int!`	The number of ratings that have been submitted
`externalId` - `String`	ID that belongs to this advert from the third party rating provider
`stars` - `Float!`	Averaged star-rating of all submitted reviews (1-5)

Example

{
  "count": 987,
  "externalId": "xyz789",
  "stars": 987.65
}

Types

AdvertSaleTypeEnum

Description

The type of transaction permitted for a given advert.

Values

Enum Value	Description
`BUY_ONLINE`	Can be purchased via the website or other means.
`BUY_ONLINE_ONLY`	Can be purchased exclusively via the website.
`BUY_ONLINE_OR_CLICK_AND_COLLECT`	Can be purchased via the website and can be delivered or picked up in store.
`CLICK_AND_COLLECT`	Can be purchased via the website then picked up in store.
`CLASSIFIED`	Being sold by a private seller (i.e. not a store).
`HIRE`	For rentable items.
`IN_STORE`	Can only be purchased in the store.

Example

"BUY_ONLINE"

Types

AdvertSearchApplicableFilters

Description

Filter option data that can be used to build various filters that can be applied to the current advert search results returned when performing an advert search query

Fields

Field Name	Description
`availabilityFilterOptions` - `[AvailabilityFilterOption!]`
`brandFilterOptions` - `[BrandFilterOption!]`
`conditionFilterOptions` - `[ConditionFilterOption!]`
`genderFilterOptions` - `[GenderFilterOption!]`
`modelFilterOptions` - `[ModelFilterOption!]`
`optionTypeFilterOptions` - `[OptionTypeFilterOption!]`
`priceRange` - `PriceRange`
`ratingFilterOptions` - `[RatingFilterOption!]`
`sellerFilterOptions` - `[SellerFilterOption!]`
`taxonFilterOptions` - `[TaxonFilterOption!]`

Example

{
  "availabilityFilterOptions": [AvailabilityFilterOption],
  "brandFilterOptions": [BrandFilterOption],
  "conditionFilterOptions": [ConditionFilterOption],
  "genderFilterOptions": [GenderFilterOption],
  "modelFilterOptions": [ModelFilterOption],
  "optionTypeFilterOptions": [OptionTypeFilterOption],
  "priceRange": PriceRange,
  "ratingFilterOptions": [RatingFilterOption],
  "sellerFilterOptions": [SellerFilterOption],
  "taxonFilterOptions": [TaxonFilterOption]
}

Types

AdvertSearchInput

Description

Advert search arguments for building an ElasticSearch query.

Fields

Input Field	Description
`advertIds` - `[ID!]`	Request specific adverts by ID rather than query on advert attributes.
`bookingDateFrom` - `ISO8601DateTime`	Minimum date for booking availability. Specific to adverts for services that accept date-based reservations, such as hotels, tours, or events.
`bookingDateTo` - `ISO8601DateTime`	Minimum date for booking availability. Specific to adverts for services that accept date-based reservations, such as hotels, tours, or events.
`brandIds` - `[ID!]`	IDs of desired brands. See the Brand data type for more details.
`brandSlug` - `String`	Note: This field is now deprecated. Use brandSlugs field instead. Brand name as represented by a partial URL path with spaces replaced by '-'. Must match a brand name saved in the database and search index.
`brandSlugs` - `[String!]`	Brand names as represented by a partial URL path with spaces replaced by '-'. Must match brand names saved in the database and search index.
`collapse` - `Boolean`	Collapse like Adverts into a single result in the response.
`conditions` - `[AdvertConditionEnum!]`	The conditions of the product being advertised.
`countryIds` - `[ID!]`	IDs of the desired countries (i.e. where the sellers are based). See the Country data type for more details.
`durationPeriod` - `AdvertDurationPeriodEnum`	Indicates how long the advertised event lasts.
`genders` - `[AdvertGenderEnum!]`	Gender for whom the product is intended.
`locationSlug` - `String`	Location name, usually a city, as represented by a partial URL path with spaces replaced by '-'. Must match an indexed location name.
`maxPriceCents` - `Int`	Query adverts by maximum price denominated in cents.
`minPriceCents` - `Int`	Query adverts by minimum price denominated in cents.
`maxPrice` - `Float`	Query adverts by maximum price.
`minPrice` - `Float`	Query adverts by minimum price.
`optionValueIds` - `[ID!]`	IDs of desired option values (e.g. 'red', 'large'). See the OptionValue data type for more details.
`postcode` - `String`	The desired postcode, which matches according to the seller's address
`productIds` - `[ID!]`	IDs of the desired model. Use modelIds instead, this will be removed Dec 3 2021
`modelIds` - `[ID!]`	IDs of the desired model.
`modelSlug` - `String`	Model name as represented by a partial URL path with spaces replaced by '-'.
`keywordQuery` - `String`	Search advert text fields with one or more keywords.
`regionName` - `String`	For searching by region or state. Must be the abbreviation of the region/state name (e.g. use 'VIC', not 'Victoria').
`regionSlug` - `String`	Region, state, or province name as represented by a partial URL path with spaces replaced by '-'.
`saleTypes` - `[AdvertSaleTypeEnum!]`	The ways in which the good or service can be purchased and collected. Use availability instead, will be removed 1st Dec 2021
`availability` - `[AdvertAvailabilityEnum!]`	The ways in which the good or service can be purchased and collected.
`searchDistance` - `Int`	When location is included in the search, the radius (in kilometers or miles depending on country) from the geographic center of the queried location.
`searchType` - `AdvertSearchTypeEnum`	Whether your searching for adverts by retailer or by individual adverts.
`sellerIds` - `[ID!]`	IDs of the desired sellers. See the Seller data type for more details.
`sellerId` - `ID`	ID of the desired seller. See the Seller data type for more details.
`sortBy` - `AdvertSearchSortByEnum`	The attributes by which results can be sorted.
`taxonId` - `ID`	ID of the desired taxon. See the Taxon data type for more details.
`taxonSlug` - `String`	Taxon name as represented by a partial URL path with spaces replaced by '-'.
`taxonType` - `TaxonTypeEnum`	Based on the taxonType of the associated Taxon.
`updatedSince` - `ISO8601DateTime`	Only return adverts which have been updated since this date
`ratings` - `[String!]`	Rating selection for filtering
`pointInTime` - `String`	Point in time ID of the index at which the search performs. Point in time ID expires after 1 minute
`publishedTo` - `String`	Where advert is published to, either "marketplace" or "m_store"

Example

{
  "advertIds": [4],
  "bookingDateFrom": ISO8601DateTime,
  "bookingDateTo": ISO8601DateTime,
  "brandIds": ["4"],
  "brandSlug": "xyz789",
  "brandSlugs": ["xyz789"],
  "collapse": false,
  "conditions": ["NEW"],
  "countryIds": ["4"],
  "durationPeriod": "DAYS_0",
  "genders": ["UNISEX"],
  "locationSlug": "abc123",
  "maxPriceCents": 123,
  "minPriceCents": 987,
  "maxPrice": 987.65,
  "minPrice": 123.45,
  "optionValueIds": [4],
  "postcode": "xyz789",
  "productIds": [4],
  "modelIds": [4],
  "modelSlug": "abc123",
  "keywordQuery": "xyz789",
  "regionName": "xyz789",
  "regionSlug": "xyz789",
  "saleTypes": ["BUY_ONLINE"],
  "availability": ["HIRE"],
  "searchDistance": 987,
  "searchType": "RETAILER",
  "sellerIds": [4],
  "sellerId": "4",
  "sortBy": "SOONEST",
  "taxonId": 4,
  "taxonSlug": "abc123",
  "taxonType": "PRODUCT",
  "updatedSince": ISO8601DateTime,
  "ratings": ["xyz789"],
  "pointInTime": "abc123",
  "publishedTo": "abc123"
}

Types

AdvertSearchResponse

Description

Advert search response payload.

Fields

Field Name	Description
`adverts` - `AdvertsConnection!`
Arguments `after` - `String` Returns the elements in the list that come after the specified cursor. `first` - `Int` Returns the first n elements from the list. `skipLogViewed` - `Boolean`
`applicableFilters` - `AdvertSearchApplicableFilters`
`esAdverts` - `ESAdvertsConnection!`
Arguments `after` - `String` Returns the elements in the list that come after the specified cursor. `first` - `Int` Returns the first n elements from the list. `skipLogViewed` - `Boolean`
`pointInTime` - `String`	Point in time ID of the index at which the search performs. Point in time ID expires after 1 minute
`seoContent` - `SeoContent`

Example

{
  "adverts": AdvertsConnection,
  "applicableFilters": AdvertSearchApplicableFilters,
  "esAdverts": ESAdvertsConnection,
  "pointInTime": "abc123",
  "seoContent": SeoContent
}

Types

AdvertSearchSortByEnum

Description

Determines how results are sorted.

Values

Enum Value	Description
`SOONEST`	For adverts with dates and/or times, start with the advert whose date/time is closest to now followed by adverts further in the future.
`CHEAPEST`	Start with the advert with the lowest price.
`MOST_EXPENSIVE`	Start with the advert with the highest price.
`SALE`	Put adverts that are on sale at the top of results.
`LATEST`	Start with the most-recently-created advert followed by older adverts.
`ALPHABETICAL`	Sort alphabetically from numbers to 'a' to 'z'.
`ALPHABETICAL_DESC`	Sort alphabetically from 'z' to 'a' to numbers.
`NEAREST`	For searches that include location parameters, use the ElasticSearch relevance score, but include proximity of the seller to the queried location to calculate that score (closer seller equals higher score).
`DEFAULT`	The order of advert results when a sort type isn't specified. Put featured adverts at the top, ordering featured and non-featured adverts by the ElasticSearch relevance score.
`LOWEST_RATING`	Start with the advert with the lowest rating.
`HIGHEST_RATING`	Start with the advert with the highest rating.

Example

"SOONEST"

Types

AdvertSearchTypeEnum

Description

Determines the shape of the results data.

Values

Enum Value	Description
`RETAILER`	Search results are aggregated by seller.
`ADVERT`	Search results are returned as individual adverts.

Example

"RETAILER"

Types

AdvertSettings

Description

Site wide advert settings for a marketplace

Fields

Field Name	Description
`allowedSaleTypes` - `[AdvertSaleTypeEnum!]`
`autoMappingEnabled` - `Boolean!`	If true, advert auto mapping feature is enabled.
`defaultSaleType` - `AdvertSaleTypeEnum`
`freeTextVariantOptionTypeEnabled` - `Boolean!`	If true, allows the use of free-text and multi-select variant option types.
`id` - `ID!`
`imperialUnitsEnabled` - `Boolean!`	If true, enables imperial units of measurement for Comparable Unit Pricing fields.
`optionalOptionTypesEnabled` - `Boolean!`	If true, optional option types are enabled. Optional option type is enabled for all, therefore this setting is redundant. This field will be removed no sooner than 2024-09-01
`permitsCartQuickView` - `Boolean!`	If true, enables adding a product to cart directly from the search results page.
`showLocationOnAdvertTile` - `Boolean!`	True if we want to show seller location on the advert.
`showPriceTypes` - `Boolean!`	True if price types should be shown.
`therapeuticGoodsLabellingEnabled` - `Boolean!`	True if we want to show the Therapeutic Warning Labels fields and option.

Example

{
  "allowedSaleTypes": ["BUY_ONLINE"],
  "autoMappingEnabled": true,
  "defaultSaleType": "BUY_ONLINE",
  "freeTextVariantOptionTypeEnabled": false,
  "id": "4",
  "imperialUnitsEnabled": true,
  "optionalOptionTypesEnabled": true,
  "permitsCartQuickView": false,
  "showLocationOnAdvertTile": true,
  "showPriceTypes": false,
  "therapeuticGoodsLabellingEnabled": false
}

Types

AdvertSpreadsheetConfirmImportMutationInput

Description

Autogenerated input type of AdvertSpreadsheetConfirmImportMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`importId` - `ID!`

Example

{
  "clientMutationId": "abc123",
  "importId": 4
}

Types

AdvertSpreadsheetConfirmImportMutationPayload

Description

Autogenerated return type of AdvertSpreadsheetConfirmImportMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`import` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "import": ImportExport,
  "status": 987
}

Types

AdvertSpreadsheetDownloadMutationInput

Description

Autogenerated input type of AdvertSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`format` - `SpreadsheetEnum`
`invalidOnly` - `Boolean`
`selectedColumns` - `[String!]`	Selected columns to include in the spreadsheet. Default = `null`
`filters` - `AdvertFilters`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": "4",
  "format": "XLSX",
  "invalidOnly": true,
  "selectedColumns": ["xyz789"],
  "filters": AdvertFilters
}

Types

AdvertSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of AdvertSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 123
}

Types

AdvertSpreadsheetUploadMutationInput

Description

Autogenerated input type of AdvertSpreadsheetUploadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`spreadsheet` - `FileInput!`
`deleteOthers` - `Boolean`
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise
`preview` - `Boolean`

Example

{
  "clientMutationId": "abc123",
  "spreadsheet": FileInput,
  "deleteOthers": true,
  "sellerId": "4",
  "preview": false
}

Types

AdvertSpreadsheetUploadMutationPayload

Description

Autogenerated return type of AdvertSpreadsheetUploadMutation.

Fields

Field Name	Description
`advertCount` - `Int`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`import` - `ImportExport`
`status` - `Int!`
`variantCount` - `Int`

Example

{
  "advertCount": 123,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "import": ImportExport,
  "status": 123,
  "variantCount": 123
}

Types

AdvertStatisticsSummary

Fields

Field Name	Description
`clicks` - `Int!`
`date` - `String!`
`views` - `Int!`

Example

{
  "clicks": 123,
  "date": "abc123",
  "views": 987
}

Types

AdvertStatusEnum

Values

Enum Value	Description
`DISPLAYED`
`NOT_DISPLAYED`
`FEATURED`

Example

"DISPLAYED"

Types

AdvertStockStatusEnum

Values

Enum Value	Description
`HAS_STOCK`
`OUT_OF_STOCK`

Example

"HAS_STOCK"

Types

AdvertTileImageFormatEnum

Description

The image presentation format

Values

Enum Value	Description
`PADDED`	add space between the border and the image, show the full image scaled and centred
`FULL_BLEED`	don't add space between the border and the image, crop the image to cover the whole image area

Example

"PADDED"

Types

AdvertTileImageRatioEnum

Description

The image aspect ratio

Values

Enum Value	Description
`RATIO_1_1`	1:1 (Square)
`RATIO_4_3`	4:3 (Wide)
`RATIO_3_4`	3:4 (Tall)

Example

"RATIO_1_1"

Types

AdvertUpsertMutationInput

Description

Autogenerated input type of AdvertUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`advertId` - `ID`
`sellerId` - `ID`
`attributes` - `AdvertInput!`

Example

{
  "clientMutationId": "xyz789",
  "advertId": "4",
  "sellerId": "4",
  "attributes": AdvertInput
}

Types

AdvertUpsertMutationPayload

Description

Autogenerated return type of AdvertUpsertMutation.

Fields

Field Name	Description
`advert` - `Advert`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "advert": Advert,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

AdvertVettingApproveInput

Fields

Input Field	Description
`advertIds` - `[ID!]!`	A collection of ids of the products to approve for vetting.

Example

{"advertIds": ["4"]}

Types

AdvertVettingApproveMutationPayload

Description

Autogenerated return type of AdvertVettingApproveMutation.

Fields

Field Name	Description
`adverts` - `AdvertsConnection`
Arguments `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.
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adverts": AdvertsConnection,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AdvertVettingRejectInput

Fields

Input Field	Description
`advertIds` - `[ID!]!`	A collection of ids of the products to reject for vetting.
`vettingRejectedReason` - `String!`	The reason the products is being rejected.

Example

{
  "advertIds": ["4"],
  "vettingRejectedReason": "abc123"
}

Types

AdvertVettingRejectMutationPayload

Description

Autogenerated return type of AdvertVettingRejectMutation.

Fields

Field Name	Description
`adverts` - `AdvertsConnection`
Arguments `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.
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adverts": AdvertsConnection,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

AdvertVettingResubmitInput

Fields

Input Field	Description
`advertIds` - `[ID!]!`	A collection of ids of the products to be resubmitted for vetting.

Example

{"advertIds": [4]}

Types

AdvertVettingResubmitMutationPayload

Description

Autogenerated return type of AdvertVettingResubmitMutation.

Fields

Field Name	Description
`adverts` - `AdvertsConnection`
Arguments `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.
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adverts": AdvertsConnection,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AdvertsConnection

Description

The connection type for Advert.

Fields

Field Name	Description
`edges` - `[AdvertsEdge]`	A list of edges.
`nodes` - `[Advert]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AdvertsEdge],
  "nodes": [Advert],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

AdvertsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Advert`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Advert
}

Types

AdvertsWhereSort

Description

Attributes for sorting adverts

Fields

Input Field	Description
`field` - `AdvertsWhereSortFieldEnum`	Fields to sort invoices. Default = `CREATED_AT`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"field": "CREATED_AT", "ordering": "ASCENDING"}

Types

AdvertsWhereSortFieldEnum

Description

The field that is used to sort adverts

Values

Enum Value	Description
`CREATED_AT`	Timestamp at which the advert was created.
`UPDATED_AT`	Timestamp at which the advert was updated.
`REQUIRES_VETTING_AT`	Timestamp at which the advert was last submitted for vetting.
`VETTING_REJECTED_AT`	Timestamp at which the advert was rejected during the vetting process.

Example

"CREATED_AT"

Types

AdyenBillingSettings

Description

Adyen settings for billing.

Fields

Field Name	Description
`adyenBillingPaymentsWidgetPaymentMethod` - `ID`
`adyenDirectDebitPaymentMethod` - `ID`
`billingMerchantAccount` - `String`
`category` - `CategoryTypeEnum!`
`checkoutApiKey` - `String`
`checkoutEndpoint` - `String`
`clientKey` - `String`
`collectThreeDSecureInformation` - `Boolean!`
`description` - `String!`
`hmacKey` - `String`
`logoUrl` - `String!`
`paymentsApiAuth` - `String`
`paymentsEndpoint` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`status` - `StatusTypeEnum!`

Example

{
  "adyenBillingPaymentsWidgetPaymentMethod": 4,
  "adyenDirectDebitPaymentMethod": 4,
  "billingMerchantAccount": "xyz789",
  "category": "RATINGS_AND_REVIEWS",
  "checkoutApiKey": "abc123",
  "checkoutEndpoint": "abc123",
  "clientKey": "xyz789",
  "collectThreeDSecureInformation": true,
  "description": "xyz789",
  "hmacKey": "abc123",
  "logoUrl": "abc123",
  "paymentsApiAuth": "abc123",
  "paymentsEndpoint": "abc123",
  "providerHandle": "xyz789",
  "providerName": "xyz789",
  "status": "AVAILABLE"
}

Types

AdyenEcommerceSettings

Description

Adyen settings for ecommerce.

Fields

Field Name	Description
`adyenEcommercePaymentsWidgetPaymentMethod` - `ID`
`category` - `CategoryTypeEnum!`
`checkoutApiKey` - `String`
`checkoutEndpoint` - `String`
`clientKey` - `String`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`dropInEnabled` - `Boolean!`
`ecommerceMerchantAccount` - `String`
`hmacKey` - `String`
`logoUrl` - `String!`
`overrideCustomMerchantFee` - `Boolean!`
`paymentsApiAuth` - `String`
`paymentsEndpoint` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`status` - `StatusTypeEnum!`

Example

{
  "adyenEcommercePaymentsWidgetPaymentMethod": "4",
  "category": "RATINGS_AND_REVIEWS",
  "checkoutApiKey": "xyz789",
  "checkoutEndpoint": "xyz789",
  "clientKey": "xyz789",
  "customMerchantBaseFeeCents": 987,
  "customMerchantBaseFeeFormatted": "abc123",
  "customMerchantFee": 123.45,
  "description": "xyz789",
  "dropInEnabled": true,
  "ecommerceMerchantAccount": "abc123",
  "hmacKey": "abc123",
  "logoUrl": "abc123",
  "overrideCustomMerchantFee": false,
  "paymentsApiAuth": "xyz789",
  "paymentsEndpoint": "xyz789",
  "providerHandle": "abc123",
  "providerName": "abc123",
  "status": "AVAILABLE"
}

Types

AdyenResponse

Description

Adyen response

Fields

Field Name	Description
`body` - `JSON`

Example

{"body": {}}

Types

AdyenSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of AdyenSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`checkoutEndpoint` - `String!`	Adyen checkout API URL.
`paymentsEndpoint` - `String!`	Adyen payments API URL.
`checkoutApiKey` - `String!`	Adyen checkout API key.
`paymentsApiAuth` - `String!`	Adyen payments API auth key.
`billingMerchantAccount` - `String`	Adyen billing merchant account.
`ecommerceMerchantAccount` - `String`	Adyen ecommerce merchant account.
`clientKey` - `String`	Adyen client side key.
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.
`dropInEnabled` - `Boolean`	Adyen drop in enabled.
`hmacKey` - `String!`	Adyen hmac key.

Example

{
  "clientMutationId": "abc123",
  "checkoutEndpoint": "xyz789",
  "paymentsEndpoint": "xyz789",
  "checkoutApiKey": "xyz789",
  "paymentsApiAuth": "xyz789",
  "billingMerchantAccount": "xyz789",
  "ecommerceMerchantAccount": "xyz789",
  "clientKey": "abc123",
  "overrideCustomMerchantFee": true,
  "customMerchantFee": "xyz789",
  "customMerchantBaseFee": "abc123",
  "dropInEnabled": true,
  "hmacKey": "xyz789"
}

Types

AdyenSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of AdyenSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`adyenBillingSettings` - `AdyenBillingSettings`
`adyenEcommerceSettings` - `AdyenEcommerceSettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adyenBillingSettings": AdyenBillingSettings,
  "adyenEcommerceSettings": AdyenEcommerceSettings,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AdyenSettingsDeleteMutationInput

Description

Autogenerated input type of AdyenSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "abc123"}

Types

AdyenSettingsDeleteMutationPayload

Description

Autogenerated return type of AdyenSettingsDeleteMutation.

Fields

Field Name	Description
`adyenBillingSettings` - `AdyenBillingSettings`
`adyenEcommerceSettings` - `AdyenEcommerceSettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "adyenBillingSettings": AdyenBillingSettings,
  "adyenEcommerceSettings": AdyenEcommerceSettings,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

Afterpay

Description

Afterpay payment configuration data

Fields

Field Name	Description
`maxAmount` - `Float`	The maximum order amount that Afterpay accepts.
`minAmount` - `Float`	The minimum order amount that Afterpay accepts.

Example

{"maxAmount": 987.65, "minAmount": 123.45}

Types

AfterpaySettings

Description

Afterpay settings.

Fields

Field Name	Description
`afterpayEnabled` - `Boolean!`
`category` - `CategoryTypeEnum!`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`logoUrl` - `String!`
`merchantId` - `String`
`merchantKey` - `String`
`overrideCustomMerchantFee` - `Boolean!`
`providerHandle` - `String!`
`providerName` - `String!`
`regionCode` - `String`
`status` - `StatusTypeEnum!`

Example

{
  "afterpayEnabled": true,
  "category": "RATINGS_AND_REVIEWS",
  "customMerchantBaseFeeCents": 987,
  "customMerchantBaseFeeFormatted": "xyz789",
  "customMerchantFee": 123.45,
  "description": "abc123",
  "logoUrl": "abc123",
  "merchantId": "abc123",
  "merchantKey": "xyz789",
  "overrideCustomMerchantFee": false,
  "providerHandle": "abc123",
  "providerName": "xyz789",
  "regionCode": "xyz789",
  "status": "AVAILABLE"
}

Types

AfterpaySettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of AfterpaySettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantId` - `String!`	Afterpay merchant ID.
`merchantKey` - `String!`	Afterpay merchant key.
`regionCode` - `String!`	Region code. AU, US and NZ are currently supported
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.

Example

{
  "clientMutationId": "abc123",
  "merchantId": "xyz789",
  "merchantKey": "xyz789",
  "regionCode": "xyz789",
  "overrideCustomMerchantFee": true,
  "customMerchantFee": "abc123",
  "customMerchantBaseFee": "xyz789"
}

Types

AfterpaySettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of AfterpaySettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`afterpaySettings` - `AfterpaySettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "afterpaySettings": AfterpaySettings,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AfterpaySettingsDeleteMutationInput

Description

Autogenerated input type of AfterpaySettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantId` - `String!`	Afterpay merchant ID.

Example

{
  "clientMutationId": "abc123",
  "merchantId": "abc123"
}

Types

AfterpaySettingsDeleteMutationPayload

Description

Autogenerated return type of AfterpaySettingsDeleteMutation.

Fields

Field Name	Description
`afterpaySettings` - `AfterpaySettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "afterpaySettings": AfterpaySettings,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

AllAdvert

Description

Advert that can have any status, including deleted or unpublished.

Types

Union Types
`Advert`
`DeletedAdvert`
`UnpublishedAdvert`

Example

Advert

Types

AllAdvertVariant

Description

Variant IDs on deleted and unpublished adverts

Fields

Field Name	Description
`id` - `ID!`
`legacyId` - `Int!`

Example

{"id": 4, "legacyId": 123}

Types

AllAdvertVariantConnection

Description

The connection type for AllAdvertVariant.

Fields

Field Name	Description
`edges` - `[AllAdvertVariantEdge]`	A list of edges.
`nodes` - `[AllAdvertVariant]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AllAdvertVariantEdge],
  "nodes": [AllAdvertVariant],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

AllAdvertVariantEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AllAdvertVariant`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": AllAdvertVariant
}

Types

AllAdvertsConnection

Description

The connection type for AllAdvert.

Fields

Field Name	Description
`edges` - `[AllAdvertsEdge]`	A list of edges.
`nodes` - `[AllAdvert]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AllAdvertsEdge],
  "nodes": [Advert],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

AllAdvertsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AllAdvert`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Advert
}

Types

AllSeller

Description

Seller that could be soft deleted

Types

Union Types
`DeletedSeller`
`Seller`

Example

DeletedSeller

Types

AllSellersAccountTypeEnum

Description

The type for the account

Values

Enum Value	Description
`RETAILER`
`PRIVATE`
`PROSPECTIVE`

Example

"RETAILER"

Types

AllSellersConnection

Description

The connection type for AllSeller.

Fields

Field Name	Description
`edges` - `[AllSellersEdge]`	A list of edges.
`nodes` - `[AllSeller]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [AllSellersEdge],
  "nodes": [DeletedSeller],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

AllSellersEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `AllSeller`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": DeletedSeller
}

Types

AllSellersSort

Description

Attributes for sorting sellers

Fields

Input Field	Description
`field` - `AllSellersSortFieldEnum`	Fields to sort sellers. Default = `UPDATED_AT`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"field": "UPDATED_AT", "ordering": "ASCENDING"}

Types

AllSellersSortFieldEnum

Description

The field that is used to sort sellers

Values

Enum Value	Description
`UPDATED_AT`
`BUSINESS_NAME`
`SLA_RATING`

Example

"UPDATED_AT"

Types

AppliedToEnum

Description

Where the option type is applied, which can only be on either variant or advert level

Values

Enum Value	Description
`ADVERT`	An option type that is applied to an advert level
`VARIANT`	An option type that is applied to a variant level

Example

"ADVERT"

Types

Attachment

Description

file attachment

Fields

Field Name	Description
`filename` - `String`
`id` - `ID!`
`size` - `Int`	The file size of the image in bytes.
`url` - `String!`	The src URL for the image.

Example

{
  "filename": "abc123",
  "id": 4,
  "size": 987,
  "url": "xyz789"
}

Types

AttemptBillingInvoicePaymentMutationInput

Description

Autogenerated input type of AttemptBillingInvoicePaymentMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`billingId` - `ID!`	ID for retrieving the correct billing invoice

Example

{
  "clientMutationId": "abc123",
  "billingId": "4"
}

Types

AttemptBillingInvoicePaymentMutationPayload

Description

Autogenerated return type of AttemptBillingInvoicePaymentMutation.

Fields

Field Name	Description
`billing` - `Billing`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "billing": Billing,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

AvailabilityFilterOption

Description

Availability type which can be used to build an availability filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with the availability filter option
`id` - `ID!`
`name` - `String!`

Example

{"count": 987, "id": 4, "name": "abc123"}

Types

BigInt

Description

Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string.

Example

{}

Types

Billing

Description

Billing record.

Fields

Field Name	Description
`amountCents` - `Int!`	The billing amount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountExTax` - `Decimal!`	The billing amount excluding tax.
`amountExTaxCents` - `Int!`	The billing amount excluding tax. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountExTaxFormatted` - `String!`	The billing amount excluding tax. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`amountFormatted` - `String!`	The billing amount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`billingLineItems` - `[BillingLineItem!]!`
`createdAt` - `ISO8601DateTime!`	The date the billing was created.
`id` - `ID!`
`legacyId` - `Int!`	The id used to identify the billing.
`paidDate` - `ISO8601DateTime`	The date the billing was paid.
`paymentEvents` - `PaymentEventConnection!`
Arguments `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.
`pdfData` - `String`	Link to retrieve the billing invoice in PDF format (EXPENSIVE TO GENERATE) Use pdfData instead
`pdfLink` - `String`	Link to retrieve the billing invoice in PDF format
`seller` - `Seller!`
`status` - `BillingStatusEnum!`
`taxTotal` - `Decimal!`	The tax on the billing.
`taxTotalCents` - `Int!`	The tax on the billing. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	The tax on the billing. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`	The date the billing was updated.
`userCancellable` - `Boolean!`	This field identifies billing records that are user cancellable.

Example

{
  "amountCents": 123,
  "amountExTax": Decimal,
  "amountExTaxCents": 987,
  "amountExTaxFormatted": "abc123",
  "amountFormatted": "abc123",
  "billingLineItems": [BillingLineItem],
  "createdAt": ISO8601DateTime,
  "id": 4,
  "legacyId": 987,
  "paidDate": ISO8601DateTime,
  "paymentEvents": PaymentEventConnection,
  "pdfData": "abc123",
  "pdfLink": "xyz789",
  "seller": Seller,
  "status": "PAID",
  "taxTotal": Decimal,
  "taxTotalCents": 123,
  "taxTotalFormatted": "abc123",
  "updatedAt": ISO8601DateTime,
  "userCancellable": true
}

Types

BillingFilters

Description

Attributes for filtering billings

Fields

Input Field	Description
`createdSince` - `ISO8601DateTime`	Billings created since this time. Default = `null`
`createdUntil` - `ISO8601DateTime`	Billings created until this time. Default = `null`
`paidSince` - `ISO8601DateTime`	Billings paid since this time. Default = `null`
`paidUntil` - `ISO8601DateTime`	Billings paid until this time. Default = `null`
`statuses` - `[BillingStatusEnum!]`	Billings with one of these statuses. Default = `null`

Example

{
  "createdSince": ISO8601DateTime,
  "createdUntil": ISO8601DateTime,
  "paidSince": ISO8601DateTime,
  "paidUntil": ISO8601DateTime,
  "statuses": ["PAID"]
}

Types

BillingHistoryDownloadMutationInput

Description

Autogenerated input type of BillingHistoryDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`retailerIds` - `[ID!]`
`format` - `SpreadsheetEnum`
`filters` - `BillingFilters`

Example

{
  "clientMutationId": "abc123",
  "retailerIds": [4],
  "format": "XLSX",
  "filters": BillingFilters
}

Types

BillingHistoryDownloadMutationPayload

Description

Autogenerated return type of BillingHistoryDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 987
}

Types

BillingLineItem

Description

Billing line items associated with a billing.

Fields

Field Name	Description
`amountCents` - `Int`	Amount Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountFormatted` - `String`	Amount In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`billingLineItemType` - `BillingLineItemTypeEnum!`	Type of the billing line item.
`description` - `String`
`id` - `ID!`
`legacyId` - `Int!`

Example

{
  "amountCents": 987,
  "amountFormatted": "xyz789",
  "billingLineItemType": "ADVERT_RENEWAL",
  "description": "xyz789",
  "id": "4",
  "legacyId": 123
}

Types

BillingLineItemTypeEnum

Description

All possible types for billing line items.

Values

Enum Value	Description
`ADVERT_RENEWAL`
`ADVERT_PLACEMENT`
`UPGRADE_TO_FEATURED`
`SUBSCRIPTION_RENEWAL`
`SUBSCRIPTION_FEATURE`
`VALUE_OF_ENQUIRY`
`ECOMMERCE_SETUP`
`MANUAL_CORRECTION`
`VOIDABLE_NOMINAL_CREDIT_CARD_VALIDATION_AMOUNT`

Example

"ADVERT_RENEWAL"

Types

BillingSort

Description

Attributes for sorting billings

Fields

Input Field	Description
`fields` - `[BillingSortFieldEnum!]!`	Fields to sort billings. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["CREATED_AT"], "ordering": "ASCENDING"}

Types

BillingSortFieldEnum

Description

The field that is used to sort billings

Values

Enum Value	Description
`CREATED_AT`
`PAID_DATE`
`STATUS`
`TAX_TOTAL`
`LEGACY_ID`

Example

"CREATED_AT"

Types

BillingStatusEnum

Description

The current status of an billing.

Values

Enum Value	Description
`PAID`
`UNPAID`
`CANCELLED`
`VOIDED`

Example

"PAID"

Types

BillingsConnection

Description

The connection type for Billing.

Fields

Field Name	Description
`edges` - `[BillingsEdge]`	A list of edges.
`nodes` - `[Billing]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [BillingsEdge],
  "nodes": [Billing],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

BillingsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Billing`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Billing
}

Types

Boolean

Description

Represents true or false values.

Example

true

Types

Braintree

Description

Properties from the braintree payment service, returns null when Braintree is disabled

Fields

Field Name	Description
`clientToken` - `String`	`Braintree client token includes configuration and authorization information required by the Braintree client SDK. If Braintree is not enabled this will return null`
`clientTokenError` - `String`	Braintree client token errors

Example

{
  "clientToken": "abc123",
  "clientTokenError": "xyz789"
}

Types

BraintreeBillingSettings

Description

Braintree settings for billing

Fields

Field Name	Description
`billingMerchantAccount` - `String`
`braintree3dSecureEnabled` - `Boolean!`
`braintreeBillingDropInEnabled` - `Boolean!`
`canEnableBraintree3dSecure` - `Boolean!`
`category` - `CategoryTypeEnum!`
`description` - `String!`
`logoUrl` - `String!`
`merchantId` - `String`
`paymentMethod` - `PaymentMethod`
`paypalAccount` - `String`
`privateKey` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`publicKey` - `String`
`status` - `StatusTypeEnum!`
`useSandboxEnvironment` - `Boolean!`

Example

{
  "billingMerchantAccount": "xyz789",
  "braintree3dSecureEnabled": false,
  "braintreeBillingDropInEnabled": false,
  "canEnableBraintree3dSecure": true,
  "category": "RATINGS_AND_REVIEWS",
  "description": "abc123",
  "logoUrl": "abc123",
  "merchantId": "abc123",
  "paymentMethod": PaymentMethod,
  "paypalAccount": "abc123",
  "privateKey": "xyz789",
  "providerHandle": "abc123",
  "providerName": "xyz789",
  "publicKey": "xyz789",
  "status": "AVAILABLE",
  "useSandboxEnvironment": true
}

Types

BraintreeEcommerceSettings

Description

Braintree settings for ecommerce

Fields

Field Name	Description
`applePayEnabled` - `Boolean!`
`braintree3dSecureEnabled` - `Boolean!`
`braintreeEcommerceDropInEnabled` - `Boolean!`
`braintreeFraudProtectionEnabled` - `Boolean!`
`canEnableBraintree3dSecure` - `Boolean!`
`canEnableBraintreeFraudProtection` - `Boolean!`
`category` - `CategoryTypeEnum!`
`customMerchantBaseFee` - `String`
`customMerchantFee` - `String`
`description` - `String!`
`ecommerceMerchantAccount` - `String`
`googleMerchantId` - `String`
`googlePayEnabled` - `Boolean!`
`kountSiteId` - `String`
`logoUrl` - `String!`
`merchantId` - `String`
`overrideCustomMerchantFee` - `Boolean!`
`paymentMethod` - `PaymentMethod`
`paypalAccount` - `String`
`privateKey` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`publicKey` - `String`
`sendShippingDetailsToBraintree` - `Boolean!`
`sendSiteNameToKount` - `Boolean!`
`status` - `StatusTypeEnum!`
`useSandboxEnvironment` - `Boolean!`

Example

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

Types

BraintreeSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of BraintreeSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantId` - `String!`	Braintree merchant ID.
`publicKey` - `String!`	Braintree public API key.
`privateKey` - `String!`	Braintree private API key.
`billingMerchantAccount` - `String`	Braintree billing merchant account.
`ecommerceMerchantAccount` - `String`	Braintree ecommerce merchant account.
`paypalAccount` - `String`	PayPal email linked with Braintree.
`useSandboxEnvironment` - `Boolean`	Enable using Braintree sandbox credentials in production.
`overrideCustomMerchantFee` - `Boolean`	Whether to override the platform-wide merchant fee with a custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`googleMerchantId` - `String`	Google merchant ID used for Google Pay.
`customMerchantBaseFee` - `String`	Merchant base fee.
`googlePayEnabled` - `Boolean`	Enable Google Pay. Google Pay must also be properly configured in the Braintree dashboard.
`applePayEnabled` - `Boolean`	Enable Apple Pay. Apple Pay must also be properly configured in the Braintree dashboard.
`sendShippingDetailsToBraintree` - `Boolean`	Send shipping details to Braintree.
`kountSiteId` - `String`	Kount site ID.
`braintreeFraudProtectionEnabled` - `Boolean`	Enable Braintree fraud protection with Kount. Kount must also be properly configured in the Braintree dashboard.
`sendSiteNameToKount` - `Boolean`	Send site name to Kount.
`braintree3dSecureEnabled` - `Boolean`	Enable 3D secure for Braintree transactions.

Example

{
  "clientMutationId": "abc123",
  "merchantId": "abc123",
  "publicKey": "abc123",
  "privateKey": "abc123",
  "billingMerchantAccount": "abc123",
  "ecommerceMerchantAccount": "abc123",
  "paypalAccount": "abc123",
  "useSandboxEnvironment": false,
  "overrideCustomMerchantFee": true,
  "customMerchantFee": "xyz789",
  "googleMerchantId": "abc123",
  "customMerchantBaseFee": "abc123",
  "googlePayEnabled": false,
  "applePayEnabled": true,
  "sendShippingDetailsToBraintree": true,
  "kountSiteId": "xyz789",
  "braintreeFraudProtectionEnabled": false,
  "sendSiteNameToKount": true,
  "braintree3dSecureEnabled": false
}

Types

BraintreeSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of BraintreeSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`braintreeBillingSettings` - `BraintreeBillingSettings`
`braintreeEcommerceSettings` - `BraintreeEcommerceSettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "braintreeBillingSettings": BraintreeBillingSettings,
  "braintreeEcommerceSettings": BraintreeEcommerceSettings,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

BraintreeSettingsDeleteMutationInput

Description

Autogenerated input type of BraintreeSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantId` - `String!`	Braintree merchant ID.

Example

{
  "clientMutationId": "xyz789",
  "merchantId": "xyz789"
}

Types

BraintreeSettingsDeleteMutationPayload

Description

Autogenerated return type of BraintreeSettingsDeleteMutation.

Fields

Field Name	Description
`braintreeBillingSettings` - `BraintreeBillingSettings`
`braintreeEcommerceSettings` - `BraintreeEcommerceSettings`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "braintreeBillingSettings": BraintreeBillingSettings,
  "braintreeEcommerceSettings": BraintreeEcommerceSettings,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

Brand

Description

Product brand

Fields

Field Name	Description
`default` - `Boolean!`	Whether the given brand is the default for adverts.
`denyBuyOnlineFor` - `Boolean!`	Whether buying the associated item via the website is forbidden.
`denyBuyOnlineForTaxon` - `Taxon`	If the associated item has this taxon, then buying the item via the website is forbidden.
`denyClickAndCollectFor` - `Boolean!`	Whether buying the associated item for in-store pickup is forbidden.
`denyClickAndCollectForTaxonId` - `ID`	If the associated item has this taxon, then buying the item for in-store pickup is forbidden.
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`logo` - `Image`
`name` - `String!`
`showInAdvertTitle` - `Boolean!`	Whether to show the brand name in the associated advert's title.
`sizeMatrices` - `[SizeMatrix!]!`
`slug` - `String!`	The URL subpath associated with the given brand. Mostly used for building URLs for advert search results.

Example

{
  "default": true,
  "denyBuyOnlineFor": false,
  "denyBuyOnlineForTaxon": Taxon,
  "denyClickAndCollectFor": false,
  "denyClickAndCollectForTaxonId": "4",
  "externalIds": [ExternalID],
  "id": "4",
  "logo": Image,
  "name": "abc123",
  "showInAdvertTitle": true,
  "sizeMatrices": [SizeMatrix],
  "slug": "abc123"
}

Types

BrandFilterOption

Description

Minimal subset of Brand type which can be used to build a brand filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with each brand filter option
`id` - `ID!`
`name` - `String!`
`slug` - `String!`	The URL subpath associated with the given brand. Mostly used for building URLs for advert search results.

Example

{
  "count": 123,
  "id": 4,
  "name": "abc123",
  "slug": "xyz789"
}

Types

BrandOrTaxon

Description

A Brand or Taxon, returned by TextQuerySuggestionType

Types

Union Types
`Brand`
`Taxon`

Example

Brand

Types

BrandsConnection

Description

The connection type for Brand.

Fields

Field Name	Description
`edges` - `[BrandsEdge]`	A list of edges.
`nodes` - `[Brand]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [BrandsEdge],
  "nodes": [Brand],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

BrandsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Brand`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Brand
}

Types

CancelBillingInvoiceMutationInput

Description

Autogenerated input type of CancelBillingInvoiceMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`billingId` - `ID!`	ID of the billing record to be cancelled

Example

{
  "clientMutationId": "xyz789",
  "billingId": "4"
}

Types

CancelBillingInvoiceMutationPayload

Description

Autogenerated return type of CancelBillingInvoiceMutation.

Fields

Field Name	Description
`billing` - `Billing`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "billing": Billing,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

Cart

Description

A cart object just waiting to transform into an order.

Fields

Field Name	Description
`address` - `Address`	The shipping address associated to the cart. Required for checkout.
`billingAddress` - `Address`	The billing address associated to the cart. Required for checkout.
`billingCompanyName` - `String`	The company name of the bill recipient.
`billingEmailAddress` - `String`	The email address of the bill recipient. Required for checkout.
`billingFirstName` - `String`	The first name of the bill recipient. Required for checkout.
`billingPhone` - `String`	The phone number of the bill recipient. Depending on marketplace configuration, can be required for checkout
`billingSurname` - `String`	The surname of the bill recipient. Required for checkout.
`buyableQuantity` - `Int!`	The total buyable quantity of all items in the cart.
`cartItems` - `CartItemConnection!`
Arguments `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.
`cartSellers` - `CartSellersConnection!`
Arguments `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.
`companyName` - `String`	The company name of the user who owns the cart.
`couponCode` - `String`	A coupon code that has been applied to the cart. Will return an error if the coupon is invalid
`createdAt` - `ISO8601DateTime!`	Timestamp at which the cart was created.
`discountCents` - `Int!`	The discount applied to the cart. Negative value. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	The discount applied to the cart. Negative value. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`emailAddress` - `String`	The email address of the user who owns the cart. Required for checkout.
`firstName` - `String`	The first name of the user who owns the cart. Required for checkout.
`id` - `ID!`
`isGift` - `Boolean`	Is this order a gift order? Defaults to false.
`messageToGiftRecipient` - `String`	A message that will be sent to the gift recipient.
`messageToSeller` - `String`	A message that will be sent to the seller.
`phone` - `String`	The phone number of the user who owns the cart. Depending on marketplace configuration, can be required for checkout
`shippingCostCents` - `Int!`	The cart postage cost. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingCostFormatted` - `String!`	The cart postage cost. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`subtotalCents` - `Int!`	The cart subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalFormatted` - `String!`	The cart subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`surname` - `String`	The surname of the user who owns the cart. Required for checkout.
`taxCalculationStatus` - `CartTaxCalculationStatusEnum`	The status of the tax calculation on a cart. Returns an enumerable value.
`taxTotalCents` - `Int!`	The tax on the cart. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	The tax on the cart. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`token` - `String!`	Required for retrieving or modifying cart data.
`totalCents` - `Int!`	The cart total. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	The cart total. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`	Timestamp at which the cart was most recently changed.
`user` - `User`	The user associated to the cart.

Example

{
  "address": Address,
  "billingAddress": Address,
  "billingCompanyName": "xyz789",
  "billingEmailAddress": "abc123",
  "billingFirstName": "xyz789",
  "billingPhone": "abc123",
  "billingSurname": "abc123",
  "buyableQuantity": 123,
  "cartItems": CartItemConnection,
  "cartSellers": CartSellersConnection,
  "companyName": "xyz789",
  "couponCode": "abc123",
  "createdAt": ISO8601DateTime,
  "discountCents": 987,
  "discountFormatted": "abc123",
  "emailAddress": "abc123",
  "firstName": "xyz789",
  "id": "4",
  "isGift": false,
  "messageToGiftRecipient": "xyz789",
  "messageToSeller": "xyz789",
  "phone": "abc123",
  "shippingCostCents": 123,
  "shippingCostFormatted": "xyz789",
  "subtotalCents": 987,
  "subtotalFormatted": "xyz789",
  "surname": "abc123",
  "taxCalculationStatus": "SUCCESS",
  "taxTotalCents": 123,
  "taxTotalFormatted": "abc123",
  "token": "xyz789",
  "totalCents": 987,
  "totalFormatted": "xyz789",
  "updatedAt": ISO8601DateTime,
  "user": User
}

Types

CartAddCartItemMutationInput

Description

Autogenerated input type of CartAddCartItemMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`quantity` - `Int!`	Update the quantity of the item held in the cart to this number.
`deliveryMethod` - `DeliveryMethodEnum`	The way in which the buyer will receive the good or service. Default = `null`
`variantBarcode` - `String`	Barcodes of variants to add to the cart. The given barcodes must be unique. If a barcode is associated with multiple variants, it will raise an error. Default = `""`
`variantId` - `ID`	IDs of the variants to add to the cart. Default = `""`
`formData` - `JSON`	Custom form data to add to the cart
`cartId` - `ID!`	ID for retrieving the correct cart.

Example

{
  "clientMutationId": "xyz789",
  "quantity": 123,
  "deliveryMethod": "DELIVER",
  "variantBarcode": "abc123",
  "variantId": 4,
  "formData": {},
  "cartId": "4"
}

Types

CartAddCartItemMutationPayload

Description

Autogenerated return type of CartAddCartItemMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

CartAddItemMutationInput

Description

Autogenerated input type of CartAddItemMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`quantity` - `Int!`	Update the quantity of the item held in the cart to this number.
`deliveryMethod` - `DeliveryMethodEnum`	The way in which the buyer will receive the good or service. Default = `null`
`variantBarcode` - `String`	Barcodes of variants to add to the cart. The given barcodes must be unique. If a barcode is associated with multiple variants, it will raise an error. Default = `""`
`variantId` - `ID`	IDs of the variants to add to the cart. Default = `""`
`formData` - `JSON`	Custom form data to add to the cart

Example

{
  "clientMutationId": "abc123",
  "quantity": 987,
  "deliveryMethod": "DELIVER",
  "variantBarcode": "abc123",
  "variantId": 4,
  "formData": {}
}

Types

CartAddItemMutationPayload

Description

Autogenerated return type of CartAddItemMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

CartCheckoutMutationInput

Description

Autogenerated input type of CartCheckoutMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`cartId` - `ID!`	ID for retrieving the correct cart to convert into a completed order.
`paymentProviderAttributes` - `PaymentProviderInput!`	Attributes required by a payment provider to process a payment.
`checkoutAttributes` - `CheckoutInput`	Additional attributes to pass through to checkout to use certain features.

Example

{
  "clientMutationId": "xyz789",
  "cartId": 4,
  "paymentProviderAttributes": PaymentProviderInput,
  "checkoutAttributes": CheckoutInput
}

Types

CartCheckoutMutationPayload

Description

Autogenerated return type of CartCheckoutMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`order` - `Order`
`redirectUrl` - `String`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "order": Order,
  "redirectUrl": "xyz789",
  "status": 123
}

Types

CartCreateMutationInput

Description

Autogenerated input type of CartCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `CartInput`	Attributes to assign to the cart created.
`cartItemsToAdd` - `[AddCartItemInput!]`	Params for fetching the given number of items to add to the cart.

Example

{
  "clientMutationId": "xyz789",
  "attributes": CartInput,
  "cartItemsToAdd": [AddCartItemInput]
}

Types

CartCreateMutationPayload

Description

Autogenerated return type of CartCreateMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

CartDeleteMutationInput

Description

Autogenerated input type of CartDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`cartId` - `ID!`	ID for retrieving the correct cart.

Example

{"clientMutationId": "abc123", "cartId": 4}

Types

CartDeleteMutationPayload

Description

Autogenerated return type of CartDeleteMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

CartInput

Description

Attributes for creating or updating a cart.

Fields

Input Field	Description
`address` - `AddressInput`	Shipping address for the items in the cart. Required for checkout.
`billingAddress` - `AddressInput`	Billing address for the cart. Required for checkout.
`firstName` - `String`	The first name of the user who owns the cart. Required for checkout.
`surname` - `String`	The surname of the user who owns the cart. Required for checkout.
`emailAddress` - `String`	The email address of the user who owns the cart. Required for checkout.
`messageToSeller` - `String`	A message that will be sent to the seller.
`companyName` - `String`	The company name of the user who owns the cart.
`phone` - `String`	The phone number of the user who owns the cart. Required for checkout.
`couponCode` - `String`	A coupon code that has been applied to the cart. Will return an error if the coupon is invalid
`billingFirstName` - `String`	The first name of the bill recipient. Required for checkout.
`billingSurname` - `String`	The surname of the bill recipient. Required for checkout.
`billingPhone` - `String`	The phone number of the bill recipient. Required for checkout.
`billingCompanyName` - `String`	The company name of the bill recipient.
`billingEmailAddress` - `String`	The email address of the bill recipient. Required for checkout.
`isGift` - `Boolean`	Is this order a gift order? Defaults to false.
`messageToGiftRecipient` - `String`	A message that will be sent to the gift recipient.

Example

{
  "address": AddressInput,
  "billingAddress": AddressInput,
  "firstName": "abc123",
  "surname": "xyz789",
  "emailAddress": "abc123",
  "messageToSeller": "abc123",
  "companyName": "xyz789",
  "phone": "xyz789",
  "couponCode": "xyz789",
  "billingFirstName": "xyz789",
  "billingSurname": "xyz789",
  "billingPhone": "abc123",
  "billingCompanyName": "abc123",
  "billingEmailAddress": "xyz789",
  "isGift": false,
  "messageToGiftRecipient": "xyz789"
}

Types

CartItem

Description

A good or service that a user has added to their cart.

Fields

Field Name	Description
`advert` - `Advert!`
`deliveryMethod` - `DeliveryMethodEnum!`
`discountCents` - `Int!`	Total amount of monetary discounts. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	Total amount of monetary discounts. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`hasFreeShippingDiscount` - `Boolean!`	Whether the item has free shipping.
`id` - `ID!`
`internationalShippingAvailable` - `Boolean!`
`internationalShippingRequired` - `Boolean!`	For deliverable items, whether the buyer's country matches the seller's country
`purchasable` - `Purchasable!`
`quantity` - `Int!`
`seller` - `Seller!`
`shippingCostCents` - `Int!`	Shipping cost of an item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingCostFormatted` - `String!`	Shipping cost of an item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`subtotalCents` - `Int!`	Cost of the cart item (price x quantity), plus any additional fees applied by the seller. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalFormatted` - `String!`	Cost of the cart item (price x quantity), plus any additional fees applied by the seller. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalCents` - `Int!`	Total cost of the item, which includes subtotals and cost of shipping if applicable. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	Total cost of the item, which includes subtotals and cost of shipping if applicable. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.

Example

{
  "advert": Advert,
  "deliveryMethod": "DELIVER",
  "discountCents": 987,
  "discountFormatted": "xyz789",
  "hasFreeShippingDiscount": true,
  "id": "4",
  "internationalShippingAvailable": true,
  "internationalShippingRequired": false,
  "purchasable": Variant,
  "quantity": 987,
  "seller": Seller,
  "shippingCostCents": 987,
  "shippingCostFormatted": "abc123",
  "subtotalCents": 123,
  "subtotalFormatted": "abc123",
  "totalCents": 987,
  "totalFormatted": "abc123"
}

Types

CartItemConnection

Description

The connection type for CartItem.

Fields

Field Name	Description
`edges` - `[CartItemEdge]`	A list of edges.
`nodes` - `[CartItem]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CartItemEdge],
  "nodes": [CartItem],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CartItemDeliveryMethodGroup

Description

A grouping of cart items that all have the same delivery method. Most of the fields are aggregations of individual cart item fields.

Fields

Field Name	Description
`cartItems` - `CartItemConnection!`
Arguments `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.
`deliveryMethod` - `DeliveryMethodEnum!`
`discountCents` - `Int!`	Total amount of monetary discounts. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	Total amount of monetary discounts. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`internationalShippingAvailable` - `Boolean!`
`internationalShippingRequired` - `Boolean!`	For deliverable items, whether the buyer's country matches the seller's country for all associated cart items.
`shippingCostCents` - `Int!`	Sum of the shipping costs of the cart items. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingCostFormatted` - `String!`	Sum of the shipping costs of the cart items. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`shippingDescription` - `String!`	General description of the delivery method and estimated time in transit for the shipment.
`shippingDiscountDescriptions` - `[String!]!`	List of descriptions of potential or applied shipping discounts for this group of cart items. Includes any relevant promotions and information about free shipping when available.
Arguments `currency` - `String` Currency in which to display any monetary discounts. Defaults to the currency of the marketplace's home country.
`shippingDiscountLineItem` - `String`	For cart item groups that have a shipping discount or free shipping, this text can replace the shipping cost in the list of line items.
`shippingFromLocationMessage` - `String`	Message for user, informing them of the location from where their purchase will be shipped if applicable
Arguments `useCity` - `Boolean` Whether to include the name of the city that the item is shipping from in the message.
`shippingTaxCents` - `Int!`	Sum of the tax amount for the shipping cost. Whether this amount is included in the base shipping cost depends on the website's home country (i.e. Australia's GST is included in an item's price, but sales tax in the U.S. is added on separately). Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingTaxFormatted` - `String!`	Sum of the tax amount for the shipping cost. Whether this amount is included in the base shipping cost depends on the website's home country (i.e. Australia's GST is included in an item's price, but sales tax in the U.S. is added on separately). In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`subtotalCents` - `Int!`	Sum of the cost of the cart items (price x quantity), plus any additional fees applied by the seller. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalDiscountDescriptions` - `[String!]!`	List of descriptions of promotional discounts applied to the subtotal of this group of cart items
Arguments `currency` - `String` Currency in which to display any monetary discounts. Defaults to the currency of the marketplace's home country.
`subtotalFormatted` - `String!`	Sum of the cost of the cart items (price x quantity), plus any additional fees applied by the seller. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxTotalCents` - `Int!`	Sum of the tax of the cart items. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	Sum of the tax of the cart items. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalCents` - `Int!`	Sum of the total cost of the cart items, which includes subtotals and cost of shipping if applicable. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	Sum of the total cost of the cart items, which includes subtotals and cost of shipping if applicable. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.

Example

{
  "cartItems": CartItemConnection,
  "deliveryMethod": "DELIVER",
  "discountCents": 987,
  "discountFormatted": "xyz789",
  "internationalShippingAvailable": false,
  "internationalShippingRequired": false,
  "shippingCostCents": 987,
  "shippingCostFormatted": "abc123",
  "shippingDescription": "abc123",
  "shippingDiscountDescriptions": [
    "abc123"
  ],
  "shippingDiscountLineItem": "xyz789",
  "shippingFromLocationMessage": "abc123",
  "shippingTaxCents": 123,
  "shippingTaxFormatted": "xyz789",
  "subtotalCents": 987,
  "subtotalDiscountDescriptions": [
    "abc123"
  ],
  "subtotalFormatted": "abc123",
  "taxTotalCents": 987,
  "taxTotalFormatted": "abc123",
  "totalCents": 123,
  "totalFormatted": "xyz789"
}

Types

CartItemEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CartItem`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CartItem
}

Types

CartRemoveCartItemMutationInput

Description

Autogenerated input type of CartRemoveCartItemMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`cartId` - `ID`	Deprecated: As of Sept. 2019, this is no longer used to look up associated cart items and will be removed. Default = `null`
`cartItemId` - `ID!`	ID of the cart item to be modified. See cartItem type for more details.

Example

{
  "clientMutationId": "abc123",
  "cartId": 4,
  "cartItemId": "4"
}

Types

CartRemoveCartItemMutationPayload

Description

Autogenerated return type of CartRemoveCartItemMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

CartSellerEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cartItemsByDeliveryMethod` - `[CartItemDeliveryMethodGroup!]!`
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Seller`	The item at the end of the edge.

Example

{
  "cartItemsByDeliveryMethod": [
    CartItemDeliveryMethodGroup
  ],
  "cursor": "xyz789",
  "node": Seller
}

Types

CartSellersConnection

Description

The connection type for Seller.

Fields

Field Name	Description
`edges` - `[CartSellerEdge]`	A list of edges.
`nodes` - `[Seller]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CartSellerEdge],
  "nodes": [Seller],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CartTaxCalculationStatusEnum

Description

The status of the tax calculation on a cart.

Values

Enum Value	Description
`SUCCESS`
`MISSING_BUYER_ADDRESS`
`AVATAX_ERROR`

Example

"SUCCESS"

Types

CartUpdateCartItemMutationInput

Description

Autogenerated input type of CartUpdateCartItemMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`cartId` - `ID!`	ID for retrieving the correct cart.
`cartItemId` - `ID!`	ID of the cart item to be modified. See cartItem type for more details.
`deliveryMethod` - `DeliveryMethodEnum`	The way in which the buyer will receive the good or service. Default = `null`
`quantity` - `Int`	The quantity of the item to be put in the cart. Default = `null`

Example

{
  "clientMutationId": "xyz789",
  "cartId": "4",
  "cartItemId": 4,
  "deliveryMethod": "DELIVER",
  "quantity": 987
}

Types

CartUpdateCartItemMutationPayload

Description

Autogenerated return type of CartUpdateCartItemMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

CartUpdateMutationInput

Description

Autogenerated input type of CartUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`cartId` - `ID!`	ID for retrieving the correct cart.
`attributes` - `CartInput`	Attributes to assign to the cart updated.

Example

{
  "clientMutationId": "xyz789",
  "cartId": "4",
  "attributes": CartInput
}

Types

CartUpdateMutationPayload

Description

Autogenerated return type of CartUpdateMutation.

Fields

Field Name	Description
`cart` - `Cart`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "cart": Cart,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

CatalogRule

Description

Catalog rule

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`	When the record was created
`errorMessage` - `String!`	The error message returned when a product fails catalog rule validation
`id` - `ID!`
`key` - `CatalogRulesKeyEnum!`	The product attribute the catalog rule is validated against
`legacyId` - `Int!`	The catalog rule legacy ID
`operator` - `CatalogRulesOperatorEnum!`	The operator used to validate the product attribute with
`value` - `String`	The value the operator is compared against

Example

{
  "createdAt": ISO8601DateTime,
  "errorMessage": "xyz789",
  "id": "4",
  "key": "PRODUCT_DESCRIPTION",
  "legacyId": 987,
  "operator": "GREATER_THAN",
  "value": "xyz789"
}

Types

CatalogRuleCreateMutationInput

Description

Autogenerated input type of CatalogRuleCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `CatalogRuleInput!`

Example

{
  "clientMutationId": "xyz789",
  "attributes": CatalogRuleInput
}

Types

CatalogRuleCreateMutationPayload

Description

Autogenerated return type of CatalogRuleCreateMutation.

Fields

Field Name	Description
`catalogRule` - `CatalogRule`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "catalogRule": CatalogRule,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

CatalogRuleDeleteMutationInput

Description

Autogenerated input type of CatalogRuleDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the catalog rule

Example

{"clientMutationId": "xyz789", "id": 4}

Types

CatalogRuleDeleteMutationPayload

Description

Autogenerated return type of CatalogRuleDeleteMutation.

Fields

Field Name	Description
`catalogRule` - `CatalogRule`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "catalogRule": CatalogRule,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

CatalogRuleInput

Fields

Input Field	Description
`key` - `CatalogRulesKeyEnum!`	The product attribute to validate against
`operator` - `CatalogRulesOperatorEnum!`	The operator used to validate the product attribute with
`value` - `String`	The value the operator is compared against. Do not supply for the `is present` operator.
`errorMessage` - `String!`	The error message returned when a product fails catalog rule validation

Example

{
  "key": "PRODUCT_DESCRIPTION",
  "operator": "GREATER_THAN",
  "value": "abc123",
  "errorMessage": "abc123"
}

Types

CatalogRuleSortFieldEnum

Description

The field that is used to sort catalog rules

Values

Enum Value	Description
`CREATED_AT`	The date the catalog rule was created
`KEY`	The key of the catalog rule

Example

"CREATED_AT"

Types

CatalogRuleUpdateInput

Fields

Input Field	Description
`operator` - `CatalogRulesOperatorEnum`	The operator used to validate the product attribute with
`value` - `String`	The value the operator is compared against. Do not supply for the `is present` operator. Default = `null`
`errorMessage` - `String`	The error message returned when a product fails catalog rule validation

Example

{
  "operator": "GREATER_THAN",
  "value": "abc123",
  "errorMessage": "abc123"
}

Types

CatalogRuleUpdateMutationInput

Description

Autogenerated input type of CatalogRuleUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`catalogRuleId` - `ID!`	ID of the catalog rule to be updated
`attributes` - `CatalogRuleUpdateInput!`

Example

{
  "clientMutationId": "xyz789",
  "catalogRuleId": 4,
  "attributes": CatalogRuleUpdateInput
}

Types

CatalogRuleUpdateMutationPayload

Description

Autogenerated return type of CatalogRuleUpdateMutation.

Fields

Field Name	Description
`catalogRule` - `CatalogRule`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "catalogRule": CatalogRule,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

CatalogRulesConnection

Description

The connection type for CatalogRule.

Fields

Field Name	Description
`edges` - `[CatalogRulesEdge]`	A list of edges.
`nodes` - `[CatalogRule]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CatalogRulesEdge],
  "nodes": [CatalogRule],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

CatalogRulesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CatalogRule`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CatalogRule
}

Types

CatalogRulesError

Description

Catalog rules error

Fields

Field Name	Description
`errorMessage` - `String!`	The error message returned when a product fails catalog rule validation
`fieldName` - `String!`	The field the error is attributed to
`objectId` - `ID!`	The object id the error is attributed to

Example

{
  "errorMessage": "abc123",
  "fieldName": "xyz789",
  "objectId": 4
}

Types

CatalogRulesKeyEnum

Description

Key for Catalog Rules.

Values

Enum Value	Description
`PRODUCT_DESCRIPTION`	The description of the parent product. Combine this with an operator like GREATER_THAN to define a rule that the description should be >15 characters long.
`PRODUCT_IMAGE`	The image that represents the main product.
`PRODUCT_IMAGE_HEIGHT`	Height of image in pixels.
`PRODUCT_IMAGE_WIDTH`	Width of image in pixels.
`PRODUCT_TITLE`	Title of the parent product.
`VARIANT_BARCODE`	Barcode of the sellable variant.
`VARIANT_IMAGE`	Image of the sellable variant.
`VARIANT_IMAGE_HEIGHT`	Height of variant image in pixels.
`VARIANT_IMAGE_WIDTH`	Width of variant image in pixels.
`VARIANT_SKU`	SKU code of the sellable variant.
`VARIANT_SHIPPING_PROFILE_ID`	Shipping profile for the variant.
`VARIANT_TAX_CODE`	Tax code for the variant.
`VARIANT_ERRORS_METADATA`	Errors metadata for the variant.

Example

"PRODUCT_DESCRIPTION"

Types

CatalogRulesOperatorEnum

Description

Operators for Catalog Rules.

Values

Enum Value	Description
`GREATER_THAN`	Greater than e.g. >10 is 10.01 onwards
`LESS_THAN`	Less than e.g. <10 is any number up to 9.99
`GREATER_THAN_OR_EQUAL_TO`	Greater than or equal to a number
`LESS_THAN_OR_EQUAL_TO`	Less than or equal to a number
`EQUAL_TO`	Equal to a number
`NOT_EQUAL_TO`	Not equal to a number
`PRESENT`	Present. When using this operator, do not provide a value
`BLANK`	Blank. When using this operator, do not provide a value

Example

"GREATER_THAN"

Types

CatalogRulesSort

Description

Attributes for sorting catalog rules

Fields

Input Field	Description
`fields` - `[CatalogRuleSortFieldEnum!]!`	Fields to sort catalog rules. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["CREATED_AT"], "ordering": "ASCENDING"}

Types

CategoryMenuEntry

Description

An entry in the Navigation Category Menu

Types

Union Types
`DirectLink`
`Markdown`

Example

DirectLink

Types

CategoryTypeEnum

Description

Category label for the partner integration. Represents different types of partner integrations.

Values

Enum Value	Description
`RATINGS_AND_REVIEWS`
`ECOMMERCE_PAYMENTS`
`BILLING_PAYMENTS`
`EMAIL_MARKETING`

Example

"RATINGS_AND_REVIEWS"

Types

ChangeLog

Description

Log for record changes.

Fields

Field Name	Description
`changes` - `JSON`
`createdAt` - `ISO8601DateTime!`
`event` - `String!`
`id` - `ID!`
`item` - `Node`
`itemId` - `String`
`itemType` - `String`	NOTE: This should only be used as a description, these names could change at any time, and so should NOT be used as a code switch.
`whodunnit` - `AdminOrUser`

Example

{
  "changes": {},
  "createdAt": ISO8601DateTime,
  "event": "xyz789",
  "id": 4,
  "item": Node,
  "itemId": "abc123",
  "itemType": "abc123",
  "whodunnit": Admin
}

Types

ChangeLogsConnection

Description

The connection type for ChangeLog.

Fields

Field Name	Description
`edges` - `[ChangeLogsEdge]`	A list of edges.
`nodes` - `[ChangeLog]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ChangeLogsEdge],
  "nodes": [ChangeLog],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

ChangeLogsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ChangeLog`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ChangeLog
}

Types

ChatMessage

Description

Chat message between operator and seller

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`message` - `String!`	text of message
`readAt` - `ISO8601DateTime`	Seen by recipient at.
`seller` - `Seller!`
`sentByType` - `String!`	who sent the message

Example

{
  "createdAt": ISO8601DateTime,
  "id": 4,
  "message": "xyz789",
  "readAt": ISO8601DateTime,
  "seller": Seller,
  "sentByType": "abc123"
}

Types

ChatMessageCreateMutationInput

Description

Autogenerated input type of ChatMessageCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise
`message` - `String!`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": 4,
  "message": "abc123"
}

Types

ChatMessageCreateMutationPayload

Description

Autogenerated return type of ChatMessageCreateMutation.

Fields

Field Name	Description
`chatMessage` - `ChatMessage`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "chatMessage": ChatMessage,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

ChatMessageEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ChatMessage`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ChatMessage
}

Types

ChatMessageReadMutationInput

Description

Autogenerated input type of ChatMessageReadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`seller` - `ID`
`sentBy` - `String!`	The type of user that is reading the message. Either 'Admin' or 'User'

Example

{
  "clientMutationId": "xyz789",
  "seller": 4,
  "sentBy": "xyz789"
}

Types

ChatMessageReadMutationPayload

Description

Autogenerated return type of ChatMessageReadMutation.

Fields

Field Name	Description
`chatMessage` - `ChatMessage`	Details of the last chat message
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "chatMessage": ChatMessage,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

ChatMessagesConnection

Description

The connection type for ChatMessage.

Fields

Field Name	Description
`edges` - `[ChatMessageEdge]`	A list of edges.
`lastReadMessage` - `ChatMessage`	Last read message
Arguments `for` - `String!`
`nodes` - `[ChatMessage]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`
`totalUnreadCount` - `Int!`	Unread count
Arguments `for` - `String!`

Example

{
  "edges": [ChatMessageEdge],
  "lastReadMessage": ChatMessage,
  "nodes": [ChatMessage],
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalUnreadCount": 123
}

Types

CheckoutInput

Description

Additional attributes to pass through to checkout to use certain features.

Fields

Input Field	Description
`updateUserProfile` - `Boolean`	If true user profile will be updated with the checkout details. If false a user will only be updated when they have an incomplete profile.

Example

{"updateUserProfile": false}

Types

ClickAndCollectStatusUpdateMutationInput

Description

Autogenerated input type of ClickAndCollectStatusUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID!`	ID of the invoice to be updated
`status` - `InvoiceClickAndCollectStatusEnum!`	Current status that the invoice should be set to.

Example

{
  "clientMutationId": "abc123",
  "invoiceId": 4,
  "status": "READY"
}

Types

ClickAndCollectStatusUpdateMutationPayload

Description

Autogenerated return type of ClickAndCollectStatusUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoice` - `Invoice`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "invoice": Invoice,
  "status": 987
}

Types

CommissionPackage

Description

Commission package holding commission rates for all taxons (or categories)

Fields

Field Name	Description
`appliesToPostage` - `Boolean!`	Apply commission to line item postage
`createdAt` - `ISO8601DateTime!`	When the record was created
`customCommissionRates` - `CustomCommissionRateConnection`	Custom commission rate belonging to a taxon (or category) within a commission package
Arguments `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.
`default` - `Boolean!`	The default flag identifies the default commission package in the marketplace Only accessible to users: admin_visible. And admin users with permissions: 'Manage commissions', 'Full GraphQL API access'.
`id` - `ID!`
`name` - `String!`	Name of the commission package - e.g. Bronze Package
`rate` - `Decimal!`	The commission rate for the specified Taxon (or Category)
`sellers` - `SellerConnection!`	Sellers thats use the commission package
Arguments `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.
`updatedAt` - `ISO8601DateTime!`	When the record was last updated

Example

{
  "appliesToPostage": false,
  "createdAt": ISO8601DateTime,
  "customCommissionRates": CustomCommissionRateConnection,
  "default": true,
  "id": "4",
  "name": "xyz789",
  "rate": Decimal,
  "sellers": SellerConnection,
  "updatedAt": ISO8601DateTime
}

Types

CommissionPackageConnection

Description

The connection type for CommissionPackage.

Fields

Field Name	Description
`edges` - `[CommissionPackageEdge]`	A list of edges.
`nodes` - `[CommissionPackage]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CommissionPackageEdge],
  "nodes": [CommissionPackage],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CommissionPackageCreateMutationInput

Description

Autogenerated input type of CommissionPackageCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `CommissionPackageInput!`	Attributes to assign to new commission package.

Example

{
  "clientMutationId": "xyz789",
  "attributes": CommissionPackageInput
}

Types

CommissionPackageCreateMutationPayload

Description

Autogenerated return type of CommissionPackageCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackage` - `CommissionPackage`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "commissionPackage": CommissionPackage,
  "errors": [ValidationError],
  "status": 123
}

Types

CommissionPackageDeleteMutationInput

Description

Autogenerated input type of CommissionPackageDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the commission package to be deleted
`moveToPackageId` - `ID`	ID of the commission package where sellers belonging to the deleted package are moved to. Default = `null`

Example

{
  "clientMutationId": "abc123",
  "id": 4,
  "moveToPackageId": 4
}

Types

CommissionPackageDeleteMutationPayload

Description

Autogenerated return type of CommissionPackageDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackage` - `CommissionPackage`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "commissionPackage": CommissionPackage,
  "errors": [ValidationError],
  "status": 987
}

Types

CommissionPackageEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CommissionPackage`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CommissionPackage
}

Types

CommissionPackageInput

Fields

Input Field	Description
`name` - `String!`	Name of commission packages
`rate` - `Decimal!`	Default rate for all Taxons in the commission package. If not supplied, the default rate of 5% will be applied. Default = `"5.0"`
`appliesToPostage` - `Boolean`	Default commission postage setting for all Taxons in the commission package. Default = `false`
`customCommissionRates` - `[CustomCommissionRatesInput!]`	Array of Custom commission rates for selected Taxons within the commission package.

Example

{
  "name": "abc123",
  "rate": Decimal,
  "appliesToPostage": false,
  "customCommissionRates": [CustomCommissionRatesInput]
}

Types

CommissionPackageSchedule

Fields

Field Name	Description
`activationDate` - `ISO8601DateTime!`	Plan time in future to trigger all commission_package_schedule_items
`commissionPackageScheduleItems` - `CommissionPackageScheduleItemConnection`	An array of commission package schedule items
Arguments `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.
`createdAt` - `ISO8601DateTime!`	When the record was created
`id` - `ID!`
`legacyId` - `Int!`
`name` - `String!`	Name of the uploaded schedule file
`status` - `CommissionPackageScheduleStatusEnum!`

Example

{
  "activationDate": ISO8601DateTime,
  "commissionPackageScheduleItems": CommissionPackageScheduleItemConnection,
  "createdAt": ISO8601DateTime,
  "id": 4,
  "legacyId": 123,
  "name": "xyz789",
  "status": "QUEUED"
}

Types

CommissionPackageScheduleConnection

Description

The connection type for CommissionPackageSchedule.

Fields

Field Name	Description
`edges` - `[CommissionPackageScheduleEdge]`	A list of edges.
`nodes` - `[CommissionPackageSchedule]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CommissionPackageScheduleEdge],
  "nodes": [CommissionPackageSchedule],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CommissionPackageScheduleDeleteMutationInput

Description

Autogenerated input type of CommissionPackageScheduleDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the commission package schedule to be deleted

Example

{"clientMutationId": "xyz789", "id": 4}

Types

CommissionPackageScheduleDeleteMutationPayload

Description

Autogenerated return type of CommissionPackageScheduleDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackageSchedule` - `CommissionPackageSchedule`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "commissionPackageSchedule": CommissionPackageSchedule,
  "errors": [ValidationError],
  "status": 987
}

Types

CommissionPackageScheduleEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CommissionPackageSchedule`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CommissionPackageSchedule
}

Types

CommissionPackageScheduleFilters

Description

Attributes for filtering Commission Package Schedules

Fields

Input Field	Description
`q` - `String`	Keywords to search for. (Currently File Name and ID). Default = `null`
`status` - `[CommissionPackageScheduleStatusEnum!]`	Commission Packages Scheduled with the said status. Default = `null`
`scheduledSince` - `ISO8601DateTime`	Commission Packages Scheduled for activation since this time. Default = `null`
`scheduledUntil` - `ISO8601DateTime`	Commission Packages Scheduled for activation until this time. Default = `null`

Example

{
  "q": "abc123",
  "status": ["QUEUED"],
  "scheduledSince": ISO8601DateTime,
  "scheduledUntil": ISO8601DateTime
}

Types

CommissionPackageScheduleItem

Description

Commission package schedule item within a commission package schedule

Fields

Field Name	Description
`commissionPackage` - `CommissionPackage!`	Commission package which will be assigned to the specified seller
`id` - `ID!`
`seller` - `Seller!`	Seller to which the commission package will be assigned

Example

{
  "commissionPackage": CommissionPackage,
  "id": "4",
  "seller": Seller
}

Types

CommissionPackageScheduleItemConnection

Description

The connection type for CommissionPackageScheduleItem.

Fields

Field Name	Description
`edges` - `[CommissionPackageScheduleItemEdge]`	A list of edges.
`nodes` - `[CommissionPackageScheduleItem]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CommissionPackageScheduleItemEdge],
  "nodes": [CommissionPackageScheduleItem],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

CommissionPackageScheduleItemEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CommissionPackageScheduleItem`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": CommissionPackageScheduleItem
}

Types

CommissionPackageScheduleSort

Description

Attributes for sorting commission package schedules

Fields

Input Field	Description
`fields` - `[CommissionPackageScheduleSortFieldEnum!]!`	Fields to sort commission package schedules. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["LEGACY_ID"], "ordering": "ASCENDING"}

Types

CommissionPackageScheduleSortFieldEnum

Description

The field that is used to sort commission package schedules

Values

Enum Value	Description
`LEGACY_ID`	The legacy id of the commission package schedule
`NAME`	The name of the commission package schedule
`CREATED_AT`	The date commission package schedule was created
`ACTIVATION_DATE`	The date the commission package will be activated
`STATUS`	The status of the commission package schedule

Example

"LEGACY_ID"

Types

CommissionPackageScheduleSpreadsheetDownloadMutationInput

Description

Autogenerated input type of CommissionPackageScheduleSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackageScheduleId` - `ID!`
`format` - `SpreadsheetEnum`
`invalidOnly` - `Boolean`

Example

{
  "clientMutationId": "abc123",
  "commissionPackageScheduleId": "4",
  "format": "XLSX",
  "invalidOnly": true
}

Types

CommissionPackageScheduleSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of CommissionPackageScheduleSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExportCommissionPackageSchedule`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExportCommissionPackageSchedule,
  "status": 987
}

Types

CommissionPackageScheduleSpreadsheetUploadMutationInput

Description

Autogenerated input type of CommissionPackageScheduleSpreadsheetUploadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`spreadsheet` - `FileInput!`
`activationDate` - `ISO8601DateTime!`	Plan time in future to trigger all commission_package_schedule_items

Example

{
  "clientMutationId": "abc123",
  "spreadsheet": FileInput,
  "activationDate": ISO8601DateTime
}

Types

CommissionPackageScheduleSpreadsheetUploadMutationPayload

Description

Autogenerated return type of CommissionPackageScheduleSpreadsheetUploadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`import` - `ImportExportCommissionPackageSchedule`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "import": ImportExportCommissionPackageSchedule,
  "status": 987
}

Types

CommissionPackageScheduleStatusEnum

Description

Processing status of commission package schedule

Values

Enum Value	Description
`QUEUED`	Commission package schedule yet to be processed
`FAILED`	Commission package schedule processed with errors on all rows
`SUCCESS`	Commission package schedule processed with no errors
`PARTIAL_SUCCESS`	Commission package schedule processed with errors on some rows

Example

"QUEUED"

Types

CommissionPackageSort

Description

Attributes for sorting commission packages

Fields

Input Field	Description
`fields` - `[CommissionPackageSortFieldEnum!]!`	Fields to sort commission packages. Default = `[NAME]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["NAME"], "ordering": "ASCENDING"}

Types

CommissionPackageSortFieldEnum

Description

The field that is used to sort commission packages

Values

Enum Value	Description
`NAME`	The name of the commission package
`CREATED_AT`	The date commission package was created
`UPDATED_AT`	The date commission package was last updated
`DEFAULT_RATE`	The default rate of commission package
`SELLERS_COUNT`	The number of sellers using the commission package
`CUSTOM_RATES_COUNT`	The number of custom commission rate belonging to the commission package

Example

"NAME"

Types

CommissionPackageUpdateInput

Fields

Input Field	Description
`name` - `String`	Name of commission packages
`rate` - `Decimal`	Default rate for all Taxons in the commission package.
`appliesToPostage` - `Boolean`	Default commission postage setting for all Taxons in the commission package.
`customCommissionRates` - `[CustomCommissionRatesUpdateInput!]`	Array of Custom commission rates for selected Taxons within the commission package.

Example

{
  "name": "xyz789",
  "rate": Decimal,
  "appliesToPostage": false,
  "customCommissionRates": [
    CustomCommissionRatesUpdateInput
  ]
}

Types

CommissionPackageUpdateMutationInput

Description

Autogenerated input type of CommissionPackageUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackageId` - `ID!`	ID for retrieving the correct commission package.
`attributes` - `CommissionPackageUpdateInput!`	Attributes updates for the given commission package.

Example

{
  "clientMutationId": "abc123",
  "commissionPackageId": 4,
  "attributes": CommissionPackageUpdateInput
}

Types

CommissionPackageUpdateMutationPayload

Description

Autogenerated return type of CommissionPackageUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`commissionPackage` - `CommissionPackage`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "commissionPackage": CommissionPackage,
  "errors": [ValidationError],
  "status": 987
}

Types

CommissionPackageVersion

Description

Change log of commission packages

Fields

Field Name	Description
`active` - `Boolean!`	Is the commission package version the current commission package for the seller?
`appliesToPostage` - `Boolean!`	The "applies to postage" value for the commission package version
`createdAt` - `ISO8601DateTime!`	Created at date for the commission package version
`customRates` - `CustomCommissionRateConnection`	The list of custom rates for this commission package
Arguments `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.
`defaultRate` - `Float!`	The default rate for the commission package version
`id` - `ID!`
`legacyId` - `Int`	The id used to identify the commission package version
`name` - `String!`	Name of the commission package schedule

Example

{
  "active": false,
  "appliesToPostage": false,
  "createdAt": ISO8601DateTime,
  "customRates": CustomCommissionRateConnection,
  "defaultRate": 987.65,
  "id": "4",
  "legacyId": 123,
  "name": "abc123"
}

Types

CommissionPackageVersionLog

Description

Change log of commission packages belonging a retailer

Fields

Field Name	Description
`commissionPackageVersion` - `CommissionPackageVersion!`	Commission package version of the seller.
`id` - `ID!`
`startedOn` - `ISO8601DateTime!`	Created at date for the commission package version log

Example

{
  "commissionPackageVersion": CommissionPackageVersion,
  "id": "4",
  "startedOn": ISO8601DateTime
}

Types

CommissionPackageVersionLogConnection

Description

The connection type for CommissionPackageVersionLog.

Fields

Field Name	Description
`edges` - `[CommissionPackageVersionLogEdge]`	A list of edges.
`nodes` - `[CommissionPackageVersionLog]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CommissionPackageVersionLogEdge],
  "nodes": [CommissionPackageVersionLog],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CommissionPackageVersionLogEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CommissionPackageVersionLog`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": CommissionPackageVersionLog
}

Types

ComparableUnitEnum

Description

Measurement units for comparison

Values

Enum Value	Description
`MM`	Millimetres
`CM`	Centimetres
`M`	Metres
`MG`	Milligrams
`G`	Grams
`KG`	Kilograms
`ML`	Millilitres
`CL`	Centilitres
`L`	Litres
`KL`	Kilolitres
`SQM`	Square metres
`PACK`	Pack
`SHEET`	Sheet
`EACH`	Each
`MI`	Miles
`YD`	Yards
`FT`	Feet
`IN`	Inches
`LB`	Pounds
`OZ`	Ounces
`GAL`	Gallons
`QT`	Quarts
`PT`	Pints
`C`	Cups
`FL_OZ`	Fluid ounces
`TBSP`	Tablespoons
`TSP`	Teaspoons

Example

"MM"

Types

ConditionFilterOption

Description

Condition type which can be used to build a Condition filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with the condition filter option
`id` - `ID!`
`name` - `String!`

Example

{
  "count": 987,
  "id": "4",
  "name": "xyz789"
}

Types

ContactDetails

Description

Contact details

Fields

Field Name	Description
`phone` - `String`	Phone number

Example

{"phone": "abc123"}

Types

ContextualHistory

Fields

Field Name	Description
`changes` - `JSON`
`createdAt` - `ISO8601DateTime!`
`event` - `String!`
`id` - `ID!`
`itemId` - `Int!`
`itemType` - `String!`
`origin` - `String`
`whodunnit` - `String`
`whodunnitName` - `String`
`whodunnitType` - `String`

Example

{
  "changes": {},
  "createdAt": ISO8601DateTime,
  "event": "xyz789",
  "id": 4,
  "itemId": 987,
  "itemType": "xyz789",
  "origin": "abc123",
  "whodunnit": "xyz789",
  "whodunnitName": "abc123",
  "whodunnitType": "xyz789"
}

Types

ContextualHistoryConnection

Description

The connection type for ContextualHistory.

Fields

Field Name	Description
`edges` - `[ContextualHistoryEdge]`	A list of edges.
`nodes` - `[ContextualHistory]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ContextualHistoryEdge],
  "nodes": [ContextualHistory],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

ContextualHistoryEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ContextualHistory`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ContextualHistory
}

Types

Country

Description

Country information.

Fields

Field Name	Description
`code` - `String!`	Two-letter UPPERCASE country code, e.g. "DE"
`id` - `ID!`
`name` - `String!`	Country name, e.g. "Germany"
`states` - `StatesConnection`	States of this country.
Arguments `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

{
  "code": "abc123",
  "id": "4",
  "name": "xyz789",
  "states": StatesConnection
}

Types

CountryInput

Description

Input for associating a country with an address. One argument is required for creation. If more than one argument is given, the first valid argument will define the country (the order is "id" then "code").

Fields

Input Field	Description
`code` - `String`	Two-letter abbreviation of the country name.
`id` - `ID`	Database ID for the given country.

Example

{"code": "abc123", "id": 4}

Types

CountrysConnection

Description

The connection type for Country.

Fields

Field Name	Description
`edges` - `[CountrysEdge]`	A list of edges.
`nodes` - `[Country]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CountrysEdge],
  "nodes": [Country],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CountrysEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Country`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Country
}

Types

Currency

Description

Currency details

Fields

Field Name	Description
`code` - `String!`	3-letter currency code as defined by the ISO 4217 standard
`name` - `String!`	Translated currency name
`symbol` - `String!`	Currency symbol

Example

{
  "code": "abc123",
  "name": "abc123",
  "symbol": "xyz789"
}

Types

CustomCommissionRate

Description

Custom commission rate belonging to a taxon (or category) within a commission package

Fields

Field Name	Description
`commissionPackage` - `CommissionPackage!`	The Commission Package that the custom commission rate belongs to - e.g. Bronze Package
`id` - `ID!`
`overThresholdRate` - `Decimal`	The commission rate % once the thresholdPrice has been reached
`rate` - `Decimal!`	The commission rate for the specified Taxon (or Category)
`taxon` - `Taxon!`	The Taxon (or Category) that the custom commission rate belongs to - eg. Bikes, Shoes, Wigs
`thresholdPrice` - `Decimal`	The price limit (e.g. "500.00") set before over_threshold_rate takes into effect
`updatedAt` - `ISO8601DateTime!`	updated at date for the custom commission rate

Example

{
  "commissionPackage": CommissionPackage,
  "id": "4",
  "overThresholdRate": Decimal,
  "rate": Decimal,
  "taxon": Taxon,
  "thresholdPrice": Decimal,
  "updatedAt": ISO8601DateTime
}

Types

CustomCommissionRateConnection

Description

The connection type for CustomCommissionRate.

Fields

Field Name	Description
`edges` - `[CustomCommissionRateEdge]`	A list of edges.
`nodes` - `[CustomCommissionRate]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CustomCommissionRateEdge],
  "nodes": [CustomCommissionRate],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CustomCommissionRateEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CustomCommissionRate`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CustomCommissionRate
}

Types

CustomCommissionRatesInput

Fields

Input Field	Description
`rate` - `Decimal`	Rate for specific Taxon in the commission package. If not supplied, the default rate of 5% will be applied
`taxonId` - `ID!`	ID of Taxon to which the custom rate, and applies_to_postage applies.
`thresholdPrice` - `Decimal`	The price limit (e.g. "500.00") set before over_threshold_rate takes into effect
`overThresholdRate` - `Decimal`	The commission rate % once the thresholdPrice has been reached

Example

{
  "rate": Decimal,
  "taxonId": "4",
  "thresholdPrice": Decimal,
  "overThresholdRate": Decimal
}

Types

CustomCommissionRatesUpdateInput

Description

Creates a Custom Commission Rate if no ID is passed, otherwise updates existing Custom Commission Rate, for which an ID is required

Fields

Input Field	Description
`id` - `ID`	ID of custom commission rate. Supply this if you want to update an existing taxon's rate, otherwise leave blank to create a new taxon and rate
`rate` - `Decimal`	Rate for specific Taxon in the commission package. If not supplied for a new custom commission rate, the default rate of 5% will be applied
`taxonId` - `ID`	ID of Taxon to which the custom rate, and applies_to_postage applies. If updating an existing taxon, supply the id field
`delete` - `Boolean`	Boolean flag to delete custom commission rate. False by default, change to true if you want to delete this custom rate
`thresholdPrice` - `Decimal`	The price limit (e.g. "500.00") set before over_threshold_rate takes into effect
`overThresholdRate` - `Decimal`	The commission rate % once the thresholdPrice has been reached

Example

{
  "id": 4,
  "rate": Decimal,
  "taxonId": 4,
  "delete": false,
  "thresholdPrice": Decimal,
  "overThresholdRate": Decimal
}

Types

CustomField

Description

Custom Fields can be created to hold categories of data not otherwise available in the standard schema. Custom Fields must not be used to store Personally Identifiable Information (PII).

Fields

Field Name	Description
`customFieldOptions` - `[CustomFieldOption!]`
`defaultValue` - `String`	The default value for this custom field
`description` - `String`
`fieldType` - `CustomFieldFieldTypeEnum!`
`id` - `ID!`
`name` - `String!`
`placeholder` - `String`
`readonly` - `Boolean!`
`required` - `Boolean!`

Example

{
  "customFieldOptions": [CustomFieldOption],
  "defaultValue": "abc123",
  "description": "xyz789",
  "fieldType": "TEXT",
  "id": 4,
  "name": "abc123",
  "placeholder": "abc123",
  "readonly": false,
  "required": false
}

Types

CustomFieldConnection

Description

The connection type for CustomField.

Fields

Field Name	Description
`edges` - `[CustomFieldEdge]`	A list of edges.
`nodes` - `[CustomField]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CustomFieldEdge],
  "nodes": [CustomField],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CustomFieldCreateOrUpdateMutationInput

Description

Autogenerated input type of CustomFieldCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the CustomFieldType to update
`attributes` - `CustomFieldInput!`	Attributes to assign to the CustomField. NOTE: fieldType is set when the customField is created and can't be updated.

Example

{
  "clientMutationId": "abc123",
  "id": "4",
  "attributes": CustomFieldInput
}

Types

CustomFieldCreateOrUpdateMutationPayload

Description

Autogenerated return type of CustomFieldCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`customField` - `CustomField`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "customField": CustomField,
  "errors": [ValidationError],
  "status": 123
}

Types

CustomFieldDeleteMutationInput

Description

Autogenerated input type of CustomFieldDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the CustomField to delete

Example

{
  "clientMutationId": "xyz789",
  "id": "4"
}

Types

CustomFieldDeleteMutationPayload

Description

Autogenerated return type of CustomFieldDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`customField` - `CustomField`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "customField": CustomField,
  "errors": [ValidationError],
  "status": 987
}

Types

CustomFieldEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CustomField`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": CustomField
}

Types

CustomFieldFieldTypeEnum

Description

Data type for the CustomField

Values

Enum Value	Description
`TEXT`	Text field
`BOOLEAN`	Boolean field
`EMAIL_ADDRESS`	Email address field
`URL`	URL field
`SINGLE_SELECT`	Single Select field, it only works if CustomFieldOption records are included
`MULTI_SELECT`	Multi Select field, it only works if CustomFieldOption records are included

Example

"TEXT"

Types

CustomFieldGroup

Description

Information relating to a group of CustomFields, including the information for any associated CustomField records

Fields

Field Name	Description
`customFields` - `CustomFieldConnection!`
Arguments `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.
`description` - `String`
`entity` - `CustomFieldGroupEntityEnum!`
`id` - `ID!`
`name` - `String!`

Example

{
  "customFields": CustomFieldConnection,
  "description": "abc123",
  "entity": "SELLER",
  "id": "4",
  "name": "xyz789"
}

Types

CustomFieldGroupCreateOrUpdateMutationInput

Description

Autogenerated input type of CustomFieldGroupCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the CustomFieldGroupType to update
`attributes` - `CustomFieldGroupInput!`	Attributes to assign to the CustomFieldGroup

Example

{
  "clientMutationId": "abc123",
  "id": "4",
  "attributes": CustomFieldGroupInput
}

Types

CustomFieldGroupCreateOrUpdateMutationPayload

Description

Autogenerated return type of CustomFieldGroupCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`customFieldGroup` - `CustomFieldGroup`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "customFieldGroup": CustomFieldGroup,
  "errors": [ValidationError],
  "status": 123
}

Types

CustomFieldGroupDeleteMutationInput

Description

Autogenerated input type of CustomFieldGroupDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the CustomFieldGroup to delete

Example

{
  "clientMutationId": "xyz789",
  "id": "4"
}

Types

CustomFieldGroupDeleteMutationPayload

Description

Autogenerated return type of CustomFieldGroupDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`customFieldGroup` - `CustomFieldGroup`
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "customFieldGroup": CustomFieldGroup,
  "errors": [ValidationError],
  "status": 987
}

Types

CustomFieldGroupEntityEnum

Description

Entity that the CustomFieldGroup applies to - e.g. Sellers

Values

Enum Value	Description
`SELLER`	Apply to Sellers
`SHIPPING_RULE`	Apply to Shipping Rules

Example

"SELLER"

Types

CustomFieldGroupInput

Description

Attributes for creating or updating a CustomFieldGroup

Fields

Input Field	Description
`name` - `String!`	Name for the CustomFieldGroup
`description` - `String`	Description for the CustomFieldGroup
`entity` - `CustomFieldGroupEntityEnum!`	Entity that this CustomFieldGroup is applies to

Example

{
  "name": "xyz789",
  "description": "abc123",
  "entity": "SELLER"
}

Types

CustomFieldGroupsConnection

Description

The connection type for CustomFieldGroup.

Fields

Field Name	Description
`edges` - `[CustomFieldGroupsEdge]`	A list of edges.
`nodes` - `[CustomFieldGroup]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [CustomFieldGroupsEdge],
  "nodes": [CustomFieldGroup],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

CustomFieldGroupsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `CustomFieldGroup`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": CustomFieldGroup
}

Types

CustomFieldInput

Description

Attributes for creating or updating a CustomField

Fields

Input Field	Description
`customFieldGroupId` - `ID!`	ID of the associated CustomFieldGroup
`name` - `String!`	Name for the CustomField
`description` - `String`	Description for the CustomField
`placeholder` - `String`	Placeholder for the CustomField
`fieldType` - `CustomFieldFieldTypeEnum!`	Expected data type for the CustomField. NOTE: this field is set when the CustomField is created and can't be updated.
`required` - `Boolean`	Determines whether a CustomField is required or optional. A CustomField can be set to optional (required: false) or required (required: true). Consider if you need to make a field required. Setting a field to required can cause integration issues (potentially causing breaking changes), and increase the chance of validation errors. Once a CustomField is set to optional it cannot be changed to required; but you can change it from required to optional. Default = `false`
`defaultValue` - `String`	Default value for the CustomField

Example

{
  "customFieldGroupId": "4",
  "name": "abc123",
  "description": "abc123",
  "placeholder": "abc123",
  "fieldType": "TEXT",
  "required": false,
  "defaultValue": "xyz789"
}

Types

CustomFieldOption

Description

A type representing a custom field option.

Fields

Field Name	Description
`id` - `ID!`
`label` - `String!`	The label of the custom field option.
`value` - `String!`	The value of the custom field option.

Example

{
  "id": "4",
  "label": "abc123",
  "value": "xyz789"
}

Types

CustomFieldValueInput

Description

Attributes for creating or updating a CustomFieldValues

Fields

Input Field	Description
`customFieldId` - `ID!`	ID of the associated CustomField
`value` - `JSON!`	Value for the CustomField

Example

{"customFieldId": 4, "value": {}}

Types

CustomFormQuestions

Description

Question on the custom form template

Fields

Field Name	Description
`questions` - `[CustomFormQuestionsFields!]!`

Example

{"questions": [CustomFormQuestionsFields]}

Types

CustomFormQuestionsFields

Description

Custom form template question fields

Fields

Field Name	Description
`label` - `String!`
`options` - `[String!]!`
`required` - `Boolean!`
`type` - `String!`

Example

{
  "label": "abc123",
  "options": ["abc123"],
  "required": false,
  "type": "xyz789"
}

Types

CustomFormTemplate

Description

Custom form template

Fields

Field Name	Description
`fields` - `CustomFormQuestions!`

Example

{"fields": CustomFormQuestions}

Types

CustomNavLink

Description

Navigation link

Fields

Field Name	Description
`image` - `String`	Image to render. `text` represents alt text when `image` is present
`text` - `String!`
`url` - `String!`

Example

{
  "image": "xyz789",
  "text": "abc123",
  "url": "xyz789"
}

Types

CustomisationSettings

Description

Site wide customization settings for a marketplace

Fields

Field Name	Description
`alternativeSearchSortOptions` - `[String!]!`	Alternative sort order options
`defaultSearchPerPage` - `Int!`	Default search results displayed per page
`galleryImageFormat` - `ImageGalleryLayoutEnum!`	Gallery image format
`galleryThumbnailFormat` - `ImageGalleryLayoutEnum!`	Gallery thumbnail format
`galleryThumbnailOrientation` - `ImageGalleryOrientationEnum!`	Gallery thumbnail orientation
`id` - `ID!`
`showSearchLocation` - `Boolean!`	True if we want to allow a user to specify a location in their search

Example

{
  "alternativeSearchSortOptions": [
    "abc123"
  ],
  "defaultSearchPerPage": 123,
  "galleryImageFormat": "padded",
  "galleryThumbnailFormat": "padded",
  "galleryThumbnailOrientation": "horizontal",
  "id": "4",
  "showSearchLocation": true
}

Types

DateRangeInput

Description

Specify desired date ranges.

Fields

Input Field	Description
`gt` - `ISO8601DateTime`	Objects after the given datetime
`lt` - `ISO8601DateTime`	Objects before the given datetime
`lte` - `ISO8601DateTime`	Objects before the given datetime inclusive
`gte` - `ISO8601DateTime`	Objects after the given datetime inclusive

Example

{
  "gt": ISO8601DateTime,
  "lt": ISO8601DateTime,
  "lte": ISO8601DateTime,
  "gte": ISO8601DateTime
}

Types

Decimal

Description

A decimal value, transported as a string. (Allows large accurate numbers)

Example

Decimal

Types

DeletedAdvert

Description

A deleted advert

Fields

Field Name	Description
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`legacyId` - `Int!`
`updatedAt` - `ISO8601DateTime!`
`variants` - `AllAdvertVariantConnection!`
Arguments `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

{
  "externalIds": [ExternalID],
  "id": 4,
  "legacyId": 123,
  "updatedAt": ISO8601DateTime,
  "variants": AllAdvertVariantConnection
}

Types

DeletedSeller

Description

A deleted seller

Fields

Field Name	Description
`id` - `ID!`
`legacyId` - `Int!`
`updatedAt` - `ISO8601DateTime!`

Example

{
  "id": "4",
  "legacyId": 987,
  "updatedAt": ISO8601DateTime
}

Types

DeliveryMethodEnum

Description

How the buyer expects to receive a purchased item.

Values

Enum Value	Description
`DELIVER`	The buyer has purchased the item online and is having it delivered.
`PICK_UP_IN_STORE`	The buyer has purchased the item online and will pick it up at the store.
`NO_DISPATCH`	Either the item is not deliverable or the buyer will receive the item in a non-standard way.

Example

"DELIVER"

Types

DeliveryTypeEnum

Description

Label for different methods by which a user can purchase and receive their item.

Values

Enum Value	Description
`BUY_ONLINE`	The entire transaction takes place online, and the item is delivered.
`CLICK_AND_COLLECT`	The item is purchased online, but the user picks it up at the store.
`NO_DISPATCH`	For items that are neither delivered nor picked up. Usually for bookings (e.g. hotels, tours)

Example

"BUY_ONLINE"

Types

DirectLink

Description

A menu entry with a direct link

Fields

Field Name	Description
`id` - `ID!`
`link` - `String!`	Direct link to a page
`name` - `String!`	Presentational name of the entry

Example

{
  "id": 4,
  "link": "xyz789",
  "name": "xyz789"
}

Types

DiscountTypeEnum

Description

Promotion discount type

Values

Enum Value	Description
`DOLLAR`	Discount as a flat dollar amount.
`PERCENT`	Discount as a percentage.
`DOLLAR_REPEATING`	Discount as a flat dollar amount for every N dollars.
`DOLLAR_PER_UNIT`	Discount as a dollar amount per unit.

Example

"DOLLAR"

Types

ESAdvert

Description

An advert (elasticsearch cached)

Fields

Field Name	Description
`availability` - `[AdvertAvailabilityEnum!]!`	Availability of the advert
`brand` - `ESBrand`
`cityDisplay` - `String!`	City to be displayed on the advert tile
`dbAdvert` - `Advert`	Main Advert type for occasions extra fields are required. NOTE: much slower
`dbBrand` - `Brand`	Main Brand type for occasions extra fields are required. NOTE: much slower
`dbSeller` - `Seller`	Main Seller type for occasions extra fields are required. NOTE: much slower
`displayImage` - `Image`	Image to display on the advert tile.
`fullTitle` - `String!`	Title for display (may include Brand and Model Year depending on configuration)
`id` - `ID!`
`isFeatured` - `Boolean`
`isPromoted` - `Boolean`
`legacyId` - `Int!`
`lowestOriginalPriceCents` - `Int`	Absolute lowest price (sale price or original price) available for the item in session currency. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lowestOriginalPriceFormatted` - `String`	Absolute lowest price (sale price or original price) available for the item in session currency. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lowestOriginalPriceInSessionCurrency` - `String`	Lowest non-sale price available for the item in session currency. Useful for display purpose only as all monetary transactions will be charged in the marketplace currency.
`lowestPriceCents` - `Int`	Absolute lowest price (sale price or original price) available for the item in session currency. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lowestPriceFormatted` - `String`	Absolute lowest price (sale price or original price) available for the item in session currency. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lowestPriceInSessionCurrency` - `String`	Absolute lowest price (sale price or original price) available for the item in session currency. Useful for display purpose only as all monetary transactions will be charged in the marketplace currency.
`originalPriceFormatted` - `String`	Original price formatted as a string (e.g. 'From $30')
`pagePath` - `String!`
`promotionEndTime` - `String`	The end time of the most recent active promotion that this advert is part of. It will return null if there are no active promotions for the advert.
`promotionStartTime` - `String`	The start time of the most recent active promotion that this advert is part of. It will return null if there are no active promotions for the advert.
`promotionText` - `String`	The name of the most recent active promotion that this advert is part of.
`rating` - `AdvertRating`	Rating reviews
`salePriceFormatted` - `String!`	Sale price formatted as a string e.g. ('Now from $21')
`seller` - `ESSeller!`
`taxon` - `ESTaxon!`
`title` - `String!`

Example

{
  "availability": ["HIRE"],
  "brand": ESBrand,
  "cityDisplay": "abc123",
  "dbAdvert": Advert,
  "dbBrand": Brand,
  "dbSeller": Seller,
  "displayImage": Image,
  "fullTitle": "abc123",
  "id": 4,
  "isFeatured": false,
  "isPromoted": false,
  "legacyId": 123,
  "lowestOriginalPriceCents": 123,
  "lowestOriginalPriceFormatted": "abc123",
  "lowestOriginalPriceInSessionCurrency": "xyz789",
  "lowestPriceCents": 123,
  "lowestPriceFormatted": "abc123",
  "lowestPriceInSessionCurrency": "abc123",
  "originalPriceFormatted": "abc123",
  "pagePath": "xyz789",
  "promotionEndTime": "xyz789",
  "promotionStartTime": "xyz789",
  "promotionText": "xyz789",
  "rating": AdvertRating,
  "salePriceFormatted": "xyz789",
  "seller": ESSeller,
  "taxon": ESTaxon,
  "title": "xyz789"
}

Types

ESAdvertsConnection

Description

The connection type for ESAdvert.

Fields

Field Name	Description
`edges` - `[ESAdvertsEdge]`	A list of edges.
`nodes` - `[ESAdvert]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ESAdvertsEdge],
  "nodes": [ESAdvert],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ESAdvertsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ESAdvert`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ESAdvert
}

Types

ESBrand

Description

A brand (elasticsearch cached)

Fields

Field Name	Description
`id` - `ID!`
`logo` - `Image`
`name` - `String!`

Example

{
  "id": "4",
  "logo": Image,
  "name": "abc123"
}

Types

ESBrandSearch

Description

A searched brand (elasticsearch cached)

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`

Example

{"id": 4, "name": "abc123"}

Types

ESBrandSearchConnection

Description

The connection type for ESBrandSearch.

Fields

Field Name	Description
`edges` - `[ESBrandSearchEdge]`	A list of edges.
`nodes` - `[ESBrandSearch]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ESBrandSearchEdge],
  "nodes": [ESBrandSearch],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ESBrandSearchEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ESBrandSearch`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ESBrandSearch
}

Types

ESSeller

Description

A brand (elasticsearch cached)

Fields

Field Name	Description
`businessName` - `String!`
`id` - `ID!`
`isPrivate` - `Boolean!`	True if the seller is a private store
`managedMultiStore` - `MultiStore`
`multiStoreMemberships` - `[MultiStoreMembership!]`
`shopAdvertSearchPath` - `String`	Path to a retailer-specific advert search results page that only shows adverts from the given seller.

Example

{
  "businessName": "abc123",
  "id": "4",
  "isPrivate": true,
  "managedMultiStore": MultiStore,
  "multiStoreMemberships": [MultiStoreMembership],
  "shopAdvertSearchPath": "xyz789"
}

Types

ESTaxon

Description

A taxon (elasticsearch cached)

Fields

Field Name	Description
`displayName` - `String!`
`id` - `ID!`

Example

{"displayName": "xyz789", "id": 4}

Types

EmailMarketing

Description

Email direct marketing data

Fields

Field Name	Description
`edmEnabled` - `Boolean!`	Is email direct marketing enabled for this site?
`gdprSubscriptionCheckboxEnabled` - `Boolean!`	Should GDPR subscription checkbox be enabled for this site?
`id` - `ID!`
`newsletterSubscriptionForm` - `NewsletterSubscriptionForm`	Newsletter subscription
`privacyPolicyLink` - `TextLink!`	Link to a privacy policy

Example

{
  "edmEnabled": true,
  "gdprSubscriptionCheckboxEnabled": false,
  "id": "4",
  "newsletterSubscriptionForm": NewsletterSubscriptionForm,
  "privacyPolicyLink": TextLink
}

Types

EnrolAuthenticatorMutationInput

Description

Autogenerated input type of EnrolAuthenticatorMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`mfaToken` - `String`	If the user already has an authenticator set up, they need to confirm that they still have it in order to re-display the QR code to enrol the secret into a new authenticator app.

Example

{
  "clientMutationId": "xyz789",
  "mfaToken": "xyz789"
}

Types

EnrolAuthenticatorMutationPayload

Description

Autogenerated return type of EnrolAuthenticatorMutation.

Fields

Field Name	Description
`authenticator` - `TOTP`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "authenticator": TOTP,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

EntityCustomField

Description

Custom Fields can be created to hold categories of data not otherwise available in the standard schema. Custom Fields must not be used to store Personally Identifiable Information (PII).

Fields

Field Name	Description
`customFieldOptions` - `[CustomFieldOption!]`
`defaultValue` - `String`	The default value for this custom field
`description` - `String`
`fieldType` - `CustomFieldFieldTypeEnum!`
`id` - `ID!`
`name` - `String!`
`placeholder` - `String`
`readonly` - `Boolean!`
`required` - `Boolean!`
`value` - `JSON`	Customised fields value for the custom field.

Example

{
  "customFieldOptions": [CustomFieldOption],
  "defaultValue": "abc123",
  "description": "abc123",
  "fieldType": "TEXT",
  "id": "4",
  "name": "abc123",
  "placeholder": "xyz789",
  "readonly": false,
  "required": true,
  "value": {}
}

Types

EntityCustomFieldConnection

Description

The connection type for EntityCustomField.

Fields

Field Name	Description
`edges` - `[EntityCustomFieldEdge]`	A list of edges.
`nodes` - `[EntityCustomField]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [EntityCustomFieldEdge],
  "nodes": [EntityCustomField],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

EntityCustomFieldEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `EntityCustomField`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": EntityCustomField
}

Types

EntityCustomFieldGroup

Description

Information relating to a group of CustomFields, including the information for any associated CustomField records

Fields

Field Name	Description
`customFields` - `EntityCustomFieldConnection!`
Arguments `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.
`description` - `String`
`entity` - `CustomFieldGroupEntityEnum!`
`id` - `ID!`
`name` - `String!`

Example

{
  "customFields": EntityCustomFieldConnection,
  "description": "abc123",
  "entity": "SELLER",
  "id": 4,
  "name": "abc123"
}

Types

EntityCustomFieldGroupConnection

Description

The connection type for EntityCustomFieldGroup.

Fields

Field Name	Description
`edges` - `[EntityCustomFieldGroupEdge]`	A list of edges.
`nodes` - `[EntityCustomFieldGroup]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [EntityCustomFieldGroupEdge],
  "nodes": [EntityCustomFieldGroup],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

EntityCustomFieldGroupEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `EntityCustomFieldGroup`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": EntityCustomFieldGroup
}

Types

EntityCustomFieldGroupsConnection

Description

The connection type for EntityCustomFieldGroup.

Fields

Field Name	Description
`edges` - `[EntityCustomFieldGroupsEdge]`	A list of edges.
`nodes` - `[EntityCustomFieldGroup]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [EntityCustomFieldGroupsEdge],
  "nodes": [EntityCustomFieldGroup],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

EntityCustomFieldGroupsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `EntityCustomFieldGroup`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": EntityCustomFieldGroup
}

Types

ErrorMessage

Fields

Field Name	Description
`field` - `String`
`messages` - `[String!]!`

Example

{
  "field": "abc123",
  "messages": ["xyz789"]
}

Types

ExperimentalAi

Description

Experimental AI queries. Is going to change, don't rely on this.

Fields

Field Name	Description
`generateDescription` - `String!`	Generate a description for a product given a title and optionally a description.
Arguments `title` - `String!` `description` - `String`

Example

{"generateDescription": "xyz789"}

Types

ExternalAccountSettings

Description

External service account settings

Fields

Field Name	Description
`beamerProductId` - `String`	Beamer is no longer used. Do not use this field. This will be removed no earlier than 2024-04-01.
`cookieBotDomainGroupId` - `String`
`facebookAppId` - `String`	App ID required by Facebook API's to enable social media sharing features on its platform
`googleAdManagerAccountId` - `String`	Google ad manager account id. Used to show google advertisements on the front end
`heapAnalyticsKey` - `String`	Heap Analytics is no longer used. Do not use this field. This will be removed no earlier than 2024-01-01.
`id` - `ID!`
`useGoogleAds` - `Boolean!`	True if we display google ads on the front end

Example

{
  "beamerProductId": "xyz789",
  "cookieBotDomainGroupId": "abc123",
  "facebookAppId": "abc123",
  "googleAdManagerAccountId": "abc123",
  "heapAnalyticsKey": "abc123",
  "id": 4,
  "useGoogleAds": true
}

Types

ExternalID

Description

External IDs

Fields

Field Name	Description
`id` - `ID!`
`key` - `String!`
`owner` - `Node!`
`value` - `String!`

Example

{
  "id": "4",
  "key": "abc123",
  "owner": Node,
  "value": "abc123"
}

Types

ExternalIDInput

Description

External ID key and values to search for

Fields

Input Field	Description
`key` - `String!`
`value` - `[String!]!`

Example

{
  "key": "abc123",
  "value": ["abc123"]
}

Types

ExternalIDUpsertMutationInput

Description

Autogenerated input type of ExternalIDUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`owner` - `ID!`	ID of the local object to link
`key` - `String!`	Name of the remote system for the ID, eg. 'my_system'
`value` - `String!`	ID on the remote system
`ownerKeyUnique` - `Boolean`	`The default is for an ExternalID's owner/key/value to be unique. For example, owner: 'Advert', key: 'my_store', value: '23'. When this flag is set to true, any existing owner/key pair will be created or updated - eg. if an ExternalID exists with an owner of 'Advert' and a key of 'my_store', this record will be found and updated with the new value, or created if it does not exist. Default is false.`

Example

{
  "clientMutationId": "abc123",
  "owner": 4,
  "key": "xyz789",
  "value": "abc123",
  "ownerKeyUnique": false
}

Types

ExternalIDUpsertMutationPayload

Description

Autogenerated return type of ExternalIDUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`externalId` - `ExternalID`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "externalId": ExternalID,
  "status": 987
}

Types

ExternalIdsUpsertMutationInput

Description

Autogenerated input type of ExternalIdsUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`ownerId` - `ID!`	ID of the local object to link
`externalIds` - `[KeyValueInput!]!`	Key/Value pairs for the metadata

Example

{
  "clientMutationId": "abc123",
  "ownerId": 4,
  "externalIds": [KeyValueInput]
}

Types

ExternalIdsUpsertMutationPayload

Description

Autogenerated return type of ExternalIdsUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`externalIds` - `[ExternalID!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "externalIds": [ExternalID],
  "status": 123
}

Types

FieldTypeEnum

Description

The character of the option type on how option values are stored.

Values

Enum Value	Description
`SINGLE_SELECT`	An option type that can only have one option value assigned from a list of values.
`MULTI_SELECT`	An option type that can have multiple option values assigned from a list of values.
`FREE_TEXT`	An option type where a the seller can input any label rather than selecting from a fixed list of values

Example

"SINGLE_SELECT"

Types

FileInput

Description

File upload.

Fields

Input Field	Description
`dataBase64` - `String!`	The image data, base64 encoded.
`filename` - `String!`	The filename that will be used to label this image.

Example

{
  "dataBase64": "xyz789",
  "filename": "xyz789"
}

Types

FinanceSettings

Description

Site wide customization settings for a marketplace

Fields

Field Name	Description
`creditNotesEnabled` - `Boolean`	Indicates if credit notes feature is enabled for this vertical
`immutableTaxDocumentsEnabled` - `Boolean!`	True if immutable tax documents is enabled
`itemTaxRate` - `Float`	Value used for placeholder and any messaging around Vertical default Tax Rate

Example

{
  "creditNotesEnabled": true,
  "immutableTaxDocumentsEnabled": true,
  "itemTaxRate": 123.45
}

Types

Float

Description

Represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

Footer

Description

Data for composing a site footer

Fields

Field Name	Description
`columns` - `[FooterColumn!]`	Footer columns
`edmSubscriptionEnabled` - `Boolean!`	Enable EDM subscription in the footer?
`id` - `ID!`
`showLegalInfo` - `Boolean!`	Show legal info? (true/false)

Example

{
  "columns": [FooterColumn],
  "edmSubscriptionEnabled": true,
  "id": 4,
  "showLegalInfo": true
}

Types

FooterColumn

Description

Data for composing a site footer

Fields

Field Name	Description
`content` - `String!`	Column's content as Markdown
`contentHtml` - `String!`	Column's content as HTML
`header` - `String!`	Column's header as a string

Example

{
  "content": "abc123",
  "contentHtml": "abc123",
  "header": "xyz789"
}

Types

FreeTextAndSelectField

Description

A free text field with a select input field

Fields

Field Name	Description
`freeTextField` - `FreeTextField!`
`name` - `String!`
`selectField` - `SelectField!`

Example

{
  "freeTextField": FreeTextField,
  "name": "abc123",
  "selectField": SelectField
}

Types

FreeTextField

Description

Text field where any user input is accepted

Fields

Field Name	Description
`name` - `String!`

Example

{"name": "abc123"}

Types

FreetextOptionValue

Fields

Field Name	Description
`id` - `ID!`	ID of the object.
`optionType` - `OptionType!`
`value` - `String`

Example

{
  "id": "4",
  "optionType": OptionType,
  "value": "abc123"
}

Types

FreetextOptionValueConnection

Description

The connection type for FreetextOptionValue.

Fields

Field Name	Description
`edges` - `[FreetextOptionValueEdge]`	A list of edges.
`nodes` - `[FreetextOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [FreetextOptionValueEdge],
  "nodes": [FreetextOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

FreetextOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `FreetextOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": FreetextOptionValue
}

Types

GenderFilterOption

Description

Gender type which can be used to build a gender filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with the gender filter option
`id` - `ID!`
`name` - `String!`
`slug` - `String!`

Example

{
  "count": 987,
  "id": "4",
  "name": "abc123",
  "slug": "abc123"
}

Types

GivexSettings

Description

Givex settings for ecommerce.

Fields

Field Name	Description
`category` - `CategoryTypeEnum!`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`givexPaymentMethod` - `ID`
`logoUrl` - `String!`
`overrideCustomMerchantFee` - `Boolean!`
`password` - `String`
`primaryApiUrl` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`secondaryApiUrl` - `String`
`status` - `StatusTypeEnum!`
`userId` - `String`

Example

{
  "category": "RATINGS_AND_REVIEWS",
  "customMerchantBaseFeeCents": 987,
  "customMerchantBaseFeeFormatted": "xyz789",
  "customMerchantFee": 987.65,
  "description": "xyz789",
  "givexPaymentMethod": 4,
  "logoUrl": "xyz789",
  "overrideCustomMerchantFee": true,
  "password": "abc123",
  "primaryApiUrl": "abc123",
  "providerHandle": "abc123",
  "providerName": "abc123",
  "secondaryApiUrl": "xyz789",
  "status": "AVAILABLE",
  "userId": "abc123"
}

Types

GivexSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of GivexSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`primaryApiUrl` - `String!`	Givex primary API URL.
`secondaryApiUrl` - `String!`	Givex fallback API URL.
`userId` - `String!`	Givex User ID.
`password` - `String!`	Givex password.
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.

Example

{
  "clientMutationId": "abc123",
  "primaryApiUrl": "xyz789",
  "secondaryApiUrl": "xyz789",
  "userId": "xyz789",
  "password": "xyz789",
  "overrideCustomMerchantFee": true,
  "customMerchantFee": "abc123",
  "customMerchantBaseFee": "xyz789"
}

Types

GivexSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of GivexSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`givexSettings` - `GivexSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "givexSettings": GivexSettings,
  "status": 123
}

Types

GivexSettingsDeleteMutationInput

Description

Autogenerated input type of GivexSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

GivexSettingsDeleteMutationPayload

Description

Autogenerated return type of GivexSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`givexSettings` - `GivexSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "givexSettings": GivexSettings,
  "status": 987
}

Types

GlobalSearchResult

Description

Mixed search result records belonging to retailer

Fields

Field Name	Description
`details` - `JSON!`
`id` - `ID!`
`recordType` - `String!`

Example

{
  "details": {},
  "id": 4,
  "recordType": "abc123"
}

Types

GlobalSearchResultsConnection

Description

The connection type for GlobalSearchResult.

Fields

Field Name	Description
`edges` - `[GlobalSearchResultsEdge]`	A list of edges.
`nodes` - `[GlobalSearchResult]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GlobalSearchResultsEdge],
  "nodes": [GlobalSearchResult],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

GlobalSearchResultsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GlobalSearchResult`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": GlobalSearchResult
}

Types

GoldenProduct

Description

A golden product record.

Fields

Field Name	Description
`active` - `Boolean!`	True if at least one item under this golden product record is active
`adverts` - `AdvertConnection!`	Adverts associated to the golden product
Arguments `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. `displayableOnly` - `Boolean` Whether to only fetch adverts that are displayable (e.g. are valid, have inventory available)
`brand` - `Brand`	Brand of the golden product record.
`createdAt` - `ISO8601DateTime!`	When the golden product record was created.
`customIframeThumbnail` - `Image`
`customIframeUrl` - `String`
`description` - `String`	Description for the golden product record.
`documents` - `GoldenProductDocumentsConnection`	PDF documents for information on product.
Arguments `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.
`externalIds` - `[ExternalID!]!`	External ids linked to the golden product record.
`goldenProductVariants` - `GoldenProductVariantsConnection`	Golden product variants
Arguments `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.
`id` - `ID!`
`images` - `ImagesConnection`
Arguments `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.
`legacyId` - `Int!`
`measurementPriceUnit` - `MeasurementUnit`	Price Unit as a Configurable Unit of Measure.
`metadata` - `[Metadatum!]!`	Metadata key/values.
`optionValues` - `GoldenProductOptionValueConnection!`	This field returns option type values set to the golden product.
Arguments `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.
`originCountryCode` - `String`	Origin country code of the golden product
`price` - `String`
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the golden product.
`saleType` - `GoldenProductSaleTypeEnum`	The sale type for the golden product.
`shippingParcel` - `ShippingParcel`	The direct shipping parcel information for the golden product.
`specifications` - `String`
`taxCode` - `String`
`taxon` - `Taxon`	The Taxon (or Category) that a golden product belongs to - eg. Bikes, Shoes, Wigs.
`title` - `String!`	Title for the golden product record.
`updatedAt` - `ISO8601DateTime!`	When the golden product record was last updated.
`year` - `Int`	When relevant, the model year of the product.
`youtubeVideoId` - `String`
`youtubeVideoUrl` - `String`

Example

{
  "active": false,
  "adverts": AdvertConnection,
  "brand": Brand,
  "createdAt": ISO8601DateTime,
  "customIframeThumbnail": Image,
  "customIframeUrl": "xyz789",
  "description": "abc123",
  "documents": GoldenProductDocumentsConnection,
  "externalIds": [ExternalID],
  "goldenProductVariants": GoldenProductVariantsConnection,
  "id": "4",
  "images": ImagesConnection,
  "legacyId": 987,
  "measurementPriceUnit": MeasurementUnit,
  "metadata": [Metadatum],
  "optionValues": GoldenProductOptionValueConnection,
  "originCountryCode": "abc123",
  "price": "abc123",
  "recommendedRetailPrice": "abc123",
  "saleType": "BUY_ONLINE",
  "shippingParcel": ShippingParcel,
  "specifications": "xyz789",
  "taxCode": "xyz789",
  "taxon": Taxon,
  "title": "abc123",
  "updatedAt": ISO8601DateTime,
  "year": 987,
  "youtubeVideoId": "xyz789",
  "youtubeVideoUrl": "abc123"
}

Types

GoldenProductActiveStatusEnum

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`

Example

"ACTIVE"

Types

GoldenProductCreateMutationInput

Description

Autogenerated input type of GoldenProductCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `GoldenProductInput!`

Example

{
  "clientMutationId": "abc123",
  "attributes": GoldenProductInput
}

Types

GoldenProductCreateMutationPayload

Description

Autogenerated return type of GoldenProductCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProduct` - `GoldenProduct`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "goldenProduct": GoldenProduct,
  "status": 987
}

Types

GoldenProductDeleteMutationInput

Description

Autogenerated input type of GoldenProductDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the golden product

Example

{
  "clientMutationId": "abc123",
  "id": "4"
}

Types

GoldenProductDeleteMutationPayload

Description

Autogenerated return type of GoldenProductDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProduct` - `GoldenProduct`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProduct": GoldenProduct,
  "status": 123
}

Types

GoldenProductDocument

Description

PDF documents relating to the golden product.

Fields

Field Name	Description
`filename` - `String`	The name of the PDF.
`id` - `ID!`
`size` - `Int`	The file size of the attached document in bytes.
`url` - `String`	The Golden Products attached PDF documents.

Example

{
  "filename": "abc123",
  "id": "4",
  "size": 123,
  "url": "abc123"
}

Types

GoldenProductDocumentInput

Description

Golden product document upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.

Fields

Input Field	Description
`dataBase64` - `String`	The document data, base64 encoded.
`filename` - `String`	The filename that will be used to label this document.
`sourceUrl` - `String`	A URL from which the document data can be fetched.
`documentId` - `ID`	The ID from an existing document
`size` - `Int`	The file size of the document in bytes.

Example

{
  "dataBase64": "abc123",
  "filename": "abc123",
  "sourceUrl": "xyz789",
  "documentId": 4,
  "size": 987
}

Types

GoldenProductDocumentsConnection

Description

The connection type for GoldenProductDocument.

Fields

Field Name	Description
`edges` - `[GoldenProductDocumentsEdge]`	A list of edges.
`nodes` - `[GoldenProductDocument]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GoldenProductDocumentsEdge],
  "nodes": [GoldenProductDocument],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

GoldenProductDocumentsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GoldenProductDocument`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": GoldenProductDocument
}

Types

GoldenProductInput

Fields

Input Field	Description
`title` - `String!`	Title for the golden product.
`description` - `String`	Description for the golden product.
`specifications` - `String`	Specifications for the golden product.
`taxCode` - `String`	Tax code applicable for the golden product.
`saleType` - `GoldenProductSaleTypeEnum`	The sale type for the golden product.
`brandId` - `ID`	Brand for the golden product.
`taxonId` - `ID!`	Taxon for the golden product.
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`optionValues` - `[GoldenProductOptionValueInput!]`	Option values for the golden product.
`measurementPriceUnitId` - `ID`	The configurable measurement unit.
`shippingParcel` - `ShippingParcelInput`	The direct shipping parcel information for the golden product.
`documents` - `[GoldenProductDocumentInput!]`	PDF documents relating to the golden product
`youtubeVideoUrl` - `String`	Youtube video url relating to the golden product
`customIframeUrl` - `String`	Custom video url relating to the golden product
`year` - `Int`	When relevant, the model year of the product.
`originCountryCode` - `String`	Origin country code of the golden product
`customIframeThumbnail` - `ImageInput`	Image thumbnail for the custom video supplied via 'custom_iframe_url'
`images` - `[ImageInput!]`
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the golden product.
`price` - `String`

Example

{
  "title": "xyz789",
  "description": "xyz789",
  "specifications": "xyz789",
  "taxCode": "xyz789",
  "saleType": "BUY_ONLINE",
  "brandId": 4,
  "taxonId": "4",
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "optionValues": [GoldenProductOptionValueInput],
  "measurementPriceUnitId": 4,
  "shippingParcel": ShippingParcelInput,
  "documents": [GoldenProductDocumentInput],
  "youtubeVideoUrl": "xyz789",
  "customIframeUrl": "xyz789",
  "year": 123,
  "originCountryCode": "abc123",
  "customIframeThumbnail": ImageInput,
  "images": [ImageInput],
  "recommendedRetailPrice": "xyz789",
  "price": "xyz789"
}

Types

GoldenProductOptionValue

Description

Golden Product option value for a golden product's option type supporting all field types.

Fields

Field Name	Description
`id` - `ID!`	ID for the value. This value is less likely to change when the field values are unchanged but cannot guaranty.
`optionType` - `OptionType!`	Option Type the value belongs to.
`optionValue` - `OptionValue`	Option value for single-select or multi-select Option Type.
`textValue` - `String`	Value for free-text Option Type.

Example

{
  "id": 4,
  "optionType": OptionType,
  "optionValue": OptionValue,
  "textValue": "xyz789"
}

Types

GoldenProductOptionValueConnection

Description

The connection type for GoldenProductOptionValue.

Fields

Field Name	Description
`edges` - `[GoldenProductOptionValueEdge]`	A list of edges.
`nodes` - `[GoldenProductOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GoldenProductOptionValueEdge],
  "nodes": [GoldenProductOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

GoldenProductOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GoldenProductOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": GoldenProductOptionValue
}

Types

GoldenProductOptionValueInput

Description

Input for updating a golden product option value. Set only optionValueId for single-select and multi-select option types, and set only optionTypeId and textValue for a free-text option type.

Fields

Input Field	Description
`optionValueId` - `ID`	Option Value ID used for single-select and multi-select option types
`textValue` - `String`	Free-text value used for a free-text option type
`optionTypeId` - `ID`	Option Type ID required for a free-text option type

Example

{
  "optionValueId": "4",
  "textValue": "abc123",
  "optionTypeId": "4"
}

Types

GoldenProductSaleTypeEnum

Description

The type of transaction permitted for a given golden product.

Values

Enum Value	Description
`BUY_ONLINE`	Can be purchased via the website or other means.
`BUY_ONLINE_ONLY`	Can be purchased exclusively via the website.
`BUY_ONLINE_OR_CLICK_AND_COLLECT`	Can be purchased via the website and can be delivered or picked up in store.
`CLICK_AND_COLLECT`	Can be purchased via the website then picked up in store.
`CLASSIFIED`	Being sold by a private seller (i.e. not a store).

Example

"BUY_ONLINE"

Types

GoldenProductUpdateInput

Fields

Input Field	Description
`title` - `String`	Title for the golden product.
`description` - `String`	Description for the golden product.
`specifications` - `String`	Specifications for the golden product.
`taxCode` - `String`	Tax code applicable for the golden product.
`saleType` - `GoldenProductSaleTypeEnum`	The sale type for the golden product.
`brandId` - `ID`	Brand for the golden product.
`taxonId` - `ID`	Taxon for the golden product.
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`optionValues` - `[GoldenProductOptionValueInput!]`	Option values for the golden product.
`measurementPriceUnitId` - `ID`	The configurable measurement unit.
`shippingParcel` - `ShippingParcelInput`	The direct shipping parcel information for the golden product.
`documents` - `[GoldenProductDocumentInput!]`	PDF documents relating to the golden product
`youtubeVideoUrl` - `String`	Youtube video url relating to the golden product
`customIframeUrl` - `String`	Custom video url relating to the golden product
`year` - `Int`	When relevant, the model year of the product.
`originCountryCode` - `String`	Origin country code of the golden product
`customIframeThumbnail` - `ImageInput`	Image thumbnail for the custom video supplied via 'custom_iframe_url'
`images` - `[ImageInput!]`
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the golden product.
`price` - `String`

Example

{
  "title": "xyz789",
  "description": "abc123",
  "specifications": "abc123",
  "taxCode": "abc123",
  "saleType": "BUY_ONLINE",
  "brandId": "4",
  "taxonId": "4",
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "optionValues": [GoldenProductOptionValueInput],
  "measurementPriceUnitId": 4,
  "shippingParcel": ShippingParcelInput,
  "documents": [GoldenProductDocumentInput],
  "youtubeVideoUrl": "abc123",
  "customIframeUrl": "abc123",
  "year": 987,
  "originCountryCode": "abc123",
  "customIframeThumbnail": ImageInput,
  "images": [ImageInput],
  "recommendedRetailPrice": "abc123",
  "price": "abc123"
}

Types

GoldenProductUpdateMutationInput

Description

Autogenerated input type of GoldenProductUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductId` - `ID!`	ID of the golden product to be updated
`attributes` - `GoldenProductUpdateInput!`

Example

{
  "clientMutationId": "abc123",
  "goldenProductId": 4,
  "attributes": GoldenProductUpdateInput
}

Types

GoldenProductUpdateMutationPayload

Description

Autogenerated return type of GoldenProductUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProduct` - `GoldenProduct`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "goldenProduct": GoldenProduct,
  "status": 123
}

Types

GoldenProductVariant

Description

A variant under the golden product record.

Fields

Field Name	Description
`active` - `Boolean!`	Shows if the golden product variant is active
`barcodes` - `[String!]`
`comparableSize` - `Float`	The comparable size of the item. Used for comparable unit pricing.
`createdAt` - `ISO8601DateTime!`	When the golden product variant was created.
`description` - `String`	Description for the golden product variant.
`externalIds` - `[ExternalID!]!`
`goldenProduct` - `GoldenProduct!`	The golden product this variant belongs to
`id` - `ID!`
`images` - `ImagesConnection!`
Arguments `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.
`itemSize` - `Float`	The size of the item. Used for comparable unit pricing.
`legacyId` - `Int!`
`measurementComparableUnit` - `MeasurementUnit`	Comparable Unit as a Configurable Unit of Measure
`measurementItemUnit` - `MeasurementUnit`	Item Unit as a Configurable Unit of Measure
`metadata` - `[Metadatum!]!`	Metadata key/values
`notes` - `String`
`optionValues` - `GoldenProductVariantOptionValueConnection!`	This field returns option type values set to the golden product variant.
Arguments `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.
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the item.
`shippingParcel` - `ShippingParcel`	The direct shipping parcel information for the golden product variant.
`shippingProfile` - `ShippingProfile`
`sku` - `String`
`taxCode` - `String`
`updatedAt` - `ISO8601DateTime!`	When the golden product variant was last updated.
`variants` - `VariantConnection!`	Variants associated to the golden product variant
Arguments `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. `displayableOnly` - `Boolean` Whether to only fetch variants that are displayable (e.g. are valid, have inventory available)

Example

{
  "active": true,
  "barcodes": ["xyz789"],
  "comparableSize": 123.45,
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "externalIds": [ExternalID],
  "goldenProduct": GoldenProduct,
  "id": "4",
  "images": ImagesConnection,
  "itemSize": 987.65,
  "legacyId": 987,
  "measurementComparableUnit": MeasurementUnit,
  "measurementItemUnit": MeasurementUnit,
  "metadata": [Metadatum],
  "notes": "abc123",
  "optionValues": GoldenProductVariantOptionValueConnection,
  "recommendedRetailPrice": "abc123",
  "shippingParcel": ShippingParcel,
  "shippingProfile": ShippingProfile,
  "sku": "abc123",
  "taxCode": "xyz789",
  "updatedAt": ISO8601DateTime,
  "variants": VariantConnection
}

Types

GoldenProductVariantCreateMutationInput

Description

Autogenerated input type of GoldenProductVariantCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `GoldenProductVariantInput!`

Example

{
  "clientMutationId": "xyz789",
  "attributes": GoldenProductVariantInput
}

Types

GoldenProductVariantCreateMutationPayload

Description

Autogenerated return type of GoldenProductVariantCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariant` - `GoldenProductVariant`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariant": GoldenProductVariant,
  "status": 987
}

Types

GoldenProductVariantDeleteMutationInput

Description

Autogenerated input type of GoldenProductVariantDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the golden product variant to delete

Example

{
  "clientMutationId": "abc123",
  "id": "4"
}

Types

GoldenProductVariantDeleteMutationPayload

Description

Autogenerated return type of GoldenProductVariantDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariant` - `GoldenProductVariant`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariant": GoldenProductVariant,
  "status": 123
}

Types

GoldenProductVariantInput

Fields

Input Field	Description
`goldenProductId` - `ID!`	The golden product this variant belongs to.
`notes` - `String`	Notes for the golden product variant.
`description` - `String`	Description for the golden product variant.
`barcodes` - `[String!]`	Barcodes associated to the golden product variant.
`sku` - `String`	SKU for the golden product variant.
`itemSize` - `Float`	The size of the item. Used for comparable unit pricing.
`active` - `Boolean`	Shows if the golden product variant is active
`measurementItemUnitId` - `ID`	The configurable measurement unit.
`comparableSize` - `Float`	The comparable size of the item. Used for comparable unit pricing.
`measurementComparableUnitId` - `ID`	The configurable measurement unit.
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the item.
`taxCode` - `String`	Tax code applicable for the golden product variant.
`images` - `[ImageInput!]`
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`shippingParcel` - `ShippingParcelInput`
`shippingProfileId` - `ID`
`optionValues` - `[GoldenProductVariantOptionValueInput!]`	Option values of the golden product variant. If this argument is given, product option values will be updated to match the input and delete the missing ones.

Example

{
  "goldenProductId": "4",
  "notes": "xyz789",
  "description": "xyz789",
  "barcodes": ["xyz789"],
  "sku": "xyz789",
  "itemSize": 987.65,
  "active": true,
  "measurementItemUnitId": 4,
  "comparableSize": 987.65,
  "measurementComparableUnitId": 4,
  "recommendedRetailPrice": "abc123",
  "taxCode": "xyz789",
  "images": [ImageInput],
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "shippingParcel": ShippingParcelInput,
  "shippingProfileId": 4,
  "optionValues": [GoldenProductVariantOptionValueInput]
}

Types

GoldenProductVariantLinkVariantsMutationInput

Description

Autogenerated input type of GoldenProductVariantLinkVariantsMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductVariantId` - `ID!`
`variantIds` - `[ID!]`
`variantLegacyIds` - `[Int!]`

Example

{
  "clientMutationId": "xyz789",
  "goldenProductVariantId": "4",
  "variantIds": [4],
  "variantLegacyIds": [123]
}

Types

GoldenProductVariantLinkVariantsMutationPayload

Description

Autogenerated return type of GoldenProductVariantLinkVariantsMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariant` - `GoldenProductVariant`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariant": GoldenProductVariant,
  "status": 123
}

Types

GoldenProductVariantOptionValue

Description

Golden Product Variant option value for a golden product variant's option type supporting all field types.

Fields

Field Name	Description
`id` - `ID!`	ID for the value. This value is less likely to change when the field values are unchanged but cannot guaranty.
`optionType` - `OptionType!`	Option Type the value belongs to.
`optionValue` - `OptionValue`	Option value for single-select or multi-select Option Type.
`textValue` - `String`	Value for free-text Option Type.

Example

{
  "id": "4",
  "optionType": OptionType,
  "optionValue": OptionValue,
  "textValue": "abc123"
}

Types

GoldenProductVariantOptionValueConnection

Description

The connection type for GoldenProductVariantOptionValue.

Fields

Field Name	Description
`edges` - `[GoldenProductVariantOptionValueEdge]`	A list of edges.
`nodes` - `[GoldenProductVariantOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GoldenProductVariantOptionValueEdge],
  "nodes": [GoldenProductVariantOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

GoldenProductVariantOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GoldenProductVariantOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": GoldenProductVariantOptionValue
}

Types

GoldenProductVariantOptionValueInput

Description

Input for updating a golden product variant option value. Set only optionValueId for single-select and multi-select option types, and set only optionTypeId and textValue for a free-text option type.

Fields

Input Field	Description
`optionValueId` - `ID`	Option Value ID used for single-select and multi-select option types
`textValue` - `String`	Free-text value used for a free-text option type
`optionTypeId` - `ID`	Option Type ID required for a free-text option type

Example

{
  "optionValueId": 4,
  "textValue": "xyz789",
  "optionTypeId": "4"
}

Types

GoldenProductVariantUnlinkVariantsMutationInput

Description

Autogenerated input type of GoldenProductVariantUnlinkVariantsMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductVariantId` - `ID!`
`variantIds` - `[ID!]!`

Example

{
  "clientMutationId": "abc123",
  "goldenProductVariantId": 4,
  "variantIds": [4]
}

Types

GoldenProductVariantUnlinkVariantsMutationPayload

Description

Autogenerated return type of GoldenProductVariantUnlinkVariantsMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariant` - `GoldenProductVariant`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariant": GoldenProductVariant,
  "status": 987
}

Types

GoldenProductVariantUpdateInput

Fields

Input Field	Description
`goldenProductId` - `ID`	The golden product this variant belongs to.
`notes` - `String`	Notes for the golden product variant.
`description` - `String`	Description for the golden product variant.
`barcodes` - `[String!]`	Barcodes associated to the golden product variant.
`sku` - `String`	SKU for the golden product variant.
`itemSize` - `Float`	The size of the item. Used for comparable unit pricing.
`active` - `Boolean`	Shows if the golden product variant is active
`measurementItemUnitId` - `ID`	The configurable measurement unit.
`comparableSize` - `Float`	The comparable size of the item. Used for comparable unit pricing.
`measurementComparableUnitId` - `ID`	The configurable measurement unit.
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the item.
`taxCode` - `String`	Tax code applicable for the golden product variant.
`images` - `[ImageInput!]`
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`shippingParcel` - `ShippingParcelInput`
`shippingProfileId` - `ID`
`optionValues` - `[GoldenProductVariantOptionValueInput!]`	Option values of the golden product variant. If this argument is given, product option values will be updated to match the input and delete the missing ones.

Example

{
  "goldenProductId": 4,
  "notes": "xyz789",
  "description": "abc123",
  "barcodes": ["xyz789"],
  "sku": "xyz789",
  "itemSize": 987.65,
  "active": false,
  "measurementItemUnitId": "4",
  "comparableSize": 987.65,
  "measurementComparableUnitId": 4,
  "recommendedRetailPrice": "xyz789",
  "taxCode": "abc123",
  "images": [ImageInput],
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "shippingParcel": ShippingParcelInput,
  "shippingProfileId": "4",
  "optionValues": [GoldenProductVariantOptionValueInput]
}

Types

GoldenProductVariantUpdateMutationInput

Description

Autogenerated input type of GoldenProductVariantUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductVariantId` - `ID!`	ID of the golden product variant to be updated
`attributes` - `GoldenProductVariantUpdateInput!`

Example

{
  "clientMutationId": "abc123",
  "goldenProductVariantId": 4,
  "attributes": GoldenProductVariantUpdateInput
}

Types

GoldenProductVariantUpdateMutationPayload

Description

Autogenerated return type of GoldenProductVariantUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariant` - `GoldenProductVariant`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariant": GoldenProductVariant,
  "status": 123
}

Types

GoldenProductVariantsActivateMutationInput

Description

Autogenerated input type of GoldenProductVariantsActivateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductVariantIds` - `[ID!]!`	IDs of the golden product variant to be activated

Example

{
  "clientMutationId": "xyz789",
  "goldenProductVariantIds": ["4"]
}

Types

GoldenProductVariantsActivateMutationPayload

Description

Autogenerated return type of GoldenProductVariantsActivateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariants` - `[GoldenProductVariant!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariants": [GoldenProductVariant],
  "status": 123
}

Types

GoldenProductVariantsConnection

Description

The connection type for GoldenProductVariant.

Fields

Field Name	Description
`edges` - `[GoldenProductVariantsEdge]`	A list of edges.
`nodes` - `[GoldenProductVariant]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GoldenProductVariantsEdge],
  "nodes": [GoldenProductVariant],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

GoldenProductVariantsDeactivateMutationInput

Description

Autogenerated input type of GoldenProductVariantsDeactivateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`goldenProductVariantIds` - `[ID!]!`

Example

{
  "clientMutationId": "abc123",
  "goldenProductVariantIds": ["4"]
}

Types

GoldenProductVariantsDeactivateMutationPayload

Description

Autogenerated return type of GoldenProductVariantsDeactivateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`goldenProductVariants` - `[GoldenProductVariant!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "goldenProductVariants": [GoldenProductVariant],
  "status": 987
}

Types

GoldenProductVariantsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GoldenProductVariant`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": GoldenProductVariant
}

Types

GoldenProductsConnection

Description

The connection type for GoldenProduct.

Fields

Field Name	Description
`edges` - `[GoldenProductsEdge]`	A list of edges.
`nodes` - `[GoldenProduct]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [GoldenProductsEdge],
  "nodes": [GoldenProduct],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

GoldenProductsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `GoldenProduct`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": GoldenProduct
}

Types

GoogleAnalyticsTracker

Description

Properties of a single Google/Universal Analytics tracker

Fields

Field Name	Description
`id` - `String!`	Tracker ID to send to Google Analytics.
`name` - `String!`	A name to identify the tracker.

Example

{
  "id": "xyz789",
  "name": "xyz789"
}

Types

GoogleMapsCredentials

Description

Google maps credentials

Fields

Field Name	Description
`apiKey` - `String`	Google Maps API key
`host` - `String`	Google Maps host

Example

{
  "apiKey": "xyz789",
  "host": "xyz789"
}

Types

GoogleRecaptchaCredentials

Description

Google reCAPTCHA credentials

Fields

Field Name	Description
`siteKey` - `String`	Google reCAPTCHA site key

Example

{"siteKey": "abc123"}

Types

Header

Description

Data for composing a site header

Fields

Field Name	Description
`categoryMenuEntries` - `[CategoryMenuEntry!]!`
`navBar` - `NavBar!`
`searchFields` - `[SearchField!]!`

Example

{
  "categoryMenuEntries": [DirectLink],
  "navBar": NavBar,
  "searchFields": [FreeTextAndSelectField]
}

Types

HealthCheck

Description

Data for all health related checks

Fields

Field Name	Description
`all` - `[StatusInfo!]!`	Full list of all health checks
`database` - `StatusInfo!`	Health check info for database
`default` - `StatusInfo!`	Health check info for default
`elasticsearch` - `StatusInfo!`	Health check info for elasticsearch
`memcached` - `StatusInfo!`	Health check info for memcached
`puma` - `StatusInfo!`	Health check info for puma
`redis` - `StatusInfo!`	Health check info for redis
`ruby` - `StatusInfo!`	Health check info for ruby
`sidekiq` - `StatusInfo!`	Health check info for sidekiq
`success` - `Boolean!`	Overall health check success
`version` - `StatusInfo!`	Health check info for version

Example

{
  "all": [StatusInfo],
  "database": StatusInfo,
  "default": StatusInfo,
  "elasticsearch": StatusInfo,
  "memcached": StatusInfo,
  "puma": StatusInfo,
  "redis": StatusInfo,
  "ruby": StatusInfo,
  "sidekiq": StatusInfo,
  "success": false,
  "version": StatusInfo
}

Types

ID

Description

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

Example

Types

ISO8601Date

Description

An ISO 8601-encoded date

Example

ISO8601Date

Types

ISO8601DateTime

Description

An ISO 8601-encoded datetime

Example

ISO8601DateTime

Types

Image

Description

Image attachment for adverts and some other models

Fields

Field Name	Description
`aiDetectedLabels` - `[String!]`	AI detected labels. Will be null unless experimental AI features are enabled. Experimental, will change
`aiModerationLabels` - `[String!]`	AI moderation labels. Will be null unless experimental AI features are enabled. Experimental, will change
`alt` - `String`	Image alt text
`filename` - `String`
`height` - `Int`
`id` - `ID!`
`metadata` - `String`	Image metadata
`position` - `Int!`	NOTE: This will be deprecated, assume images are always ordered and set position values on integrations accordingly.
`size` - `Int`	The file size of the image in bytes.
`url` - `String!`	The src URL for the image.
Arguments `width` - `Int` Desired width (in pixels) of image. `height` - `Int` Desired height (in pixels) of image. `fit` - `ImageFitEnum` Resize Fit Mode: default is max `fillColor` - `String` Sets a background color (hex, eg: ff0000) for fit=fill/fillmax. NOTE: we would suggest using fit=clip and css style of "object-fit: contain" instead. `originalFormat` - `Boolean` Return image original format as it was uploaded.
`width` - `Int`

Example

{
  "aiDetectedLabels": ["abc123"],
  "aiModerationLabels": ["xyz789"],
  "alt": "xyz789",
  "filename": "abc123",
  "height": 987,
  "id": "4",
  "metadata": "abc123",
  "position": 123,
  "size": 123,
  "url": "xyz789",
  "width": 987
}

Types

ImageFitEnum

Description

The resize fit mode - See: https://docs.imgix.com/apis/url/size/fit

Values

Enum Value	Description
`clamp`	Resizes the image to fit within the width and height dimensions without cropping or distorting the image, and the remaining space is filled with extended pixels from the edge of the image. The resulting image will match the constraining dimensions. The pixel extension is called an affine clamp, hence the value name, "clamp". Deprecated from January 2021
`clip`	Resizes the image to fit within the width and height boundaries without cropping or distorting the image. The resulting image will match one of the constraining dimensions, while the other dimension is altered to maintain the same aspect ratio of the input image.
`crop`	Resizes the image to fill the width and height dimensions and crops any excess image data. The resulting image will match the width and height constraints without distorting the image. It's used in conjunction with the the crop parameter, which controls how the image is cropped. Both the w and h parameters will also need to be set.
`facearea`	Finds the area containing all faces, or a specific face in an image, and scales it to specified width and height dimensions. Can be used in conjunction with faceindex to identify a specific face, as well as facepad to include additional padded area around the face to zoom out from the immediate area around the faces. Deprecated from January 2021
`fill`	Resizes the image to fit within the requested width and height dimensions while preserving the original aspect ratio and without discarding any original image data. Excess space is filled with a solid color or blurred version of the image. The resulting image exactly matches the requested dimensions.
`fillmax`	Resizes the image to fit within the requested width and height dimensions while preserving the original aspect ratio and without discarding any original image data. If the requested width or height exceeds that of the original, the original image remains the same size. The excess space is filled with a solid color or blurred version of the image. The resulting image exactly matches the requested dimensions.
`max`	Resizes the image to fit within the width and height dimensions without cropping or distorting the image, but will not increase the size of the image if it is smaller than the output size. The resulting image will maintain the same aspect ratio of the input image.
`min`	Resizes and crops the image to match the aspect ratio of the requested width and height. Will not exceed the original width and height of the image.
`scale`	Scales the image to fit the constraining dimensions exactly. The resulting image will fill the dimensions, and will not maintain the aspect ratio of the input image.

Example

"clamp"

Types

ImageGallery

Description

Image gallery data for the shop page

Fields

Field Name	Description
`id` - `ID!`
`images` - `[Image!]!`	Image data stored on seller
`video` - `Video`	Video data stored on seller

Example

{
  "id": 4,
  "images": [Image],
  "video": Video
}

Types

ImageGalleryLayoutEnum

Description

The display style for images in the gallery

Values

Enum Value	Description
`padded`	Padded adds space between the border and the image, and shows the full image scaled and centred.
`full_bleed`	Full bleed doesn't add space between the border and the image, and crops the image to cover the whole image area.

Example

"padded"

Types

ImageGalleryOrientationEnum

Description

The orientation for images in the gallery

Values

Enum Value	Description
`horizontal`	Display orientation for the images is horizontal
`vertical`	Display orientation for the images is vertical

Example

"horizontal"

Types

ImageInput

Description

Image upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.

Fields

Input Field	Description
`dataBase64` - `String`	The image data, base64 encoded.
`filename` - `String`	The filename that will be used to label this image.
`sourceUrl` - `String`	A URL from which the image data can be fetched.
`imageId` - `ID`	The ID from an existing image type
`size` - `Int`	The file size of the image in bytes.
`alt` - `String`	Alt text description of the image.

Example

{
  "dataBase64": "abc123",
  "filename": "abc123",
  "sourceUrl": "xyz789",
  "imageId": "4",
  "size": 987,
  "alt": "xyz789"
}

Types

ImageUploadMutationInput

Description

Autogenerated input type of ImageUploadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`dataBase64` - `String!`	The image data, base64 encoded.

Example

{
  "clientMutationId": "abc123",
  "dataBase64": "abc123"
}

Types

ImageUploadMutationPayload

Description

Autogenerated return type of ImageUploadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sourceUrl` - `String`	The sourceUrl to send in ImageInput
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "sourceUrl": "abc123",
  "status": 123
}

Types

ImagesConnection

Description

The connection type for Image.

Fields

Field Name	Description
`edges` - `[ImagesEdge]`	A list of edges.
`nodes` - `[Image]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ImagesEdge],
  "nodes": [Image],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ImagesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Image`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Image
}

Types

ImportExport

Fields

Field Name	Description
`className` - `String!`
`createdAt` - `ISO8601DateTime!`
`errorsCsvLink` - `String`	Requires SP1.0 login, please use "errorsToCsv" and "hasErrorsToCsv" instead
`errorsToCsv` - `String`
`errorsToXlsx` - `String`
`expectedResultCount` - `Int`
`failedCount` - `Int`
`file` - `Attachment`
`hasErrorsToCsv` - `Boolean!`
`humanClassName` - `String!`
`id` - `ID!`
`legacyId` - `Int!`
`processedCount` - `Int`
`seller` - `Seller!`
`status` - `ImportExportStatusEnum`
`updatedAt` - `ISO8601DateTime!`

Example

{
  "className": "abc123",
  "createdAt": ISO8601DateTime,
  "errorsCsvLink": "abc123",
  "errorsToCsv": "xyz789",
  "errorsToXlsx": "abc123",
  "expectedResultCount": 123,
  "failedCount": 987,
  "file": Attachment,
  "hasErrorsToCsv": true,
  "humanClassName": "xyz789",
  "id": 4,
  "legacyId": 123,
  "processedCount": 987,
  "seller": Seller,
  "status": "PENDING",
  "updatedAt": ISO8601DateTime
}

Types

ImportExportCommissionPackageSchedule

Fields

Field Name	Description
`className` - `String!`
`createdAt` - `ISO8601DateTime!`
`expectedResultCount` - `Int`
`failedCount` - `Int`
`file` - `Attachment`
`humanClassName` - `String!`
`id` - `ID!`
`legacyId` - `Int!`
`processedCount` - `Int`
`status` - `ImportExportStatusEnum`
`updatedAt` - `ISO8601DateTime!`

Example

{
  "className": "abc123",
  "createdAt": ISO8601DateTime,
  "expectedResultCount": 123,
  "failedCount": 123,
  "file": Attachment,
  "humanClassName": "abc123",
  "id": "4",
  "legacyId": 987,
  "processedCount": 987,
  "status": "PENDING",
  "updatedAt": ISO8601DateTime
}

Types

ImportExportConnection

Description

The connection type for ImportExport.

Fields

Field Name	Description
`edges` - `[ImportExportEdge]`	A list of edges.
`nodes` - `[ImportExport]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ImportExportEdge],
  "nodes": [ImportExport],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ImportExportEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ImportExport`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ImportExport
}

Types

ImportExportStatusEnum

Description

Import Export status

Values

Enum Value	Description
`PENDING`
`PREVIEW`
`LOADING`
`PROCESSING`
`FINISHED`
`ERROR`
`ABORTED`

Example

"PENDING"

Types

ImportExportTypeEnum

Description

Import Export type

Values

Enum Value	Description
`ADVERT_EXPORT`
`ADVERT_IMPORT`
`EMAILS_IMPORT`
`PRODUCT_DB_EXPORT`
`STOCKLEVEL_IMPORT`
`SHIPMENTS_IMPORT`

Example

"ADVERT_EXPORT"

Types

Inquiry

Fields

Field Name	Description
`advert` - `Advert`	The Advert to which the inquiry relates
`customerFullName` - `String!`	The Full name of the person raising the inquiry
`email` - `String!`	The email address of the person raising the inquiry
`id` - `ID!`
`marketingOptIn` - `Boolean!`	Whether or not customer subscribed to the email marketing list
`message` - `String!`	The message, question or inquiry that has been raised by a customer
`phone` - `String`	The phone number of the person raising the inquiry
`postCode` - `String`	The post code of the person raising the inquiry
`seller` - `Seller!`	The Seller to which the inquiry relates

Example

{
  "advert": Advert,
  "customerFullName": "xyz789",
  "email": "abc123",
  "id": "4",
  "marketingOptIn": false,
  "message": "abc123",
  "phone": "abc123",
  "postCode": "xyz789",
  "seller": Seller
}

Types

InquiryCreateInput

Description

Inquiry Attributes.

Fields

Input Field	Description
`message` - `String!`	The message, question or inquiry that you would like to send to the Seller
`customerFullName` - `String!`	Full name of the person raising the inquiry
`email` - `String!`	The email address of the person raising the inquiry
`phone` - `String`	The phone number of the person raising the inquiry. Default = `""`
`postCode` - `String`	The post code of the person raising the inquiry. Default = `""`
`marketingOptIn` - `Boolean`	Whether we add this email address to the email marketing list. Default = `false`
`advertId` - `ID`	The Id of the Advert to which the inquiry relates
`sellerId` - `ID!`	The Id of the Seller to which the inquiry relates

Example

{
  "message": "abc123",
  "customerFullName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "postCode": "abc123",
  "marketingOptIn": false,
  "advertId": "4",
  "sellerId": "4"
}

Types

InquiryCreateMutationInput

Description

Autogenerated input type of InquiryCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `InquiryCreateInput!`

Example

{
  "clientMutationId": "xyz789",
  "attributes": InquiryCreateInput
}

Types

InquiryCreateMutationPayload

Description

Autogenerated return type of InquiryCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`inquiry` - `Inquiry`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "inquiry": Inquiry,
  "status": 123
}

Types

Int

Description

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

Inventory

Description

Record to handle multi-store inventory.

Fields

Field Name	Description
`countOnHand` - `Int!`	It is used to identify the quantity available.
`id` - `ID!`
`infiniteQuantity` - `Boolean!`	Used to identify if infinite inventory is enabled
`price` - `Money`
`salePrice` - `Money`
`seller` - `Seller!`	Seller associated in the multi-store membership.

Example

{
  "countOnHand": 987,
  "id": "4",
  "infiniteQuantity": false,
  "price": Money,
  "salePrice": Money,
  "seller": Seller
}

Types

InventorysConnection

Description

The connection type for Inventory.

Fields

Field Name	Description
`edges` - `[InventorysEdge]`	A list of edges.
`nodes` - `[Inventory]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [InventorysEdge],
  "nodes": [Inventory],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

InventorysEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Inventory`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Inventory
}

Types

Invoice

Description

Invoice items associated with an order.

Fields

Field Name	Description
`adjustments` - `[Adjustment!]!`
`amendments` - `[InvoiceAmendment!]!`
`annotations` - `[InvoiceAnnotation!]!`
`buyerBillingAddress` - `Address`
`buyerEmailAddress` - `String`
`buyerFirstName` - `String`
`buyerMessageToSeller` - `String`
`buyerPhone` - `String`
`buyerSurname` - `String`
`commissionAmountCents` - `Int`	Commission amount Denominated in cents. Only accessible to users: admin_authorized, seller_authorized. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountFormatted` - `String`	Commission amount In string with currency symbol. Only accessible to users: admin_authorized, seller_authorized.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountTaxCents` - `Int`	Total commission tax amount for the invoice Denominated in cents. Only accessible to users: admin_authorized, seller_authorized. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountTaxFormatted` - `String`	Total commission tax amount for the invoice In string with currency symbol. Only accessible to users: admin_authorized, seller_authorized.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionInvoiceId` - `String!`	The id used to identify the commission invoice.
`commissionPdfData` - `String`	Data for the commission invoice in PDF format (EXPENSIVE TO GENERATE) Only accessible to users: admin_authorized, seller_authorized.
`commissionPdfLink` - `String`	Link to retrieve the commission invoice in PDF format Only accessible to users: admin_authorized, seller_authorized.
`commissionTaxRate` - `Float`	Commission tax rate set in invoice
`createdAt` - `ISO8601DateTime!`	The date the invoice was created.
`deliveryType` - `DeliveryTypeEnum!`
`discountCents` - `Int!`	The discount applied to the invoice. Negative value. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	The discount applied to the invoice. Negative value. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`externalIds` - `[ExternalID!]!`
`externalTaxApplied` - `Boolean!`
`id` - `ID!`
`legacyId` - `Int!`	The id used to identify the invoice. Only accessible to users: admin_authorized, seller_authorized.
`lineItems` - `[LineItem!]!`
`merchantFeeCents` - `Int`	Merchant fee Denominated in cents. Only accessible to users: admin_authorized. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`merchantFeeFormatted` - `String`	Merchant fee In string with currency symbol. Only accessible to users: admin_authorized.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`merchantFeeTaxTotalCents` - `Int`	Total tax for service provided by marketplace operator to seller Denominated in cents. Only accessible to users: admin_authorized. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`merchantFeeTaxTotalFormatted` - `String`	Total tax for service provided by marketplace operator to seller In string with currency symbol. Only accessible to users: admin_authorized.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`merchantFeesTaxRate` - `Float`	Merchant fee tax rate set in invoice
`metadata` - `[Metadatum!]!`	Metadata key/values Only accessible to users: admin_authorized, seller_authorized.
`order` - `Order!`
`orderExternalIds` - `[ExternalID!]!`	Seller exposed external ids from order Only accessible to users: admin_authorized, seller_authorized.
`orderPurgedAt` - `ISO8601DateTime`
`packingSlipPdfData` - `String`	Data for the packing slip in PDF format (EXPENSIVE TO GENERATE) Only accessible to users: admin_authorized, seller_authorized.
`paidAt` - `ISO8601DateTime`	The date the invoice was paid.
`paymentInstrumentType` - `String`
`pdfData` - `String`	data for the invoice in PDF format (EXPENSIVE TO GENERATE) Use pdfData instead
`pdfLink` - `String`	Link to retrieve the invoice in PDF format
`postageTaxRate` - `Float`	Postage tax rate on invoice
`refundRequests` - `[RefundRequest!]!`
`remittancePdfData` - `String`	Data for the remittance invoice in PDF format (EXPENSIVE TO GENERATE) Only accessible to users: admin_authorized, seller_authorized.
`remittancePdfLink` - `String`	Link to retrieve the remittance invoice in PDF format Only accessible to users: admin_authorized, seller_authorized. Use remittancePdfData instead
`remittedAt` - `ISO8601DateTime`	The date the remittance is processed. (This is the date the remittance_advice is created when advanced remittance is enabled) Only accessible to users: admin_authorized, seller_authorized.
`seller` - `Seller!`
`shipments` - `[Shipment!]!`
`shippingAddress` - `Address`
`shippingCostCents` - `Int!`	The invoice postage cost. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingCostFormatted` - `String!`	The invoice postage cost. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`shippingDescription` - `String!`	General description of the delivery method and estimated time in transit for the shipment.
`shippingFromLocationMessage` - `String`	Message for user, informing them of the location from where their purchase will be shipped if applicable. Will return null if seller is multistore parent retailer.
Arguments `useCity` - `Boolean` Whether to include the name of the city that the item is shipping from in the message.
`status` - `InvoiceStatusEnum!`	As an invoice can contain multiple line items, each of which which can be partially sent, partially refunded, partially awaiting return and partially cancelled all at the same time, a single status field is no longer sufficient to describe the status of an invoice. Instead, use statusFlags or look at refundRequests and invoiceAmendments to get the full picture. This field will be removed 2021-12-01.
`statusFlags` - `[InvoiceStatusFlagEnum!]!`
`subtotalCents` - `Int!`	The invoice subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalFormatted` - `String!`	The invoice subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxRate` - `Float`	Tax rate on invoice
`taxShippingCents` - `Int!`	The postage tax on the invoice. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxShippingFormatted` - `String!`	The postage tax on the invoice. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxTotalCents` - `Int!`	The tax on the invoice. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	The tax on the invoice. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalCents` - `Int!`	Total cost of the invoice, which includes subtotals and cost of shipping if applicable. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	Total cost of the invoice, which includes subtotals and cost of shipping if applicable. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalIncludingAdjustmentsCents` - `Int!`	Total cost of the invoice, including adjustments. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalIncludingAdjustmentsFormatted` - `String!`	Total cost of the invoice, including adjustments. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`

Example

{
  "adjustments": [Adjustment],
  "amendments": [InvoiceAmendment],
  "annotations": [InvoiceAnnotation],
  "buyerBillingAddress": Address,
  "buyerEmailAddress": "xyz789",
  "buyerFirstName": "abc123",
  "buyerMessageToSeller": "xyz789",
  "buyerPhone": "abc123",
  "buyerSurname": "xyz789",
  "commissionAmountCents": 123,
  "commissionAmountFormatted": "xyz789",
  "commissionAmountTaxCents": 987,
  "commissionAmountTaxFormatted": "xyz789",
  "commissionInvoiceId": "abc123",
  "commissionPdfData": "xyz789",
  "commissionPdfLink": "xyz789",
  "commissionTaxRate": 987.65,
  "createdAt": ISO8601DateTime,
  "deliveryType": "BUY_ONLINE",
  "discountCents": 123,
  "discountFormatted": "abc123",
  "externalIds": [ExternalID],
  "externalTaxApplied": false,
  "id": "4",
  "legacyId": 987,
  "lineItems": [LineItem],
  "merchantFeeCents": 987,
  "merchantFeeFormatted": "abc123",
  "merchantFeeTaxTotalCents": 987,
  "merchantFeeTaxTotalFormatted": "xyz789",
  "merchantFeesTaxRate": 123.45,
  "metadata": [Metadatum],
  "order": Order,
  "orderExternalIds": [ExternalID],
  "orderPurgedAt": ISO8601DateTime,
  "packingSlipPdfData": "abc123",
  "paidAt": ISO8601DateTime,
  "paymentInstrumentType": "xyz789",
  "pdfData": "xyz789",
  "pdfLink": "abc123",
  "postageTaxRate": 123.45,
  "refundRequests": [RefundRequest],
  "remittancePdfData": "xyz789",
  "remittancePdfLink": "abc123",
  "remittedAt": ISO8601DateTime,
  "seller": Seller,
  "shipments": [Shipment],
  "shippingAddress": Address,
  "shippingCostCents": 987,
  "shippingCostFormatted": "xyz789",
  "shippingDescription": "abc123",
  "shippingFromLocationMessage": "abc123",
  "status": "AWAITING_PAYMENT",
  "statusFlags": ["PAID"],
  "subtotalCents": 123,
  "subtotalFormatted": "xyz789",
  "taxRate": 123.45,
  "taxShippingCents": 987,
  "taxShippingFormatted": "xyz789",
  "taxTotalCents": 987,
  "taxTotalFormatted": "abc123",
  "totalCents": 987,
  "totalFormatted": "abc123",
  "totalIncludingAdjustmentsCents": 987,
  "totalIncludingAdjustmentsFormatted": "xyz789",
  "updatedAt": ISO8601DateTime
}

Types

InvoiceAmendment

Description

Amendments to an invoice.

Fields

Field Name	Description
`commissionAmountTotalCents` - `Int`	The total value of the commission within this amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountTotalFormatted` - `String`	The total value of the commission within this amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionTaxTotalCents` - `Int`	The total value of the tax on the commissionAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionTaxTotalFormatted` - `String`	The total value of the tax on the commissionAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`createdAt` - `ISO8601DateTime!`
`externalTaxApplied` - `Boolean!`
`id` - `ID!`
`invoice` - `Invoice!`
`legacyId` - `Int!`	The id used to identify the invoice amendment.
`lineItemAmountTotalCents` - `Int`	The total value of the item/s within this amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemAmountTotalFormatted` - `String`	The total value of the item/s within this amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItemTaxTotalCents` - `Int`	The total value of the tax on the lineItemAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemTaxTotalFormatted` - `String`	The total value of the tax on the lineItemAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItems` - `[InvoiceAmendmentLineItem!]!`
`order` - `Order!`	The order that this invoice amendment is for.
`remittanceAmountTotalCents` - `Int`	The total value of the remittance within this amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceAmountTotalFormatted` - `String`	The total value of the remittance within this amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittanceCents` - `Int!`	The remittance adjustment value of the invoice amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceFormatted` - `String!`	The remittance adjustment value of the invoice amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittanceTaxTotalCents` - `Int`	The total value of the tax on the remittanceAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceTaxTotalFormatted` - `String`	The total value of the tax on the remittanceAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittedAt` - `ISO8601DateTime`	The date the remittance is processed. (This is the date the remittance_advice is created when advanced remittance is enabled)
`taxCents` - `Int!`	The tax adjustment value of the invoice amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxFormatted` - `String!`	The tax adjustment value of the invoice amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxRate` - `Float`	Tax rate on invoice
`totalCents` - `Int!`	Total adjustment value of the invoice amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	Total adjustment value of the invoice amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`

Example

{
  "commissionAmountTotalCents": 987,
  "commissionAmountTotalFormatted": "abc123",
  "commissionTaxTotalCents": 123,
  "commissionTaxTotalFormatted": "xyz789",
  "createdAt": ISO8601DateTime,
  "externalTaxApplied": false,
  "id": "4",
  "invoice": Invoice,
  "legacyId": 987,
  "lineItemAmountTotalCents": 987,
  "lineItemAmountTotalFormatted": "xyz789",
  "lineItemTaxTotalCents": 987,
  "lineItemTaxTotalFormatted": "xyz789",
  "lineItems": [InvoiceAmendmentLineItem],
  "order": Order,
  "remittanceAmountTotalCents": 987,
  "remittanceAmountTotalFormatted": "xyz789",
  "remittanceCents": 123,
  "remittanceFormatted": "xyz789",
  "remittanceTaxTotalCents": 123,
  "remittanceTaxTotalFormatted": "xyz789",
  "remittedAt": ISO8601DateTime,
  "taxCents": 987,
  "taxFormatted": "xyz789",
  "taxRate": 123.45,
  "totalCents": 123,
  "totalFormatted": "xyz789",
  "updatedAt": ISO8601DateTime
}

Types

InvoiceAmendmentCreateMutationInput

Description

Autogenerated input type of InvoiceAmendmentCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID!`	ID of the invoice to amend.
`remittanceCents` - `Int!`	Amount to adjust remittance. Negative values are a refund. Denominated in cents.
`lineItems` - `[InvoiceAmendmentLineItemInput!]!`	Invoice amendment line items to create.

Example

{
  "clientMutationId": "abc123",
  "invoiceId": "4",
  "remittanceCents": 123,
  "lineItems": [InvoiceAmendmentLineItemInput]
}

Types

InvoiceAmendmentCreateMutationPayload

Description

Autogenerated return type of InvoiceAmendmentCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAmendment` - `InvoiceAmendment`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "invoiceAmendment": InvoiceAmendment,
  "status": 987
}

Types

InvoiceAmendmentFilters

Description

Attributes for filtering invoices

Fields

Input Field	Description
`createdSince` - `ISO8601DateTime`	Invoice amendments created since this time. Default = `null`
`createdUntil` - `ISO8601DateTime`	Invoice amendments created until this time. Default = `null`
`updatedSince` - `ISO8601DateTime`	Invoice amendments updated since this time. Default = `null`
`updatedUntil` - `ISO8601DateTime`	Invoice amendments updated until this time. Default = `null`
`remittedSince` - `ISO8601DateTime`	Invoice amendments remitted since this time. Default = `null`
`remittedUntil` - `ISO8601DateTime`	Invoice amendments remitted until this time. Default = `null`

Example

{
  "createdSince": ISO8601DateTime,
  "createdUntil": ISO8601DateTime,
  "updatedSince": ISO8601DateTime,
  "updatedUntil": ISO8601DateTime,
  "remittedSince": ISO8601DateTime,
  "remittedUntil": ISO8601DateTime
}

Types

InvoiceAmendmentLineItem

Description

Line items associated with an invoice amendment.

Fields

Field Name	Description
`amountCents` - `Int!`	The amount (per item) that this line item is adding to the amendment. Denominated in cents.
`amountFormatted` - `String!`	The amount (per item) that this line item is adding to the amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountCents` - `Int`	The value of the commission of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountFormatted` - `String`	The value of the commission of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionTaxCents` - `Int`	The value of the tax on the commissionAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionTaxFormatted` - `String`	The value of the tax on the commissionAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`custom` - `String`	Amendment line item description where it is not amending an invoice line item.
`customLineItemTaxRate` - `Decimal`	Tax rate for the custom line item (for display purposes only). It defaults to the Marketplace default tax rate if not provided in the refund request approve mutation.
`dispatched` - `Boolean`	Does this refer to dispatched or not-yet-dispatched line items?
`id` - `ID!`
`lineItem` - `LineItem`	The invoice line item that is being amended.
`lineItemAmountCents` - `Int`	The value of the item/s of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemAmountFormatted` - `String`	The value of the item/s of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItemTaxCents` - `Int`	The value of the tax on the lineItemAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemTaxFormatted` - `String`	The value of the tax on the lineItemAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`quantity` - `Int!`
`remittanceAmountCents` - `Int`	The value of the remittance of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceAmountFormatted` - `String`	The value of the remittance of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittanceTaxCents` - `Int`	The value of the tax on the remittanceAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceTaxFormatted` - `String`	The value of the tax on the remittanceAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`status` - `InvoiceAmendmentLineItemStatusEnum!`	Status of the invoice amendment line item
`taxCents` - `Int`	Tax on the line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxFormatted` - `String`	Tax on the line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxRate` - `Float`	Line item tax rate
`totalCents` - `Int!`	The total that this line item is adding to the amendment. Denominated in cents.
`totalFormatted` - `String!`	The total that this line item is adding to the amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.

Example

{
  "amountCents": 987,
  "amountFormatted": "xyz789",
  "commissionAmountCents": 123,
  "commissionAmountFormatted": "abc123",
  "commissionTaxCents": 123,
  "commissionTaxFormatted": "abc123",
  "custom": "xyz789",
  "customLineItemTaxRate": Decimal,
  "dispatched": true,
  "id": "4",
  "lineItem": LineItem,
  "lineItemAmountCents": 987,
  "lineItemAmountFormatted": "abc123",
  "lineItemTaxCents": 123,
  "lineItemTaxFormatted": "xyz789",
  "quantity": 987,
  "remittanceAmountCents": 987,
  "remittanceAmountFormatted": "abc123",
  "remittanceTaxCents": 123,
  "remittanceTaxFormatted": "xyz789",
  "status": "REFUNDED",
  "taxCents": 123,
  "taxFormatted": "abc123",
  "taxRate": 987.65,
  "totalCents": 987,
  "totalFormatted": "xyz789"
}

Types

InvoiceAmendmentLineItemInput

Description

Line items associated with an invoice amendment.

Either lineItemId OR custom must be supplied, not both.

If lineItemId is supplied, you should also supply the dispatched flag: In January 2022 you will be required to supply the dispatched flag in this case.

Quantity should be positive.

Amount should be negative for a refund.

Fields

Input Field	Description
`lineItemId` - `ID`	ID of the invoice line item to which this amendment line item refers.
`custom` - `String`	Text of the amendment line item, if and only if lineItemId is not supplied.
`quantity` - `Int!`	Quantity of this item to be amended.
`dispatched` - `Boolean`	Does this refer to dispatched or not-yet-dispatched line items?
`lineItemPriceBreakdown` - `PriceBreakdownInput`	Can be used to provide price breakdown for all elements of the line item.
`total` - `MoneyInputField`	Total amount for each item. Negative for a refund.
`amountCents` - `Int`	Amount per unit for each item. Multiplied by quantity to get total for this line. Negative for a refund. Denominated in cents.
`status` - `InvoiceAmendmentLineItemStatusEnum!`	Status of the amendment line item.
`reason` - `String`	Reason for refunding the line item.

Example

{
  "lineItemId": 4,
  "custom": "xyz789",
  "quantity": 987,
  "dispatched": true,
  "lineItemPriceBreakdown": PriceBreakdownInput,
  "total": MoneyInputField,
  "amountCents": 987,
  "status": "REFUNDED",
  "reason": "xyz789"
}

Types

InvoiceAmendmentLineItemStatusEnum

Description

All possible statuses for invoice amendment line items.

Values

Enum Value	Description
`REFUNDED`	An invoice adjustment because the customer has received a refund.
`CANCELLED`	An invoice adjustment because the order or line item has been cancelled.

Example

"REFUNDED"

Types

InvoiceAmendmentSort

Description

Attributes for sorting invoice amendments

Fields

Input Field	Description
`fields` - `[InvoiceAmendmentSortFieldEnum!]!`	Fields to sort invoice amendments. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["CREATED_AT"], "ordering": "ASCENDING"}

Types

InvoiceAmendmentSortFieldEnum

Description

The field that is used to sort invoice amendments

Values

Enum Value	Description
`CREATED_AT`
`UPDATED_AT`
`REMITTED_AT`

Example

"CREATED_AT"

Types

InvoiceAmendmentsConnection

Description

The connection type for InvoiceAmendment.

Fields

Field Name	Description
`edges` - `[InvoiceAmendmentsEdge]`	A list of edges.
`nodes` - `[InvoiceAmendment]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [InvoiceAmendmentsEdge],
  "nodes": [InvoiceAmendment],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

InvoiceAmendmentsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `InvoiceAmendment`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": InvoiceAmendment
}

Types

InvoiceAnnotation

Description

Annotation on an invoice.

Fields

Field Name	Description
`content` - `String!`
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`invoice` - `Invoice!`
`invoiceAnnotationType` - `InvoiceAnnotationType!`
`resolved` - `Boolean!`
`updatedAt` - `ISO8601DateTime!`

Example

{
  "content": "abc123",
  "createdAt": ISO8601DateTime,
  "id": "4",
  "invoice": Invoice,
  "invoiceAnnotationType": InvoiceAnnotationType,
  "resolved": false,
  "updatedAt": ISO8601DateTime
}

Types

InvoiceAnnotationCreateMutationInput

Description

Autogenerated input type of InvoiceAnnotationCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID!`	ID of the invoice to be annotated.
`invoiceAnnotationTypeId` - `ID!`	ID of the invoice annotation type.
`attributes` - `InvoiceAnnotationInput!`	Attributes to assign to the invoice annotation.

Example

{
  "clientMutationId": "abc123",
  "invoiceId": 4,
  "invoiceAnnotationTypeId": "4",
  "attributes": InvoiceAnnotationInput
}

Types

InvoiceAnnotationCreateMutationPayload

Description

Autogenerated return type of InvoiceAnnotationCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotation` - `InvoiceAnnotation`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotation": InvoiceAnnotation,
  "status": 987
}

Types

InvoiceAnnotationInput

Description

Attributes for creating or updating an invoice annotation

Fields

Input Field	Description
`content` - `String!`	Content of the invoice annotation. What is considered valid content will vary depending on the invoice annotation type.
`resolved` - `Boolean!`	Has this annotation been resolved?

Example

{"content": "xyz789", "resolved": false}

Types

InvoiceAnnotationResolveMutationInput

Description

Autogenerated input type of InvoiceAnnotationResolveMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceAnnotationId` - `ID!`	ID of the invoice annotation to be resolved.

Example

{
  "clientMutationId": "xyz789",
  "invoiceAnnotationId": "4"
}

Types

InvoiceAnnotationResolveMutationPayload

Description

Autogenerated return type of InvoiceAnnotationResolveMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotation` - `InvoiceAnnotation`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotation": InvoiceAnnotation,
  "status": 123
}

Types

InvoiceAnnotationType

Description

A type of invoice annotation.

Fields

Field Name	Description
`creatableByCustomer` - `Boolean`
`creatableByOperator` - `Boolean`
`creatableBySeller` - `Boolean`
`createdAt` - `ISO8601DateTime!`
`description` - `String!`
`discardedAt` - `ISO8601DateTime`
`editableByCustomer` - `Boolean`
`editableByOperator` - `Boolean`
`editableBySeller` - `Boolean`
`id` - `ID!`
`name` - `String!`
`resolvableByCustomer` - `Boolean`
`resolvableByOperator` - `Boolean`
`resolvableBySeller` - `Boolean`
`updatedAt` - `ISO8601DateTime!`
`viewableByCustomer` - `Boolean`
`viewableByOperator` - `Boolean`
`viewableBySeller` - `Boolean`

Example

{
  "creatableByCustomer": true,
  "creatableByOperator": true,
  "creatableBySeller": false,
  "createdAt": ISO8601DateTime,
  "description": "abc123",
  "discardedAt": ISO8601DateTime,
  "editableByCustomer": false,
  "editableByOperator": true,
  "editableBySeller": true,
  "id": "4",
  "name": "abc123",
  "resolvableByCustomer": true,
  "resolvableByOperator": true,
  "resolvableBySeller": false,
  "updatedAt": ISO8601DateTime,
  "viewableByCustomer": true,
  "viewableByOperator": true,
  "viewableBySeller": true
}

Types

InvoiceAnnotationTypeConnection

Description

The connection type for InvoiceAnnotationType.

Fields

Field Name	Description
`edges` - `[InvoiceAnnotationTypeEdge]`	A list of edges.
`nodes` - `[InvoiceAnnotationType]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [InvoiceAnnotationTypeEdge],
  "nodes": [InvoiceAnnotationType],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

InvoiceAnnotationTypeCreateMutationInput

Description

Autogenerated input type of InvoiceAnnotationTypeCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `InvoiceAnnotationTypeInput!`	Attributes to assign to new invoice annotation type.

Example

{
  "clientMutationId": "xyz789",
  "attributes": InvoiceAnnotationTypeInput
}

Types

InvoiceAnnotationTypeCreateMutationPayload

Description

Autogenerated return type of InvoiceAnnotationTypeCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotationType` - `InvoiceAnnotationType`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotationType": InvoiceAnnotationType,
  "status": 987
}

Types

InvoiceAnnotationTypeDiscardMutationInput

Description

Autogenerated input type of InvoiceAnnotationTypeDiscardMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceAnnotationTypeId` - `ID!`	ID of the invoice annotation type to be discarded.

Example

{
  "clientMutationId": "abc123",
  "invoiceAnnotationTypeId": "4"
}

Types

InvoiceAnnotationTypeDiscardMutationPayload

Description

Autogenerated return type of InvoiceAnnotationTypeDiscardMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotationType` - `InvoiceAnnotationType`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotationType": InvoiceAnnotationType,
  "status": 123
}

Types

InvoiceAnnotationTypeEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `InvoiceAnnotationType`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": InvoiceAnnotationType
}

Types

InvoiceAnnotationTypeInput

Description

Attributes for creating or updating an invoice annotation type

Fields

Input Field	Description
`name` - `String!`	Name of the invoice annotation type. Must be unique amongst non-discarded invoice annotation types.
`description` - `String!`	Description of the invoice annotation type. Will be presented as instructions to the people creating an invoice annotation of this type.
`creatableByCustomer` - `Boolean`
`creatableBySeller` - `Boolean`
`creatableByOperator` - `Boolean`
`viewableByCustomer` - `Boolean`
`viewableBySeller` - `Boolean`
`viewableByOperator` - `Boolean`
`editableByCustomer` - `Boolean`
`editableBySeller` - `Boolean`
`editableByOperator` - `Boolean`
`resolvableByCustomer` - `Boolean`
`resolvableBySeller` - `Boolean`
`resolvableByOperator` - `Boolean`

Example

{
  "name": "abc123",
  "description": "abc123",
  "creatableByCustomer": false,
  "creatableBySeller": true,
  "creatableByOperator": true,
  "viewableByCustomer": false,
  "viewableBySeller": true,
  "viewableByOperator": false,
  "editableByCustomer": true,
  "editableBySeller": false,
  "editableByOperator": true,
  "resolvableByCustomer": false,
  "resolvableBySeller": true,
  "resolvableByOperator": false
}

Types

InvoiceAnnotationTypeUpdateMutationInput

Description

Autogenerated input type of InvoiceAnnotationTypeUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceAnnotationTypeId` - `ID!`	ID of the invoice annotation type to be updated.
`attributes` - `InvoiceAnnotationTypeInput!`	Attributes to assign to the invoice annotation type.

Example

{
  "clientMutationId": "abc123",
  "invoiceAnnotationTypeId": "4",
  "attributes": InvoiceAnnotationTypeInput
}

Types

InvoiceAnnotationTypeUpdateMutationPayload

Description

Autogenerated return type of InvoiceAnnotationTypeUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotationType` - `InvoiceAnnotationType`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotationType": InvoiceAnnotationType,
  "status": 123
}

Types

InvoiceAnnotationUpdateMutationInput

Description

Autogenerated input type of InvoiceAnnotationUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceAnnotationId` - `ID!`	ID of the invoice annotation to be updated.
`attributes` - `InvoiceAnnotationInput!`	Attributes to assign to the invoice annotation.

Example

{
  "clientMutationId": "xyz789",
  "invoiceAnnotationId": 4,
  "attributes": InvoiceAnnotationInput
}

Types

InvoiceAnnotationUpdateMutationPayload

Description

Autogenerated return type of InvoiceAnnotationUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`invoiceAnnotation` - `InvoiceAnnotation`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "invoiceAnnotation": InvoiceAnnotation,
  "status": 987
}

Types

InvoiceClickAndCollectStatusEnum

Description

Available statuses click_and_collect invoices can transition to

Values

Enum Value	Description
`READY`
`COLLECTED`

Example

"READY"

Types

InvoiceConnection

Description

The connection type for Invoice.

Fields

Field Name	Description
`edges` - `[InvoiceEdge]`	A list of edges.
`nodes` - `[Invoice]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [InvoiceEdge],
  "nodes": [Invoice],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

InvoiceEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Invoice`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Invoice
}

Types

InvoiceFilters

Description

Attributes for filtering invoices

Fields

Input Field	Description
`createdSince` - `ISO8601DateTime`	Invoices created since this time. Default = `null`
`createdUntil` - `ISO8601DateTime`	Invoices created until this time. Default = `null`
`updatedSince` - `ISO8601DateTime`	Invoices updated since this time. Default = `null`
`updatedUntil` - `ISO8601DateTime`	Invoices updated until this time. Default = `null`
`paidSince` - `ISO8601DateTime`	Invoices paid since this time. Default = `null`
`paidUntil` - `ISO8601DateTime`	Invoices paid until this time. Default = `null`
`remittedSince` - `ISO8601DateTime`	Invoices remitted since this time. Default = `null`
`remittedUntil` - `ISO8601DateTime`	Invoices remitted until this time. Default = `null`
`statuses` - `[InvoiceStatusEnum!]`	Invoices with one of these statuses. Default = `null`
`buyerEmailAddress` - `String`	Invoices that are linked with this buyer email address. Default = `null`
`externalId` - `String`	Invoices with external ID value matching the value of an exposed external ID set on the associated order. Default = `null`
`partialExternalId` - `String`	Invoices with external ID value starting with the given value. Default = `null`
`legacyId` - `Int`	Invoices with matching marketplacer database invoice ID. Default = `null`
`orderId` - `Int`	Invoices with orders having matching marketplacer database order ID. Default = `null`
`buyerName` - `String`	Invoices that are linked with a buyers name containing this value. Default = `null`
`notDispatched` - `Boolean`	Invoices with line items that are not fully dispatched. Default = `null`
`awaitingReturn` - `Boolean`	Invoices with pending refund requests. Default = `null`
`awaitingCollection` - `Boolean`	Invoices with that are ready for collection. Default = `null`
`withUnresolvedAnnotationsOfType` - `ID`	Invoices with an unresolved annotation of this type. Default = `null`

Example

{
  "createdSince": ISO8601DateTime,
  "createdUntil": ISO8601DateTime,
  "updatedSince": ISO8601DateTime,
  "updatedUntil": ISO8601DateTime,
  "paidSince": ISO8601DateTime,
  "paidUntil": ISO8601DateTime,
  "remittedSince": ISO8601DateTime,
  "remittedUntil": ISO8601DateTime,
  "statuses": ["AWAITING_PAYMENT"],
  "buyerEmailAddress": "abc123",
  "externalId": "xyz789",
  "partialExternalId": "abc123",
  "legacyId": 987,
  "orderId": 123,
  "buyerName": "xyz789",
  "notDispatched": false,
  "awaitingReturn": true,
  "awaitingCollection": false,
  "withUnresolvedAnnotationsOfType": 4
}

Types

InvoiceInput

Description

Attributes for creating or updating an invoice

Fields

Input Field	Description
`externalIds` - `[KeyValueInput!]`	Attributes for external IDs used by external systems to fetch invoices.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`totalCents` - `Int`	Total cost of the invoice, which includes subtotals and cost of shipping if applicable. Denominated in cents. Deprecated as of July 2022 as the total is calculated from line items and will be removed on January 2023.
`lineItems` - `[LineItemInput!]!`	Attributes of line items associated with the invoice.
`adjustments` - `[AdjustmentInput!]`	Adjustments to apply to the invoice.

Example

{
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "totalCents": 987,
  "lineItems": [LineItemInput],
  "adjustments": [AdjustmentInput]
}

Types

InvoiceSort

Description

Attributes for sorting invoices

Fields

Input Field	Description
`fields` - `[InvoiceSortFieldEnum!]!`	Fields to sort invoices. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["CREATED_AT"], "ordering": "ASCENDING"}

Types

InvoiceSortFieldEnum

Description

The field that is used to sort invoices

Values

Enum Value	Description
`CREATED_AT`
`UPDATED_AT`
`PAID_AT`
`REMITTED_AT`
`STATUS`

Example

"CREATED_AT"

Types

InvoiceStatusEnum

Description

The current status of an invoice. The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.

Values

Enum Value	Description
`AWAITING_PAYMENT`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`PAID`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`PAYMENT_UNDER_REVIEW`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`SENT`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`PARTIALLY_SENT`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`READY`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`COLLECTED`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.
`REFUNDED`	Was too confusing, look at invoiceAmendments and refundRequests instead. Will be removed 2021-12-01.
`CANCELLED`	The invoice status field was deprecated, so this enum is also deprecated. Will be removed 2021-12-01.

Example

"AWAITING_PAYMENT"

Types

InvoiceStatusFlagEnum

Description

A status flag on an invoice.

Values

Enum Value	Description
`PAID`
`PAYMENT_UNDER_REVIEW`
`SENT`
`PARTIALLY_SENT`
`AWAITING_RETURN`
`AWAITING_REFUND`
`REFUNDED`
`CANCELLED`
`READY`
`COLLECTED`
`REMITTED`

Example

"PAID"

Types

InvoicesConnection

Description

The connection type for Invoice.

Fields

Field Name	Description
`edges` - `[InvoicesEdge]`	A list of edges.
`nodes` - `[Invoice]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [InvoicesEdge],
  "nodes": [Invoice],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

InvoicesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Invoice`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Invoice
}

Types

JSON

Description

Represents untyped JSON

Example

{}

Types

KeyValue

Description

Key Value tuple

Fields

Field Name	Description
`key` - `String!`
`value` - `String!`

Example

{
  "key": "abc123",
  "value": "abc123"
}

Types

KeyValueInput

Description

Generic key-value object for when we need data whose structure isn't predefined.

Fields

Input Field	Description
`key` - `String!`	The object key.
`value` - `String`	The value associated with the given key.

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

Types

KlaviyoSettings

Description

Klaviyo settings

Fields

Field Name	Description
`category` - `CategoryTypeEnum!`
`description` - `String!`
`ecommerceTrackingEnabled` - `Boolean`
`edmEnabled` - `Boolean`
`logoUrl` - `String!`
`privateApiKey` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`publicApiKey` - `String`
`status` - `StatusTypeEnum!`

Example

{
  "category": "RATINGS_AND_REVIEWS",
  "description": "xyz789",
  "ecommerceTrackingEnabled": true,
  "edmEnabled": false,
  "logoUrl": "abc123",
  "privateApiKey": "abc123",
  "providerHandle": "abc123",
  "providerName": "abc123",
  "publicApiKey": "abc123",
  "status": "AVAILABLE"
}

Types

KlaviyoSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of KlaviyoSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`publicApiKey` - `String!`	Klaviyo public API key.
`privateApiKey` - `String!`	Klaviyo private API key.

Example

{
  "clientMutationId": "abc123",
  "publicApiKey": "abc123",
  "privateApiKey": "xyz789"
}

Types

KlaviyoSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of KlaviyoSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`klaviyoSettings` - `KlaviyoSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "klaviyoSettings": KlaviyoSettings,
  "status": 123
}

Types

KlaviyoSettingsDeleteMutationInput

Description

Autogenerated input type of KlaviyoSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "abc123"}

Types

KlaviyoSettingsDeleteMutationPayload

Description

Autogenerated return type of KlaviyoSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`klaviyoSettings` - `KlaviyoSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "klaviyoSettings": KlaviyoSettings,
  "status": 987
}

Types

LineItem

Description

Line items associated with a cart or order.

Fields

Field Name	Description
`adjustments` - `[Adjustment!]`	Adjustments applied to the line item
`advert` - `Advert`	The advertisement of the item being purchased. Since this can change after the order is created, you should use the copied values
`advertCode` - `String`	The advert code captured at the time of invoice creation
`advertId` - `ID`	The advert id captured at the time of invoice creation
`advertLegacyId` - `Int`	The advert legacyId captured at the time of invoice creation
`advertTitle` - `String`	The advert title captured at the time of invoice creation
`brandName` - `String`	Brand name for the line item
`commissionAmountCents` - `Int`	Commission amount Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountFormatted` - `String`	Commission amount In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountTaxCents` - `Int`	Total commission tax amount for the line item Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountTaxFormatted` - `String`	Total commission tax amount for the line item In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionRate` - `String`	Commission percentage used to calculate the commission amount
`commissionTaxRate` - `Float`	Commission tax rate set in invoice
`discountCents` - `Int!`	The discount applied to the item. Negative value. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	The discount applied to the item. Negative value. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`image` - `Image`
`inventory` - `Inventory`
`invoice` - `Invoice`
`itemAmountCents` - `Int!`	Total cost per item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`itemAmountFormatted` - `String!`	Total cost per item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`legacyId` - `Int!`
`merchantFeesTaxRate` - `Float`	Merchant fee tax rate set in invoice
`metadata` - `[Metadatum!]!`	Metadata key/values
`postageCents` - `Int!`	The postage total on the item(s). Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`postageFormatted` - `String!`	The postage total on the item(s). In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`postageTaxRate` - `Float`	Postage tax rate
`pricingModel` - `PricingModelEnum!`	The pricing model of the line item
`quantity` - `Int!`
`quantityAwaitingDispatch` - `Int`
`quantityReturnable` - `Int!`	Quantity that has been dispatched that is available for refund.
`shipment` - `Shipment`	Deprecated: As of Feb 2021 in favour of shipments field (collection of all associated shipments). Returns the most recent shipment associated with this line item
`shipments` - `[Shipment!]`
`status` - `LineItemStatusEnum!`	Status of the line item. It is suggested to use statusFull
`statusFull` - `LineItemStatusFullEnum!`	A fuller featured status that includes shipping statuses
`subtotalCents` - `Int!`	The item subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalFormatted` - `String!`	The item subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`taxRate` - `Float`	Line item tax rate
`taxTotalCents` - `Int!`	The tax on the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	The tax on the item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalCents` - `Int!`	Total cost of the items, which includes subtotals and cost of shipping if applicable. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	Total cost of the items, which includes subtotals and cost of shipping if applicable. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`variant` - `Variant`	The product variant that is being purchased. Since this can change after the order is created, you should use the copied values
`variantBarcode` - `String`	The variant barcode captured at the time of invoice creation
`variantId` - `ID`	The variant id captured at the time of invoice creation
`variantLegacyId` - `Int`	The variant legacyId captured at the time of invoice creation
`variantName` - `String`	The variant description captured at the time of invoice creation
`variantSku` - `String`	The variant sku captured at the time of invoice creation
`wholesalePrice` - `Decimal`	The wholesale price of the line item

Example

{
  "adjustments": [Adjustment],
  "advert": Advert,
  "advertCode": "abc123",
  "advertId": "4",
  "advertLegacyId": 987,
  "advertTitle": "xyz789",
  "brandName": "xyz789",
  "commissionAmountCents": 987,
  "commissionAmountFormatted": "xyz789",
  "commissionAmountTaxCents": 987,
  "commissionAmountTaxFormatted": "abc123",
  "commissionRate": "xyz789",
  "commissionTaxRate": 987.65,
  "discountCents": 987,
  "discountFormatted": "xyz789",
  "externalIds": [ExternalID],
  "id": "4",
  "image": Image,
  "inventory": Inventory,
  "invoice": Invoice,
  "itemAmountCents": 987,
  "itemAmountFormatted": "xyz789",
  "legacyId": 123,
  "merchantFeesTaxRate": 123.45,
  "metadata": [Metadatum],
  "postageCents": 123,
  "postageFormatted": "xyz789",
  "postageTaxRate": 987.65,
  "pricingModel": "MARKETPLACE",
  "quantity": 123,
  "quantityAwaitingDispatch": 123,
  "quantityReturnable": 987,
  "shipment": Shipment,
  "shipments": [Shipment],
  "status": "NEW",
  "statusFull": "NEW",
  "subtotalCents": 987,
  "subtotalFormatted": "abc123",
  "taxRate": 123.45,
  "taxTotalCents": 123,
  "taxTotalFormatted": "abc123",
  "totalCents": 123,
  "totalFormatted": "xyz789",
  "variant": Variant,
  "variantBarcode": "abc123",
  "variantId": "4",
  "variantLegacyId": 123,
  "variantName": "xyz789",
  "variantSku": "xyz789",
  "wholesalePrice": Decimal
}

Types

LineItemConnection

Description

The connection type for LineItem.

Fields

Field Name	Description
`edges` - `[LineItemEdge]`	A list of edges.
`nodes` - `[LineItem]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [LineItemEdge],
  "nodes": [LineItem],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

LineItemEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `LineItem`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": LineItem
}

Types

LineItemInput

Description

Line items associated with a cart or order.

Fields

Input Field	Description
`variantId` - `ID!`	ID of the variant to become a line item.
`inventoryId` - `ID`	ID of the inventory for this line item/variant.The variant associated with this inventory must match `variantId`
`quantity` - `Int!`	Quantity of this item to be associated with the given order.
`totalCents` - `Int`	Deprecated as of March 2022, please use the cost input. Total cost of the item, which includes subtotals but excludes shipping (postage). Denominated in cents. Please ensure that the amount entered is equal to the Line Item Unit Price x Quantity
`postageCents` - `Int`	Deprecated as of March 2022, please use the postage input. Total cost of shipping the item. Denominated in cents.
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch LineItems
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs {external_shipment_id: "SHIP111"}
`postage` - `MoneyInputField`	Total cost of shipping the item.
`cost` - `MoneyInputField`	Total cost of the item, which includes subtotals but excludes shipping (postage). Please ensure that the amount entered is equal to the Line Item Unit Price x Quantity
`adjustments` - `[AdjustmentInput!]`	Adjustments to be applied to the line item.
`deliveryType` - `DeliveryTypeEnum`	Delivery type. Default = `BUY_ONLINE`

Example

{
  "variantId": "4",
  "inventoryId": "4",
  "quantity": 987,
  "totalCents": 987,
  "postageCents": 123,
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput],
  "postage": MoneyInputField,
  "cost": MoneyInputField,
  "adjustments": [AdjustmentInput],
  "deliveryType": "BUY_ONLINE"
}

Types

LineItemStatusEnum

Description

All possible statuses for line items.

Values

Enum Value	Description
`NEW`	Associated with an active, mutable cart.
`ALLOCATED`	Associated with a finalized, immutable order.
`REFUNDED`	A purchased item for which the user has received a refund.
`CANCELLED`	Associated with an order that has been cancelled.

Example

"NEW"

Types

LineItemStatusFullEnum

Description

All possible statuses for line items.

Values

Enum Value	Description
`NEW`	Associated with an active, mutable cart.
`ALLOCATED`	Associated with a finalized, immutable order.
`SHIPPED`	A purchased item which has been shipped to the user.
`REFUNDED`	A purchased item for which the user has received a refund.
`CANCELLED`	Associated with an order that has been cancelled.

Example

"NEW"

Types

LineItemsForShipmentsSpreadsheetDownloadMutationInput

Description

Autogenerated input type of LineItemsForShipmentsSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`format` - `SpreadsheetEnum`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": 4,
  "format": "XLSX"
}

Types

LineItemsForShipmentsSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of LineItemsForShipmentsSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 123
}

Types

LineItemsForShipmentsSpreadsheetUploadMutationInput

Description

Autogenerated input type of LineItemsForShipmentsSpreadsheetUploadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`spreadsheet` - `FileInput!`
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise

Example

{
  "clientMutationId": "abc123",
  "spreadsheet": FileInput,
  "sellerId": "4"
}

Types

LineItemsForShipmentsSpreadsheetUploadMutationPayload

Description

Autogenerated return type of LineItemsForShipmentsSpreadsheetUploadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`import` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "import": ImportExport,
  "status": 987
}

Types

Location

Description

Location object returned with location-based search results.

Fields

Field Name	Description
`countryCode` - `String!`
`displayName` - `String!`
`displayNameFull` - `String!`	Display name with postcode in countries with duplicated locations
`duplicated` - `Boolean!`	Multiple locations with same name within region?
`locationName` - `String!`
`locationSlug` - `String`
`postalCode` - `String`
`regionName` - `String!`
`regionShort` - `String!`
`regionSlug` - `String!`

Example

{
  "countryCode": "xyz789",
  "displayName": "xyz789",
  "displayNameFull": "abc123",
  "duplicated": true,
  "locationName": "xyz789",
  "locationSlug": "xyz789",
  "postalCode": "xyz789",
  "regionName": "xyz789",
  "regionShort": "abc123",
  "regionSlug": "xyz789"
}

Types

LoyaltyProgramLevel

Description

Loyalty program levels

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`	Loyalty program levels name

Example

{
  "id": "4",
  "name": "xyz789"
}

Types

LoyaltyProgramLevelsConnection

Description

The connection type for LoyaltyProgramLevel.

Fields

Field Name	Description
`edges` - `[LoyaltyProgramLevelsEdge]`	A list of edges.
`nodes` - `[LoyaltyProgramLevel]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [LoyaltyProgramLevelsEdge],
  "nodes": [LoyaltyProgramLevel],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

LoyaltyProgramLevelsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `LoyaltyProgramLevel`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": LoyaltyProgramLevel
}

Types

MapToUnion

Types

Union Types
`Brand`
`OptionValue`
`Taxon`

Example

Brand

Types

Mapping

Fields

Field Name	Description
`advertCount` - `Int!`
`adverts` - `AdvertsConnection!`
Arguments `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.
`autoMapScore` - `Float`
`id` - `ID!`
`mappedTo` - `MapToUnion`
`mappedType` - `MappingTypeEnum!`
`prototype` - `Prototype`
`sourceValue` - `String!`
`suggestions` - `[SuggestionsUnion!]`
Arguments `first` - `Int` Limit to the first N results
`unmappable` - `Boolean!`

Example

{
  "advertCount": 987,
  "adverts": AdvertsConnection,
  "autoMapScore": 123.45,
  "id": 4,
  "mappedTo": Brand,
  "mappedType": "BRAND",
  "prototype": Prototype,
  "sourceValue": "abc123",
  "suggestions": [Brand],
  "unmappable": false
}

Types

MappingCount

Description

Unfiltered counts

Fields

Field Name	Description
`brand` - `Int!`
`optionValue` - `Int!`
`taxon` - `Int!`

Example

{"brand": 123, "optionValue": 123, "taxon": 123}

Types

MappingEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Mapping`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Mapping
}

Types

MappingFilters

Fields

Input Field	Description
`q` - `String`	Filter by product id or source value
`mappedType` - `MappingTypeEnum`
`unmappable` - `Boolean`
`mapped` - `Boolean`
`hasAffectedAdverts` - `Boolean`
`autoMapped` - `Boolean`
`maxAutoMapScore` - `Float`
`minAutoMapScore` - `Float`

Example

{
  "q": "abc123",
  "mappedType": "BRAND",
  "unmappable": false,
  "mapped": false,
  "hasAffectedAdverts": false,
  "autoMapped": true,
  "maxAutoMapScore": 123.45,
  "minAutoMapScore": 987.65
}

Types

MappingSetMutationInput

Description

Autogenerated input type of MappingSetMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`mappingId` - `ID!`
`mapToId` - `ID`
`unmappable` - `Boolean`

Example

{
  "clientMutationId": "abc123",
  "mappingId": 4,
  "mapToId": "4",
  "unmappable": true
}

Types

MappingSetMutationPayload

Description

Autogenerated return type of MappingSetMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`mapping` - `Mapping`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "mapping": Mapping,
  "status": 987
}

Types

MappingTypeEnum

Values

Enum Value	Description
`BRAND`
`TAXON`
`OPTION_VALUE`

Example

"BRAND"

Types

MappingsConnection

Description

The connection type for Mapping.

Fields

Field Name	Description
`edges` - `[MappingEdge]`	A list of edges.
`nodes` - `[Mapping]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`
`unfilteredCounts` - `MappingCount`	Unfiltered counts

Example

{
  "edges": [MappingEdge],
  "nodes": [Mapping],
  "pageInfo": PageInfo,
  "totalCount": 987,
  "unfilteredCounts": MappingCount
}

Types

Markdown

Description

A menu entry with markdown contents

Fields

Field Name	Description
`id` - `ID!`
`markdown` - `String!`	Raw markdown for entry detail
`name` - `String!`	Presentational name of the entry

Example

{
  "id": 4,
  "markdown": "xyz789",
  "name": "xyz789"
}

Types

MarketfacerPagesEnabled

Description

Marketfacer pages enabled flags

Fields

Field Name	Description
`directory` - `Boolean!`
`search` - `Boolean!`
`shop` - `Boolean!`

Example

{"directory": false, "search": true, "shop": false}

Types

MarketplacerAPIKey

Description

Marketplacer API key info

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`	The date the API key was created.
`createdById` - `Int!`	The user id of created API key
`createdByType` - `String!`	The user type of created API key
`description` - `String!`
`id` - `ID!`
`organization` - `String!`

Example

{
  "createdAt": ISO8601DateTime,
  "createdById": 987,
  "createdByType": "xyz789",
  "description": "abc123",
  "id": 4,
  "organization": "abc123"
}

Types

MarketplacerAPIKeyCreateMutationInput

Description

Autogenerated input type of MarketplacerAPIKeyCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`description` - `String!`	description of API key
`organization` - `String!`
`apiTermsOfUse` - `Boolean!`

Example

{
  "clientMutationId": "abc123",
  "description": "xyz789",
  "organization": "xyz789",
  "apiTermsOfUse": false
}

Types

MarketplacerAPIKeyCreateMutationPayload

Description

Autogenerated return type of MarketplacerAPIKeyCreateMutation.

Fields

Field Name	Description
`apiKey` - `String`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`marketplacerApiKey` - `MarketplacerAPIKey`
`status` - `Int!`

Example

{
  "apiKey": "xyz789",
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "marketplacerApiKey": MarketplacerAPIKey,
  "status": 987
}

Types

MeasurementUnit

Description

Measurement unit

Fields

Field Name	Description
`adverts` - `AdvertsConnection!`	List of adverts implementing the measurement unit This was previously used to get the number of adverts associated to the measurement unit. Use advertsCount instead.
Arguments `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.
`advertsCount` - `Int!`	The number of adverts implementing the measurement unit
`comparableVariants` - `VariantConnection!`	List of comparable variants implementing the measurement unit This was previously used to get the number of comparable variants implementing the measurement unit. Use variantsCount instead.
Arguments `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.
`createdAt` - `ISO8601DateTime!`	When the record was created
`id` - `ID!`
`measurementType` - `String!`	The field that represents the measurement unit type
`name` - `String!`	Full name of measurement unit (eg: kilograms)
`short` - `String!`	Short code for the measurement unit (eg: kg)
`updatedAt` - `ISO8601DateTime!`	When the record was last updated
`variants` - `VariantConnection!`	List of variants implementing the measurement unit This was previously used to get the number of variants implementing the measurement unit. Use variantsCount instead.
Arguments `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.
`variantsCount` - `Int!`	The maximum of the count of variants and comparable variants implementing the measurement unit

Example

{
  "adverts": AdvertsConnection,
  "advertsCount": 987,
  "comparableVariants": VariantConnection,
  "createdAt": ISO8601DateTime,
  "id": 4,
  "measurementType": "xyz789",
  "name": "xyz789",
  "short": "abc123",
  "updatedAt": ISO8601DateTime,
  "variants": VariantConnection,
  "variantsCount": 123
}

Types

MeasurementUnitConnection

Description

The connection type for MeasurementUnit.

Fields

Field Name	Description
`edges` - `[MeasurementUnitEdge]`	A list of edges.
`nodes` - `[MeasurementUnit]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [MeasurementUnitEdge],
  "nodes": [MeasurementUnit],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

MeasurementUnitCreateMutationInput

Description

Autogenerated input type of MeasurementUnitCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `MeasurementUnitInput!`	Attributes to create new measurement unit.

Example

{
  "clientMutationId": "xyz789",
  "attributes": MeasurementUnitInput
}

Types

MeasurementUnitCreateMutationPayload

Description

Autogenerated return type of MeasurementUnitCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`measurementUnit` - `MeasurementUnit`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "measurementUnit": MeasurementUnit,
  "status": 123
}

Types

MeasurementUnitDeleteMutationInput

Description

Autogenerated input type of MeasurementUnitDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the measurement unit
`moveToUnitId` - `ID`	ID of the measurement unit where variants and adverts belonging to the unit are moved to. Default = `null`

Example

{
  "clientMutationId": "xyz789",
  "id": 4,
  "moveToUnitId": "4"
}

Types

MeasurementUnitDeleteMutationPayload

Description

Autogenerated return type of MeasurementUnitDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`measurementUnit` - `MeasurementUnit`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "measurementUnit": MeasurementUnit,
  "status": 987
}

Types

MeasurementUnitEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `MeasurementUnit`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": MeasurementUnit
}

Types

MeasurementUnitFilters

Description

Attributes for filtering Measurement Units

Fields

Input Field	Description
`q` - `String`	Keywords to search for. (Currently Name, Short or Measurement Type). Default = `null`

Example

{"q": "xyz789"}

Types

MeasurementUnitInput

Fields

Input Field	Description
`name` - `String!`	Full name of measurement unit (eg: kilograms)
`short` - `String!`	Short code for the measurement unit (eg: kg)
`measurementType` - `MeasurementUnitTypeEnum!`	The field that represents the measurement unit type

Example

{
  "name": "abc123",
  "short": "xyz789",
  "measurementType": "LENGTH"
}

Types

MeasurementUnitSort

Description

Attributes for sorting measurement units

Fields

Input Field	Description
`fields` - `[MeasurementUnitSortFieldEnum!]!`	Fields to sort measurement units
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["NAME"], "ordering": "ASCENDING"}

Types

MeasurementUnitSortFieldEnum

Description

The field that is used to sort measurement units

Values

Enum Value	Description
`NAME`	The name of the measurement unit
`SHORT`	The short of the measurement unit
`MEASUREMENT_TYPE`	The measurement_type of the measurement unit
`VARIANT_COUNT`	The number of variants utilising the measurement unit
`ADVERT_COUNT`	The number of adverts utilising the measurement unit
`CREATED_AT`	The created_at date of the measurement unit

Example

"NAME"

Types

MeasurementUnitTypeEnum

Description

The field that represents the measurement unit type

Values

Enum Value	Description
`LENGTH`	Measurement unit of type length
`WEIGHT`	Measurement unit of type weight
`VOLUME`	Measurement unit of type volume
`AREA`	Measurement unit of type area
`EACH`	Measurement unit of type each
`NUMBER`	Measurement unit of type number
`CUSTOM`	Measurement unit of type custom

Example

"LENGTH"

Types

MeasurementUnitUpdateInput

Fields

Input Field	Description
`name` - `String`	Full name of measurement unit (eg: kilograms)
`short` - `String`	Short code for the measurement unit (eg: kg)
`measurementType` - `MeasurementUnitTypeEnum`	The field that represents the measurement unit type

Example

{
  "name": "xyz789",
  "short": "abc123",
  "measurementType": "LENGTH"
}

Types

MeasurementUnitUpdateMutationInput

Description

Autogenerated input type of MeasurementUnitUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`measurementUnitId` - `ID!`	ID for retrieving the correct measurement unit.
`attributes` - `MeasurementUnitUpdateInput!`	Attributes to update measurement unit.

Example

{
  "clientMutationId": "abc123",
  "measurementUnitId": 4,
  "attributes": MeasurementUnitUpdateInput
}

Types

MeasurementUnitUpdateMutationPayload

Description

Autogenerated return type of MeasurementUnitUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`measurementUnit` - `MeasurementUnit`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "measurementUnit": MeasurementUnit,
  "status": 123
}

Types

MemberSettings

Description

Member settings on marketplace

Fields

Field Name	Description
`advancedAmendmentsEnabled` - `Boolean!`	True if advanced amendments flow is enabled.
`advancedRefundsEnabled` - `Boolean!`	True if advanced refunds flow is enabled.
`disableLegacySellerPortal` - `Boolean!`	Legacy Seller Portal is disabled for all Sellers. This will mean any links to the legacy portal will be redirected.
`hideSellerBusinessRegistrationCode` - `Boolean!`	True if the business registration code of the seller should be hidden from view.
`id` - `ID!`
`invoiceNotDispatchedThreshold` - `Int`	Number of days within which an item must be shipped to avoid breaching the SLA
`lineItemMetadataExposed` - `[String!]!`	List of keys that can be used to set line item metadata on an invoice line item.
`orderExternalIdsExposed` - `[String!]!`	ExternalIDs set on the order at creation through the API.
`pdfFooterTextEnabled` - `Boolean!`	True if pdf footer text is enabled.

Example

{
  "advancedAmendmentsEnabled": false,
  "advancedRefundsEnabled": true,
  "disableLegacySellerPortal": false,
  "hideSellerBusinessRegistrationCode": false,
  "id": "4",
  "invoiceNotDispatchedThreshold": 123,
  "lineItemMetadataExposed": ["xyz789"],
  "orderExternalIdsExposed": ["abc123"],
  "pdfFooterTextEnabled": false
}

Types

Metadata2UpsertMutationInput

Description

Autogenerated input type of Metadata2UpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`ownerId` - `ID!`	ID of the local object to link
`metadata` - `[KeyValueInput!]!`	Key/Value pairs for the metadatum

Example

{
  "clientMutationId": "abc123",
  "ownerId": "4",
  "metadata": [KeyValueInput]
}

Types

Metadata2UpsertMutationPayload

Description

Autogenerated return type of Metadata2UpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`metadata` - `[Metadatum!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "metadata": [Metadatum],
  "status": 123
}

Types

MetadataUpsertMutationInput

Description

Autogenerated input type of MetadataUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`owner` - `ID!`	ID of the local object to link
`key` - `String!`	Name of the remote system for the ID, eg. 'my_system'
`value` - `String!`	ID on the remote system

Example

{
  "clientMutationId": "xyz789",
  "owner": 4,
  "key": "xyz789",
  "value": "abc123"
}

Types

MetadataUpsertMutationPayload

Description

Autogenerated return type of MetadataUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`metadata` - `Metadatum`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "metadata": Metadatum,
  "status": 987
}

Types

Metadatum

Description

Metadata key value tuples

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`key` - `String!`
`owner` - `Node!`
`updatedAt` - `ISO8601DateTime!`
`value` - `String!`

Example

{
  "createdAt": ISO8601DateTime,
  "id": 4,
  "key": "xyz789",
  "owner": Node,
  "updatedAt": ISO8601DateTime,
  "value": "xyz789"
}

Types

Model

Description

Product model

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`slug` - `String!`	The URL subpath associated with the given model. Mostly used for building URLs for product search results.
`year` - `Int`

Example

{
  "id": "4",
  "name": "abc123",
  "slug": "abc123",
  "year": 987
}

Types

ModelFilterOption

Description

Minimal subset of Model type which can be used to build a model filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with each model filter option
`id` - `ID!`
`name` - `String!`
`slug` - `String!`	The URL subpath associated with the given model. Mostly used for building URLs for product search results.

Example

{
  "count": 123,
  "id": 4,
  "name": "xyz789",
  "slug": "xyz789"
}

Types

Money

Description

A monetary value with currency

Fields

Field Name	Description
`amount` - `Decimal!`
`currencyCode` - `String!`
`formatted` - `String!`
Arguments `currency` - `String` `disambiguate` - `Boolean`

Example

{
  "amount": Decimal,
  "currencyCode": "xyz789",
  "formatted": "xyz789"
}

Types

MoneyInputField

Description

Money input field where values are usually specified in the lowest currency denomination (e.g. cents), unless otherwise specified.

Fields

Input Field	Description
`amount` - `Int!`	The amount. Denominated in lowest currency value, e.g. Cents.
`tax` - `Int`	The tax on the amount. Denominated in lowest currency value, e.g. Cents.
`taxRate` - `Float`	The decimal value tax rate for this line item. If not supplied, will be fetched from the associated variant, advert, category, Finance Settings or country.

Example

{"amount": 123, "tax": 987, "taxRate": 123.45}

Types

MultiStore

Description

A branch of a store with multiple locations.

Fields

Field Name	Description
`showParentInfo` - `Boolean!`	Show the parent store info

Example

{"showParentInfo": true}

Types

MultiStoreMembership

Description

The child of a managed multi store.

Fields

Field Name	Description
`multiStoreId` - `Int!`	Id of the parent multi store

Example

{"multiStoreId": 123}

Types

MutationAuthorization

Description

Labels for all available forms of authorization

Values

Enum Value	Description
`recaptcha`	Google reCAPTCHA As of June 2020, deprecated in favour of MutationAuthorizationTypeEnum.RECAPTCHA in order to be consistent with enum naming conventions. This will be removed in January 2021.

Example

"recaptcha"

Types

NavBar

Description

Properties defining a navigation bar

Fields

Field Name	Description
`blogVisible` - `Boolean!`	Blog link visibility
`cartItemCount` - `Int`	Count of items in the cart
`customLinks` - `[CustomNavLink!]!`	Links specific to the vertical/store
`directoryLinkLocation` - `String!`	Directory ("Find a store") link location
`directoryVisible` - `Boolean!`	Directory ("Find a store") link visibility
`loginLogoutVisible` - `Boolean!`	User login/logout/registration controls visibility
`logo` - `String`	Logo image URL
`name` - `String!`	Business name
`placeAdVisible` - `Boolean!`	"Place an ad" link visibility
`showJoinUsLinks` - `Boolean!`	True if we want to show "join us" links in the header

Example

{
  "blogVisible": false,
  "cartItemCount": 987,
  "customLinks": [CustomNavLink],
  "directoryLinkLocation": "xyz789",
  "directoryVisible": false,
  "loginLogoutVisible": false,
  "logo": "xyz789",
  "name": "abc123",
  "placeAdVisible": true,
  "showJoinUsLinks": true
}

Types

NewsletterSubscribeMutationInput

Description

Autogenerated input type of NewsletterSubscribeMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`email` - `String!`	Email to subscribe
`authorizationType` - `MutationAuthorization`	Service to verify requests against. If not supplied, API Key auth is required.
`token` - `String`	Token to verify with `authorizationType` service

Example

{
  "clientMutationId": "abc123",
  "email": "xyz789",
  "authorizationType": "recaptcha",
  "token": "xyz789"
}

Types

NewsletterSubscribeMutationPayload

Description

Autogenerated return type of NewsletterSubscribeMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`email` - `String`	Subscribed email
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "email": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

NewsletterSubscriptionForm

Description

Newsletter subscription form metadata

Fields

Field Name	Description
`emailPlaceholder` - `String!`	Placeholder for Email field of a subscription form
`subscribeButtonText` - `String!`	Subscribe button text
`subscribeIndexPath` - `String`	Path to Subscribe page
`subscriptionHeading` - `String`	Subscription heading

Example

{
  "emailPlaceholder": "xyz789",
  "subscribeButtonText": "abc123",
  "subscribeIndexPath": "xyz789",
  "subscriptionHeading": "xyz789"
}

Types

Node

Description

An object with an ID.

Fields

Field Name	Description
`id` - `ID!`	ID of the object.

Possible Types

Node Types
`Address`
`Adjustment`
`Admin`
`AdminRole`
`Advert`
`AdvertCategorySuggestion`
`AdvertDocument`
`AdvertOptionValue`
`AllAdvertVariant`
`Attachment`
`AvailabilityFilterOption`
`Billing`
`BillingLineItem`
`Brand`
`Cart`
`CartItem`
`CatalogRule`
`ChangeLog`
`ChatMessage`
`CommissionPackage`
`CommissionPackageSchedule`
`CommissionPackageScheduleItem`
`CommissionPackageVersion`
`CommissionPackageVersionLog`
`ConditionFilterOption`
`ContextualHistory`
`Country`
`CustomCommissionRate`
`CustomField`
`CustomFieldGroup`
`DeletedAdvert`
`DeletedSeller`
`DirectLink`
`ESAdvert`
`ESBrand`
`ESSeller`
`ESTaxon`
`EntityCustomField`
`EntityCustomFieldGroup`
`FreetextOptionValue`
`GenderFilterOption`
`GlobalSearchResult`
`GoldenProduct`
`GoldenProductDocument`
`GoldenProductOptionValue`
`GoldenProductVariant`
`GoldenProductVariantOptionValue`
`Image`
`ImportExport`
`ImportExportCommissionPackageSchedule`
`Inventory`
`Invoice`
`InvoiceAmendment`
`InvoiceAmendmentLineItem`
`InvoiceAnnotation`
`InvoiceAnnotationType`
`LineItem`
`Mapping`
`Markdown`
`MeasurementUnit`
`Model`
`OptionType`
`OptionValue`
`OptionalOptionValue`
`Order`
`PaymentEvent`
`Promotion`
`Prototype`
`RankedResult`
`Redirect`
`RefundRequest`
`RefundRequestLineItem`
`RefundRequestNote`
`Remittance`
`RemittanceAdvice`
`ReturnShipment`
`ReturnShippedItem`
`RithumAPIKey`
`Seller`
`SellerStats`
`SeoContent`
`Shipment`
`ShipmentCarrier`
`ShipmentStatus`
`ShippedItem`
`ShippingOption`
`ShippingParcel`
`ShippingProfile`
`ShippingRate`
`ShippingZone`
`SizeMatrix`
`State`
`Taxon`
`UnpublishedAdvert`
`Variant`
`VariantOptionValue`
`Webhook`
`WebhookEvent`
`WebhookEventResponse`

Example

{"id": "4"}

Types

OptionType

Description

An advert's option type (e.g. colour, size, shape).

Fields

Field Name	Description
`appliedTo` - `AppliedToEnum!`
`category` - `PurposeEnum!`	This field is deprecated. Use appliedTo and fieldType instead.
`description` - `String!`
`displayName` - `String!`
`externalIds` - `[ExternalID!]!`
`fieldType` - `FieldTypeEnum!`
`id` - `ID!`
`legacyId` - `Int!`	This is the ID stored in the Marketplacer database.
`name` - `String!`	The name of the option type, mostly for internal organisation.
`optionValues` - `OptionValuesConnection`
Arguments `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.
`optional` - `Boolean!`
`position` - `Int!`	In which position to put the option when displayed in a list of options.
`presentation` - `String`
`prototypes` - `PrototypesConnection!`
Arguments `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

{
  "appliedTo": "ADVERT",
  "category": "VARIANT",
  "description": "xyz789",
  "displayName": "abc123",
  "externalIds": [ExternalID],
  "fieldType": "SINGLE_SELECT",
  "id": "4",
  "legacyId": 987,
  "name": "xyz789",
  "optionValues": OptionValuesConnection,
  "optional": true,
  "position": 987,
  "presentation": "abc123",
  "prototypes": PrototypesConnection
}

Types

OptionTypeCreateOrUpdateMutationInput

Description

Autogenerated input type of OptionTypeCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the OptionType to update
`prototypeIds` - `[ID!]`	ID for associated Prototypes. Note: Making changes to prototypes (e.g. adding/removing option types) may cause related products to become undisplayable
`prototypeIdsToRemove` - `[ID!]`	ID for associated Prototypes we want to remove. Note: Making changes to prototypes (e.g. adding/removing option types) may cause related products to become undisplayable
`name` - `String`	Name for the OptionType - eg. 'size'
`displayName` - `String`	How the the OptionType should be displayed publically - eg. 'Size'
`optional` - `Boolean`	Is the option type optional?. Note: Changing an existing option type from optional to required may cause related products to become undisplayable. When this value is not provided, true will be set for advert single_select and advert free_text option types. For other types, false will be set
`category` - `PurposeEnum`	DEPRECATED: This field is deprecated. Use appliedTo and fieldType instead. Specifies the purpose of the option type i.e how it relates to either the advert or variant. Default = `null`
`appliedTo` - `AppliedToEnum`	Where the option type is applied, which can only be on either variant or advert level. This value cannot be changed to existing option types. Default = `null`
`fieldType` - `FieldTypeEnum`	The character of the option type on how option values are stored. This value cannot be changed to existing option types. Default = `null`
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch Prototypes

Example

{
  "clientMutationId": "xyz789",
  "id": 4,
  "prototypeIds": [4],
  "prototypeIdsToRemove": [4],
  "name": "xyz789",
  "displayName": "abc123",
  "optional": false,
  "category": "VARIANT",
  "appliedTo": "ADVERT",
  "fieldType": "SINGLE_SELECT",
  "externalIds": [KeyValueInput]
}

Types

OptionTypeCreateOrUpdateMutationPayload

Description

Autogenerated return type of OptionTypeCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`optionType` - `OptionType`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "optionType": OptionType,
  "status": 123
}

Types

OptionTypeFilterOption

Description

Minimal subset of OptionType type which can be used to build an option type filter for advert search

Fields

Field Name	Description
`displayName` - `String!`
`externalIds` - `[ExternalID!]!`
`optionValues` - `[OptionValueFilterOption!]!`	The option values associated with an option type
`position` - `Int!`	In which position to put the option when displayed in a list of options.

Example

{
  "displayName": "abc123",
  "externalIds": [ExternalID],
  "optionValues": [OptionValueFilterOption],
  "position": 123
}

Types

OptionTypesConnection

Description

The connection type for OptionType.

Fields

Field Name	Description
`edges` - `[OptionTypesEdge]`	A list of edges.
`nodes` - `[OptionType]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [OptionTypesEdge],
  "nodes": [OptionType],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

OptionTypesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `OptionType`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": OptionType
}

Types

OptionValue

Description

Option value for an advert's option type (e.g. 'red', 'large')

Fields

Field Name	Description
`displayName` - `String!`
`externalIds` - `[ExternalID!]`
`id` - `ID!`
`legacyId` - `Int!`	This is the ID stored in the Marketplacer database.
`name` - `String!`
`optionType` - `OptionType`
`position` - `Int!`	In which position to put the option when displayed in a list of options.
`presentation` - `String!`	As of August 2020, deprecated in favour of 'displayName' This will be removed in January 2021.

Example

{
  "displayName": "xyz789",
  "externalIds": [ExternalID],
  "id": "4",
  "legacyId": 987,
  "name": "abc123",
  "optionType": OptionType,
  "position": 123,
  "presentation": "xyz789"
}

Types

OptionValueConnection

Description

The connection type for OptionValue.

Fields

Field Name	Description
`edges` - `[OptionValueEdge]`	A list of edges.
`nodes` - `[OptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [OptionValueEdge],
  "nodes": [OptionValue],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

OptionValueCreateOrUpdateMutationInput

Description

Autogenerated input type of OptionValueCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the OptionValue to update
`name` - `String`	Name for the new OptionValue
`displayName` - `String`	Presentation for the new OptionValue
`optionTypeId` - `ID`	ID for parent OptionType. eg. if this OptionValue is 'Orange', the parent OptionType might be 'Colour' or 'Flavour'
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch OptionValues
`position` - `Int`	A zero based index specifying the sort order in which the Option Values will be displayed (zero first)

Example

{
  "clientMutationId": "xyz789",
  "id": "4",
  "name": "xyz789",
  "displayName": "abc123",
  "optionTypeId": 4,
  "externalIds": [KeyValueInput],
  "position": 987
}

Types

OptionValueCreateOrUpdateMutationPayload

Description

Autogenerated return type of OptionValueCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`optionValue` - `OptionValue`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "optionValue": OptionValue,
  "status": 123
}

Types

OptionValueDeleteMutationInput

Description

Autogenerated input type of OptionValueDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the OptionValue to update

Example

{"clientMutationId": "abc123", "id": 4}

Types

OptionValueDeleteMutationPayload

Description

Autogenerated return type of OptionValueDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`optionValue` - `OptionValue`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "optionValue": OptionValue,
  "status": 987
}

Types

OptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `OptionValue`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": OptionValue
}

Types

OptionValueFilterOption

Description

Minimal subset of OptionValue type which can be used as a value of an option type filter for advert search

Fields

Field Name	Description
`displayName` - `String!`
`id` - `ID!`
`optionType` - `OptionType!`
`position` - `Int!`	In which position to put the option when displayed in a list of options.

Example

{
  "displayName": "xyz789",
  "id": "4",
  "optionType": OptionType,
  "position": 987
}

Types

OptionValuesConnection

Description

The connection type for OptionValue.

Fields

Field Name	Description
`edges` - `[OptionValuesEdge]`	A list of edges.
`nodes` - `[OptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [OptionValuesEdge],
  "nodes": [OptionValue],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

OptionValuesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `OptionValue`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": OptionValue
}

Types

OptionalOptionValue

Fields

Field Name	Description
`id` - `ID!`	ID of the object.
`optionType` - `OptionType!`
`optionValue` - `OptionValue`

Example

{
  "id": 4,
  "optionType": OptionType,
  "optionValue": OptionValue
}

Types

OptionalOptionValueConnection

Description

The connection type for OptionalOptionValue.

Fields

Field Name	Description
`edges` - `[OptionalOptionValueEdge]`	A list of edges.
`nodes` - `[OptionalOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [OptionalOptionValueEdge],
  "nodes": [OptionalOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

OptionalOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `OptionalOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": OptionalOptionValue
}

Types

Order

Description

A cart that has turned into an immutable order.

Fields

Field Name	Description
`address` - `Address`
`aggregateInvoiceStatus` - `InvoiceStatusEnum`	A displayable string which summarises the status of the invoices
`aggregateInvoiceStatusFinal` - `Boolean`	All invoices are in final state: eg. sent / collected / cancelled
`billingAddress` - `Address`
`billingBusinessRegistrationCode` - `String`
`billingCompanyName` - `String`
`billingEmailAddress` - `String`
`billingFirstName` - `String`
`billingPhone` - `String`
`billingSurname` - `String`
`cartId` - `ID`	ID of the cart that was converted into this order.
`companyName` - `String`
`createdAt` - `ISO8601DateTime!`
`discountCents` - `Int!`	The discount applied to the order. Negative value. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`discountFormatted` - `String!`	The discount applied to the order. Negative value. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`emailAddress` - `String`
`expectedDeliveryDate` - `ISO8601DateTime`	The expected delivery date selected by the buyer for the order.
`expectedDeliverySlot` - `String`	The expected delivery slot selected by the buyer for the order.
`externalId` - `String`
`externalIds` - `[ExternalID!]!`
`firstName` - `String`
`id` - `ID!`
`invoices` - `InvoiceConnection!`
Arguments `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.
`isGift` - `Boolean`	Is this order a gift order? Defaults to false.
`legacyId` - `Int!`	The id used to identify the order.
`lineItems` - `LineItemConnection!`
Arguments `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.
`messageToGiftRecipient` - `String`	A message that will be sent to the gift recipient.
`messageToSeller` - `String`	Message to the seller.
`metadata` - `[Metadatum!]!`	Metadata key/values
`paymentEvents` - `PaymentEventConnection!`
Arguments `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.
`paymentGatewayDetails` - `JSON`
`paymentInstrumentType` - `String`
`phone` - `String`
`postage` - `Float!`
`purchaseOrderNumber` - `String`
`purgedAt` - `ISO8601DateTime`
`shipments` - `[Shipment!]!`
`shippingCostCents` - `Int!`	The order postage cost. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`shippingCostFormatted` - `String!`	The order postage cost. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`status` - `OrderStatusEnum!`
`subtotal` - `Float!`
`subtotalCents` - `Int!`	The order subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`subtotalFormatted` - `String!`	The order subtotal, excluding discounts and postage. Tax is included for tax inclusive marketplaces. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`surname` - `String`
`taxTotal` - `Float!`
`taxTotalCents` - `Int!`	The tax on the order. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`taxTotalFormatted` - `String!`	The tax on the order. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`token` - `String!`	Required for setting the current order on the checkout page via URL parameter.
`total` - `Float!`
`totalCents` - `Int!`	The order total. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	The order total. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`

Example

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

Types

OrderCreateMutationInput

Description

Autogenerated input type of OrderCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`order` - `OrderInput!`	Attributes for defining the given order.
`invoices` - `[InvoiceInput!]`	Attributes for invoices associated with the given order.
`lineItems` - `[LineItemInput!]`	Attributes of line items associated with this order. LineItems will be split into invoices by seller.
`notifications` - `[OrderCreationNotificationEnum!]`	Notify the order information via Email and SMS. By default, at the moment, it will not send any notifications

Example

{
  "clientMutationId": "xyz789",
  "order": OrderInput,
  "invoices": [InvoiceInput],
  "lineItems": [LineItemInput],
  "notifications": ["EMAIL"]
}

Types

OrderCreateMutationPayload

Description

Autogenerated return type of OrderCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`order` - `Order`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "order": Order,
  "status": 123
}

Types

OrderCreationNotificationEnum

Description

The notification to be sent when an order is created

Values

Enum Value	Description
`EMAIL`	Notify the order information via Email
`SMS`	Notify the order information via SMS

Example

"EMAIL"

Types

OrderHistoryDownloadMutationInput

Description

Autogenerated input type of OrderHistoryDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`format` - `SpreadsheetEnum`
`filters` - `[InvoiceFilters!]`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": "4",
  "format": "XLSX",
  "filters": [InvoiceFilters]
}

Types

OrderHistoryDownloadMutationPayload

Description

Autogenerated return type of OrderHistoryDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 123
}

Types

OrderInput

Description

Attributes for creating or updating an order

Fields

Input Field	Description
`address` - `AddressInput`	The buyer's shipping address for an order.
`billingAddress` - `AddressInput`	The buyer's billing address. If this is left blank, it will default to the shipping address.
`billingCompanyName` - `String`	Name of the company making the order for the purposes of billing if applicable. If this is left blank, it will default to the company name attribute.
`billingEmailAddress` - `String`	The buyer's email address for the purposes of billing. If this is left blank, it will default to the email address attribute.
`billingFirstName` - `String`	The buyer's first name for the purposes of billing. If this is left blank, it will default to the first name attribute.
`billingPhone` - `String`	The buyer's phone number for the purposes of billing. If this is left blank, it will default to the phone number attribute.
`billingSurname` - `String`	The buyer's surname for the purposes of billing. If this is left blank, it will default to the surname attribute.
`billingBusinessRegistrationCode` - `String`	The buyer's billing tax number
`purchaseOrderNumber` - `String`	The buyer's billing purchase order number
`companyName` - `String`	Name of the company making the order if applicable.
`emailAddress` - `String`	The buyer's email address.
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch orders.
`paymentGatewayDetails` - `JSON`	Payment Gateway information.
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`firstName` - `String`	The buyer's first name.
`phone` - `String`	The buyer's phone number.
`surname` - `String`	The buyer's surname.
`termsAndConditionsAccepted` - `Boolean`	Whether the user has accepted the terms and conditions. Only required if the website is configured to require it.
`messageToSeller` - `String`	A message that will be sent to the seller.
`isGift` - `Boolean`	Is this order a gift order? Defaults to false.
`messageToGiftRecipient` - `String`	A message that will be sent to the gift recipient.
`notes` - `String`	A note that will appear on every invoice for this order.

Example

{
  "address": AddressInput,
  "billingAddress": AddressInput,
  "billingCompanyName": "xyz789",
  "billingEmailAddress": "xyz789",
  "billingFirstName": "xyz789",
  "billingPhone": "abc123",
  "billingSurname": "xyz789",
  "billingBusinessRegistrationCode": "xyz789",
  "purchaseOrderNumber": "xyz789",
  "companyName": "abc123",
  "emailAddress": "abc123",
  "externalIds": [KeyValueInput],
  "paymentGatewayDetails": {},
  "metadata": [KeyValueInput],
  "firstName": "xyz789",
  "phone": "xyz789",
  "surname": "abc123",
  "termsAndConditionsAccepted": true,
  "messageToSeller": "abc123",
  "isGift": false,
  "messageToGiftRecipient": "xyz789",
  "notes": "abc123"
}

Types

OrderStatusEnum

Description

The current status of an order.

Values

Enum Value	Description
`NEW`	An order that has been created but not paid for
`CHECKOUT`	An order that has progressed to the checkout page, but not been paid for
`ABANDONED`	An order that has been manually marked as 'abandoned' by an Admin
`COMPLETE`	An order that has been successfully completed.
`PAYMENT_FAILED`	An order that is complete, but with a failed payment.
`PAYMENT_IN_PROGRESS`	An order that is complete, but whose payment hasn't been finalised (e.g. a direct debit payment waiting on confirmation from the bank).
`PENDING_REVIEW`	An order that is pending fraud review

Example

"NEW"

Types

OrderUpdateInput

Description

Attributes for updating an order

Fields

Input Field	Description
`address` - `AddressInput`	The buyer's shipping address for an order.
`billingAddress` - `AddressInput`	The buyer's billing address. If this is left blank, it will default to the shipping address.
`billingCompanyName` - `String`	Name of the company making the order for the purposes of billing if applicable. If this is left blank, it will default to the company name attribute.
`billingEmailAddress` - `String`	The buyer's email address for the purposes of billing. If this is left blank, it will default to the email address attribute.
`billingFirstName` - `String`	The buyer's first name for the purposes of billing. If this is left blank, it will default to the first name attribute.
`billingPhone` - `String`	The buyer's phone number for the purposes of billing. If this is left blank, it will default to the phone number attribute.
`billingSurname` - `String`	The buyer's surname for the purposes of billing. If this is left blank, it will default to the surname attribute.
`billingBusinessRegistrationCode` - `String`	The buyer's billing tax number
`purchaseOrderNumber` - `String`	The buyer's billing purchase order number
`companyName` - `String`	Name of the company making the order if applicable.
`emailAddress` - `String`	The buyer's email address.
`firstName` - `String`	The buyer's first name.
`phone` - `String`	The buyer's phone number.
`surname` - `String`	The buyer's surname.
`messageToSeller` - `String`	A message that will be sent to the seller.

Example

{
  "address": AddressInput,
  "billingAddress": AddressInput,
  "billingCompanyName": "abc123",
  "billingEmailAddress": "xyz789",
  "billingFirstName": "xyz789",
  "billingPhone": "xyz789",
  "billingSurname": "abc123",
  "billingBusinessRegistrationCode": "abc123",
  "purchaseOrderNumber": "abc123",
  "companyName": "xyz789",
  "emailAddress": "xyz789",
  "firstName": "xyz789",
  "phone": "xyz789",
  "surname": "abc123",
  "messageToSeller": "abc123"
}

Types

OrderUpdateMutationInput

Description

Autogenerated input type of OrderUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`orderId` - `ID!`	ID for retrieving the correct cart.
`status` - `OrderStatusEnum!`	Current status that the order should be set to.
`paymentGatewayDetails` - `JSON`	Updated details for the payment gateway.
`attributes` - `OrderUpdateInput`	Attributes updates for the given order.

Example

{
  "clientMutationId": "abc123",
  "orderId": 4,
  "status": "NEW",
  "paymentGatewayDetails": {},
  "attributes": OrderUpdateInput
}

Types

OrderUpdateMutationPayload

Description

Autogenerated return type of OrderUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`order` - `Order`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "order": Order,
  "status": 123
}

Types

PageInfo

Description

Information about pagination in a connection.

Fields

Field Name	Description
`endCursor` - `String`	When paginating forwards, the cursor to continue.
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `String`	When paginating backwards, the cursor to continue.

Example

{
  "endCursor": "abc123",
  "hasNextPage": false,
  "hasPreviousPage": true,
  "startCursor": "abc123"
}

Types

PartnerIntegrationToggleEvent

Description

Partner integration toggle enabled or disabled event.

Fields

Field Name	Description
`category` - `String!`
`emailId` - `Int`
`enabled` - `Boolean!`
`providerHandle` - `String!`

Example

{
  "category": "xyz789",
  "emailId": 123,
  "enabled": true,
  "providerHandle": "xyz789"
}

Types

PartnerIntegrationToggleEventCreateMutationInput

Description

Autogenerated input type of PartnerIntegrationToggleEventCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`partnerIntegrationToggleEvent` - `PartnerIntegrationToggleEventInput!`	Properties for partner integration toggle event creation.

Example

{
  "clientMutationId": "abc123",
  "partnerIntegrationToggleEvent": PartnerIntegrationToggleEventInput
}

Types

PartnerIntegrationToggleEventCreateMutationPayload

Description

Autogenerated return type of PartnerIntegrationToggleEventCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`partnerIntegrationToggleEvent` - `PartnerIntegrationToggleEvent`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "partnerIntegrationToggleEvent": PartnerIntegrationToggleEvent,
  "status": 987
}

Types

PartnerIntegrationToggleEventInput

Description

Properties for partner integration toggle event creation.

Fields

Input Field	Description
`category` - `String!`	Partner integration category.
`providerHandle` - `String!`	Partner integration provider handle.
`enabled` - `Boolean!`	Whether the partner integration was enabled or disabled

Example

{
  "category": "xyz789",
  "providerHandle": "abc123",
  "enabled": false
}

Types

PasswordResetMutationInput

Description

Autogenerated input type of PasswordResetMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`resetPasswordNonce` - `String!`
`password` - `String!`
`passwordConfirmation` - `String!`

Example

{
  "clientMutationId": "abc123",
  "resetPasswordNonce": "abc123",
  "password": "xyz789",
  "passwordConfirmation": "xyz789"
}

Types

PasswordResetMutationPayload

Description

Autogenerated return type of PasswordResetMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

PaymentEvent

Description

Payment Event

Fields

Field Name	Description
`amount` - `String`
`id` - `ID!`
`paymentInstrumentType` - `String`
`responseMessage` - `String`
`successful` - `Boolean!`
`transactionId` - `String`

Example

{
  "amount": "xyz789",
  "id": "4",
  "paymentInstrumentType": "xyz789",
  "responseMessage": "abc123",
  "successful": true,
  "transactionId": "xyz789"
}

Types

PaymentEventConnection

Description

The connection type for PaymentEvent.

Fields

Field Name	Description
`edges` - `[PaymentEventEdge]`	A list of edges.
`nodes` - `[PaymentEvent]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [PaymentEventEdge],
  "nodes": [PaymentEvent],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

PaymentEventEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `PaymentEvent`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": PaymentEvent
}

Types

PaymentMethod

Description

Payment method.

Fields

Field Name	Description
`id` - `ID!`
`method` - `String`
`provider` - `String`
`purpose` - `String`

Example

{
  "id": "4",
  "method": "xyz789",
  "provider": "abc123",
  "purpose": "xyz789"
}

Types

PaymentMethodCreateMutationInput

Description

Autogenerated input type of PaymentMethodCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`paymentMethodAttributes` - `PaymentMethodInput!`	Payment method attributes.

Example

{
  "clientMutationId": "xyz789",
  "paymentMethodAttributes": PaymentMethodInput
}

Types

PaymentMethodCreateMutationPayload

Description

Autogenerated return type of PaymentMethodCreateMutation.

Fields

Field Name	Description
`braintreeBillingSettings` - `BraintreeBillingSettings`	Braintree settings for billing
`braintreeEcommerceSettings` - `BraintreeEcommerceSettings`	Braintree settings for ecommerce
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`paymentMethod` - `PaymentMethod`
`status` - `Int!`

Example

{
  "braintreeBillingSettings": BraintreeBillingSettings,
  "braintreeEcommerceSettings": BraintreeEcommerceSettings,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "paymentMethod": PaymentMethod,
  "status": 987
}

Types

PaymentMethodDeleteMutationInput

Description

Autogenerated input type of PaymentMethodDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the existing payment method.

Example

{"clientMutationId": "xyz789", "id": 4}

Types

PaymentMethodDeleteMutationPayload

Description

Autogenerated return type of PaymentMethodDeleteMutation.

Fields

Field Name	Description
`braintreeBillingSettings` - `BraintreeBillingSettings`	Braintree settings for billing
`braintreeEcommerceSettings` - `BraintreeEcommerceSettings`	Braintree settings for ecommerce
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`paymentMethod` - `PaymentMethod`
`status` - `Int!`

Example

{
  "braintreeBillingSettings": BraintreeBillingSettings,
  "braintreeEcommerceSettings": BraintreeEcommerceSettings,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "paymentMethod": PaymentMethod,
  "status": 123
}

Types

PaymentMethodEnum

Description

All available payment method.

Values

Enum Value	Description
`CREDIT_CARD`
`CREDIT_CARD_OR_PAYPAL`
`DIRECT_DEBIT`
`PRE_PAID`
`DO_NOT_BILL`
`PAYPAL`
`AFTERPAY`
`BALOTO`
`EFECTY`
`BANK_REFERENCED`
`SU_RED`
`GIFT_CARDS`
`OTHERS`
`ZIP`
`BANK_TRANSFER`

Example

"CREDIT_CARD"

Types

PaymentMethodInput

Description

Properties for payment method creation.

Fields

Input Field	Description
`purpose` - `PaymentProviderPurposeEnum!`	The purpose of the transaction. Can be either ECOMMERCE or BILLING
`paymentMethod` - `PaymentMethodEnum!`	The payment method used to pay for an order.
`provider` - `ProviderEnum!`	The payment provider

Example

{"purpose": "BILLING", "paymentMethod": "CREDIT_CARD", "provider": "BRAINTREE"}

Types

PaymentProviderEnum

Description

All available payment providers for checkout.

Values

Enum Value	Description
`BRAINTREE`
`AFTERPAY`

Example

"BRAINTREE"

Types

PaymentProviderInput

Description

Properties from a payment provider.

Fields

Input Field	Description
`paymentNonce` - `String`	The nonce received from a payment provider. Required for checking out with Braintree.
`deviceData` - `String`	Device data increases the accuracy of Braintree's available advanced fraud management tools in determining when a transaction is fraudulent.
`redirectConfirmationUrl` - `String`	The redirect_confirmation_url is used to redirect the user back to the platform after successfully approving the transaction
`redirectCancellationUrl` - `String`	The redirect_cancellation_url is used to redirect the user back to the platform when the user cancels the transaction
`paymentProvider` - `PaymentProviderEnum!`	The payment provider used for checking out the cart.
`providerParams` - `JSON`	Data from the payment provider used to capture or finalize a payment.

Example

{
  "paymentNonce": "abc123",
  "deviceData": "abc123",
  "redirectConfirmationUrl": "xyz789",
  "redirectCancellationUrl": "xyz789",
  "paymentProvider": "BRAINTREE",
  "providerParams": {}
}

Types

PaymentProviderPurposeEnum

Description

All available payment purposes.

Values

Enum Value	Description
`BILLING`
`ECOMMERCE`

Example

"BILLING"

Types

PaypalCommerceSettings

Description

Paypal Commerce settings

Fields

Field Name	Description
`category` - `CategoryTypeEnum!`
`creditCardEnabled` - `Boolean!`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`logoUrl` - `String!`
`merchantId` - `String`
`overrideCustomMerchantFee` - `Boolean!`
`paypalEnabled` - `Boolean!`
`providerHandle` - `String!`
`providerName` - `String!`
`status` - `StatusTypeEnum!`
`testModeEnabled` - `Boolean!`

Example

{
  "category": "RATINGS_AND_REVIEWS",
  "creditCardEnabled": true,
  "customMerchantBaseFeeCents": 987,
  "customMerchantBaseFeeFormatted": "xyz789",
  "customMerchantFee": 123.45,
  "description": "abc123",
  "logoUrl": "abc123",
  "merchantId": "abc123",
  "overrideCustomMerchantFee": true,
  "paypalEnabled": true,
  "providerHandle": "xyz789",
  "providerName": "abc123",
  "status": "AVAILABLE",
  "testModeEnabled": true
}

Types

PaypalCommerceSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of PaypalCommerceSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantId` - `String!`	PayPal Commerce merchant ID.
`testModeEnabled` - `Boolean`
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.

Example

{
  "clientMutationId": "xyz789",
  "merchantId": "xyz789",
  "testModeEnabled": true,
  "overrideCustomMerchantFee": false,
  "customMerchantFee": "xyz789",
  "customMerchantBaseFee": "xyz789"
}

Types

PaypalCommerceSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of PaypalCommerceSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`paypalCommerceSettings` - `PaypalCommerceSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "paypalCommerceSettings": PaypalCommerceSettings,
  "status": 123
}

Types

PaypalCommerceSettingsDeleteMutationInput

Description

Autogenerated input type of PaypalCommerceSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "abc123"}

Types

PaypalCommerceSettingsDeleteMutationPayload

Description

Autogenerated return type of PaypalCommerceSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`paypalCommerceSettings` - `PaypalCommerceSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "paypalCommerceSettings": PaypalCommerceSettings,
  "status": 123
}

Types

Permission

Description

Permission

Fields

Field Name	Description
`displayName` - `String!`
`permission` - `String!`

Example

{
  "displayName": "xyz789",
  "permission": "xyz789"
}

Types

PermissionsByCategory

Description

Permissions by category

Fields

Field Name	Description
`categoryName` - `PermissionsCategoryEnum!`
`children` - `[PermissionsByCategory!]`
`hideCategoryPermissions` - `Boolean!`
`permissions` - `[Permission!]!`

Example

{
  "categoryName": "SELLERS",
  "children": [PermissionsByCategory],
  "hideCategoryPermissions": false,
  "permissions": [Permission]
}

Types

PermissionsCategoryEnum

Description

Permissions category enum

Values

Enum Value	Description
`SELLERS`
`CREATE_AND_MANAGE_SELLERS`
`MANAGE_SELLER_TRADES_AND_RATINGS`
`MANAGE_SELLER_SUBSCRIPTION_BILLINGS`
`INQUIRIES_AND_LEAD_REPORTING`
`ORDERS`
`MANAGE_ORDERS`
`VIEW_ORDERS`
`REFUNDS`
`PRODUCTS`
`SELLER_COMMUNITY`
`MARKETING`
`REPORTING`
`PERFORMANCE_REPORTS`
`REMITTANCE_REPORTS`
`PAYMENTS_AND_BILLINGS_REPORTS`
`PLATFORM_REPORTS`
`MYER_CUSTOM_REPORTS`
`CATEGORISATION`
`MANAGE_OPTION_TYPES`
`CONFIGURATION_AND_SETTINGS`
`MANAGE_MARKETPLACE_CONFIGURATION`
`MANAGE_SHIPPING_SETUP`
`API_AND_WEBHOOKS`
`MANAGE_AUTHENTICATION_SETTINGS`
`USER_MANAGEMENT`
`CREATE_AND_MANAGE_TEAM_MEMBERS`
`SUPER_ADMIN`
`FULLSTACK`
`NOT_IN_USE`

Example

"SELLERS"

Types

PriceBreakdownInput

Fields

Input Field	Description
`lineItemAmount` - `Int!`	Total amount for each item. Denominated in cents.
`lineItemTax` - `Int`	The tax amount on the lineItemAmount. Denominated in cents. Default = `null`
`commissionAmount` - `Int`	The commission component of the lineItemAmount. Denominated in cents. Default = `null`
`commissionTax` - `Int`	The tax amount on the commissionAmount. Denominated in cents. Default = `null`
`remittanceAmount` - `Int`	The remittance component of the lineItemAmount. Denominated in cents. Default = `null`
`remittanceTax` - `Int`	The tax amount on the remittanceAmount. Denominated in cents. Default = `null`
`customLineItemTaxRate` - `Decimal`	Tax rate for the custom line item (for display purposes only). Provide this value alongside lineItemTax. If not provided, it defaults to Marketplace default tax rate.

Example

{
  "lineItemAmount": 987,
  "lineItemTax": 987,
  "commissionAmount": 123,
  "commissionTax": 123,
  "remittanceAmount": 123,
  "remittanceTax": 123,
  "customLineItemTaxRate": Decimal
}

Types

PriceRange

Description

A price range

Fields

Field Name	Description
`max` - `Float!`	Maximum value in the range.
`maxCents` - `Int!`	Maximum value in the range, as cents for accuracy.
`maxFormatted` - `String!`	Maximum value in the range, formatted in the given currency.
`maxInSessionCurrency` - `String!`	Maximum value in the range in session currency.
`min` - `Float!`	Minimum value in the range.
`minCents` - `Int!`	Minimum value in the range, as cents for accuracy.
`minFormatted` - `String!`	Minimum value in the range, formatted in the given currency.
`minInSessionCurrency` - `String!`	Minimum value in the range in session currency.

Example

{
  "max": 123.45,
  "maxCents": 123,
  "maxFormatted": "xyz789",
  "maxInSessionCurrency": "xyz789",
  "min": 987.65,
  "minCents": 987,
  "minFormatted": "abc123",
  "minInSessionCurrency": "abc123"
}

Types

PricingModelEnum

Description

The variant pricing model

Values

Enum Value	Description
`MARKETPLACE`	Marketplace pricing model
`WHOLESALE`	Wholesale pricing model

Example

"MARKETPLACE"

Types

ProcessPaymentGatewayRedirectMutationInput

Description

Autogenerated input type of ProcessPaymentGatewayRedirectMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`paymentProviderRedirectConfirmationAttributes` - `RedirectConfirmationInput!`	Attributes required by a payment provider to process a payment.

Example

{
  "clientMutationId": "xyz789",
  "paymentProviderRedirectConfirmationAttributes": RedirectConfirmationInput
}

Types

ProcessPaymentGatewayRedirectMutationPayload

Description

Autogenerated return type of ProcessPaymentGatewayRedirectMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`order` - `Order`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "order": Order,
  "status": 987
}

Types

Promotion

Description

A promotion, sale, or special discount.

Fields

Field Name	Description
`advertsExcluded` - `AdvertsConnection`	Adverts excluded from this promotion.
Arguments `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.
`advertsIncluded` - `AdvertsConnection`	Adverts included in this promotion.
Arguments `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.
`brandsExcluded` - `BrandsConnection`	Brands excluded from this promotion.
Arguments `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.
`brandsIncluded` - `BrandsConnection`	Brands included in this promotion.
Arguments `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.
`categoriesExcluded` - `TaxonsConnection`	Categories excluded from this promotion.
Arguments `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.
`categoriesIncluded` - `TaxonsConnection`	Categories included in this promotion.
Arguments `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.
`costPercentageBorneByMarketplace` - `Float!`	Percentage of cost borne by the marketplace.
`description` - `String`	Description of the promotion used for internal reference.
`discountAmount` - `Float`	Amount of the discount. Dollar or percentage value depending on 'discountType'.
`discountType` - `String`	Type of discount. Options available: 'dollar', 'percentage'.
`endDate` - `ISO8601DateTime`	Promotion end date.
`freeShipping` - `Boolean!`	Is free shipping enabled for this promotion?
`freeShippingDomesticOnly` - `Boolean!`	Is free shipping only for domestic orders?
`id` - `ID!`
`loyaltyProgramLevels` - `LoyaltyProgramLevelsConnection`	Loyalty program restriction applied to this promotion.
Arguments `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.
`maximumSpend` - `Float`	Maximum amount over which this promotion will not apply.
`minimumSpend` - `Float`	Minimum amount required to be spent for this promotion to apply.
`name` - `String!`	Name of the promotion - displayed at cart and checkout, order card, invoice.
`saleItemsExcluded` - `Boolean!`	Whether items already on sale are excluded from this promotion.
`seller` - `Seller`	The seller running the promotion.
`startDate` - `ISO8601DateTime`	Promotion start date.
`suspended` - `Boolean!`	Whether the promotion has been suspended.
`teaser` - `String`	Text for use as the "teaser" within a banner or similar.
`teaserText` - `String`	Text for use as the "teaser" within a banner or similar. Use teaser instead
`url` - `String`	URL the Promotion links through to
`variantsExcluded` - `VariantsConnection`	Variants excluded from this promotion.
Arguments `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.
`variantsIncluded` - `VariantsConnection`	Variants included in this promotion.
Arguments `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

{
  "advertsExcluded": AdvertsConnection,
  "advertsIncluded": AdvertsConnection,
  "brandsExcluded": BrandsConnection,
  "brandsIncluded": BrandsConnection,
  "categoriesExcluded": TaxonsConnection,
  "categoriesIncluded": TaxonsConnection,
  "costPercentageBorneByMarketplace": 987.65,
  "description": "xyz789",
  "discountAmount": 987.65,
  "discountType": "abc123",
  "endDate": ISO8601DateTime,
  "freeShipping": false,
  "freeShippingDomesticOnly": false,
  "id": 4,
  "loyaltyProgramLevels": LoyaltyProgramLevelsConnection,
  "maximumSpend": 987.65,
  "minimumSpend": 987.65,
  "name": "xyz789",
  "saleItemsExcluded": true,
  "seller": Seller,
  "startDate": ISO8601DateTime,
  "suspended": false,
  "teaser": "abc123",
  "teaserText": "abc123",
  "url": "abc123",
  "variantsExcluded": VariantsConnection,
  "variantsIncluded": VariantsConnection
}

Types

PromotionInput

Fields

Input Field	Description
`name` - `String!`
`description` - `String`
`startsAt` - `ISO8601DateTime`
`endsAt` - `ISO8601DateTime`
`teaser` - `String`
`suspended` - `Boolean`
`discountType` - `DiscountTypeEnum`	Type of discount. Required if discount_amount is set.
`discountForEvery` - `Float`	Every dollar amount for which discount_amount gets applied to. Required if discount_type set as DOLLAR_REPEATING
`discountAmount` - `Float`
`freeShipping` - `Boolean`
`freeShippingDomesticOnly` - `Boolean`
`url` - `String`
`costPercentageBorneByMarketplace` - `Float`
`saleItemsExcluded` - `Boolean`
`bonusItemAdvertLegacyId` - `Int`
`buyXGetOneFree` - `Int`
`minimumSpend` - `Float`	e.g. '2', for 'Buy 2 get 1 free'
`maximumSpend` - `Float`
`maximumVariantWeight` - `Float`
`maximumVariantVolume` - `Float`
`advertsIncludedLegacyIds` - `[Int!]`
`advertsExcludedLegacyIds` - `[Int!]`
`variantsIncludedLegacyIds` - `[Int!]`
`variantsExcludedLegacyIds` - `[Int!]`
`loyaltyProgramLevels` - `[ID!]`
`brandsIncludedIds` - `[ID!]`
`brandsExcludedIds` - `[ID!]`
`categoriesIncludedIds` - `[ID!]`
`categoriesExcludedIds` - `[ID!]`

Example

{
  "name": "abc123",
  "description": "abc123",
  "startsAt": ISO8601DateTime,
  "endsAt": ISO8601DateTime,
  "teaser": "xyz789",
  "suspended": true,
  "discountType": "DOLLAR",
  "discountForEvery": 987.65,
  "discountAmount": 987.65,
  "freeShipping": false,
  "freeShippingDomesticOnly": false,
  "url": "xyz789",
  "costPercentageBorneByMarketplace": 123.45,
  "saleItemsExcluded": false,
  "bonusItemAdvertLegacyId": 987,
  "buyXGetOneFree": 123,
  "minimumSpend": 987.65,
  "maximumSpend": 123.45,
  "maximumVariantWeight": 123.45,
  "maximumVariantVolume": 987.65,
  "advertsIncludedLegacyIds": [987],
  "advertsExcludedLegacyIds": [987],
  "variantsIncludedLegacyIds": [987],
  "variantsExcludedLegacyIds": [987],
  "loyaltyProgramLevels": [4],
  "brandsIncludedIds": [4],
  "brandsExcludedIds": ["4"],
  "categoriesIncludedIds": ["4"],
  "categoriesExcludedIds": ["4"]
}

Types

PromotionUpsertMutationInput

Description

Autogenerated input type of PromotionUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`promotionId` - `ID`
`sellerId` - `ID`
`attributes` - `PromotionInput!`	Attributes to assign to the promotion.

Example

{
  "clientMutationId": "abc123",
  "promotionId": 4,
  "sellerId": "4",
  "attributes": PromotionInput
}

Types

PromotionUpsertMutationPayload

Description

Autogenerated return type of PromotionUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`promotion` - `Promotion`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "promotion": Promotion,
  "status": 987
}

Types

PromotionsConnection

Description

The connection type for Promotion.

Fields

Field Name	Description
`edges` - `[PromotionsEdge]`	A list of edges.
`nodes` - `[Promotion]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [PromotionsEdge],
  "nodes": [Promotion],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

PromotionsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Promotion`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Promotion
}

Types

Prototype

Description

Prototypes contain the attributes from which all Adverts in a Category inherit eg. Clothing

Fields

Field Name	Description
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`name` - `String!`	Name of the Prototype, eg. Bikes
`optionTypes` - `OptionTypesConnection!`
Arguments `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

{
  "externalIds": [ExternalID],
  "id": 4,
  "name": "xyz789",
  "optionTypes": OptionTypesConnection
}

Types

PrototypeCreateOrUpdateMutationInput

Description

Autogenerated input type of PrototypeCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the Prototype to update
`name` - `String`	Name for the new Prototype
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch Prototypes

Example

{
  "clientMutationId": "abc123",
  "id": 4,
  "name": "xyz789",
  "externalIds": [KeyValueInput]
}

Types

PrototypeCreateOrUpdateMutationPayload

Description

Autogenerated return type of PrototypeCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`prototype` - `Prototype`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "prototype": Prototype,
  "status": 123
}

Types

PrototypesConnection

Description

The connection type for Prototype.

Fields

Field Name	Description
`edges` - `[PrototypesEdge]`	A list of edges.
`nodes` - `[Prototype]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [PrototypesEdge],
  "nodes": [Prototype],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

PrototypesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Prototype`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Prototype
}

Types

ProviderEnum

Description

All available payment providers.

Values

Enum Value	Description
`BRAINTREE`
`EPAYCO`
`AFTERPAY`
`ADYEN_CREDIT_CARD`
`ADYEN_DIRECT_DEBIT`
`ZOOZ_CREDIT_CARD`
`ZOOZ_BANK_TRANSFER`
`ZOOZ_CASH_BALOTO`
`ZOOZ_CASH_EFECTY`
`ZOOZ_CASH_BANK_REFERENCED`
`ZOOZ_CASH_SU_RED`
`GIVEX_GIFT_CARD`
`ZIP_CO`
`EXTERNAL`
`PAYPAL_COMMERCE_CREDIT_CARD`
`PAYPAL_COMMERCE_PAYPAL`
`PRE_PAID`
`DO_NOT_BILL`

Example

"BRAINTREE"

Types

Purchasable

Description

A product, service, event ticket, reservation, etc. that can be purchased or hired.

Types

Union Types
`Variant`

Example

Variant

Types

PurgeOrderDataMutationInput

Description

Autogenerated input type of PurgeOrderDataMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`orderIds` - `[ID!]!`	Orders to act upon. Note individual errors can fail and will cause them to be returned in the errors
`purgeOrderDetails` - `Boolean`	Purge (clear) PII data directly on the order: user, address, billing_address, email_address, first_name, surname, phone, company_name, billing_email_address billing_phone, billing_first_name, billing_surname, billing_company_name, ip_address identity_document_number and date_of_birth. Default = `true`
`purgeNotes` - `Boolean`	Purge (clear) note data at several levels. "Note" on both the order directly and associated shipments. Set "content" on invoice annotations to "purged" (can't be blank). Remove receipt attachments on refund requests and attachments on return shipments and refund request notes (as well as "note"). Remove "reason" and "denyRefundReason" on the refund request line items, as well as "note" and "attachments" on the associated RefundRequestNote. Default = `false`
`purgeMetadata` - `Boolean`	Purge (clear) all of the metadata on the order and associated invoice, lineItem, shipment objects (Note: not any other associated objects). Default = `false`
`purgeExternalIds` - `Boolean`	Purge (clear) all of the externalIds on the order and associated invoice, lineItem, shipment objects (Note: not any other associated objects). Default = `false`

Example

{
  "clientMutationId": "xyz789",
  "orderIds": ["4"],
  "purgeOrderDetails": false,
  "purgeNotes": false,
  "purgeMetadata": false,
  "purgeExternalIds": true
}

Types

PurgeOrderDataMutationPayload

Description

Autogenerated return type of PurgeOrderDataMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

PurposeEnum

Description

The category of the option type. Mostly for validating associated adverts.

Values

Enum Value	Description
`VARIANT`	For advert variants that users can select to indicate which product options they want.
`FEATURE`	Mandatory option types for the given advert type. Fixed for the associated advert (i.e. users cannot select different variants)
`PRODUCT_DETAILS_TEXT`	Similar to PRODUCT_DETAILS_SELECT, except the seller can enter any label rather than selecting from a fixed list of values.
`PRODUCT_DETAILS_SELECT`	Similar to FEATURE option types, except not mandatory.
`OTHER`	Returns OTHER if there is no purpose given

Example

"VARIANT"

Types

RankedResult

Description

RankedResult records - force first adverts for category/brand

Fields

Field Name	Description
`advertIds` - `[Int!]!`
`adverts` - `[Advert!]!`
`brand` - `Brand`
`brandId` - `Int`
`id` - `ID!`
`taxon` - `Taxon`
`taxonId` - `Int`

Example

{
  "advertIds": [987],
  "adverts": [Advert],
  "brand": Brand,
  "brandId": 987,
  "id": 4,
  "taxon": Taxon,
  "taxonId": 987
}

Types

RankedResultDeleteMutationInput

Description

Autogenerated input type of RankedResultDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the existing ranked result. Set blank to create a new one.

Example

{
  "clientMutationId": "xyz789",
  "id": "4"
}

Types

RankedResultDeleteMutationPayload

Description

Autogenerated return type of RankedResultDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`rankedResult` - `RankedResult`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "rankedResult": RankedResult,
  "status": 987
}

Types

RankedResultUpsertMutationInput

Description

Autogenerated input type of RankedResultUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the existing ranked result. Set blank to create a new one.
`brandId` - `Int`	Integer ID for the brand
`taxonId` - `Int`	Integer ID for the taxon
`advertIds` - `[Int!]!`	Integer IDs for the adverts (in order)

Example

{
  "clientMutationId": "abc123",
  "id": 4,
  "brandId": 123,
  "taxonId": 123,
  "advertIds": [987]
}

Types

RankedResultUpsertMutationPayload

Description

Autogenerated return type of RankedResultUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`rankedResult` - `RankedResult`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "rankedResult": RankedResult,
  "status": 123
}

Types

RankedResultsConnection

Description

The connection type for RankedResult.

Fields

Field Name	Description
`edges` - `[RankedResultsEdge]`	A list of edges.
`nodes` - `[RankedResult]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RankedResultsEdge],
  "nodes": [RankedResult],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

RankedResultsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RankedResult`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": RankedResult
}

Types

RatingFilterOption

Description

Minimal subset of Rating type which can be used to build a rating filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with each rating filter option
`name` - `String!`

Example

{"count": 123, "name": "xyz789"}

Types

Redirect

Description

All redirects for the marketplace

Fields

Field Name	Description
`businessName` - `String!`
`id` - `ID!`
`newPath` - `String!`	New redirect path
`oldPath` - `String!`	Original path
`temporary` - `Boolean!`	True if the redirect is temporary

Example

{
  "businessName": "abc123",
  "id": 4,
  "newPath": "abc123",
  "oldPath": "xyz789",
  "temporary": true
}

Types

RedirectConfirmationInput

Description

Properties for only redirect confirmation payment provider.

Fields

Input Field	Description
`paymentProvider` - `PaymentProviderEnum!`	The payment provider used to pay for the order
`orderToken` - `String!`	The token that is generated by a payment provider

Example

{
  "paymentProvider": "BRAINTREE",
  "orderToken": "xyz789"
}

Types

RedirectConnection

Description

The connection type for Redirect.

Fields

Field Name	Description
`edges` - `[RedirectEdge]`	A list of edges.
`nodes` - `[Redirect]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RedirectEdge],
  "nodes": [Redirect],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

RedirectEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Redirect`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Redirect
}

Types

RefundReason

Fields

Field Name	Description
`denyRefundReasons` - `[String!]!`
`id` - `ID!`
`postDispatchRefundReasons` - `[String!]!`
`preDispatchRefundReasons` - `[String!]!`

Example

{
  "denyRefundReasons": ["abc123"],
  "id": 4,
  "postDispatchRefundReasons": ["abc123"],
  "preDispatchRefundReasons": ["abc123"]
}

Types

RefundRequest

Description

Refund requests associated with an invoice

Fields

Field Name	Description
`cashAmountCents` - `Int`	The amount of cash refunded (could also include credit card or afterpay). Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`cashAmountFormatted` - `String`	The amount of cash refunded (could also include credit card or afterpay). In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountTotalCents` - `Int`	The total refund value of the commission within this refund request. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountTotalFormatted` - `String`	The total refund value of the commission within this refund request. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionTaxTotalCents` - `Int`	The total value of the tax on the commissionAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionTaxTotalFormatted` - `String`	The total value of the tax on the commissionAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`createdAt` - `ISO8601DateTime!`	The timestamp at which this refund request was created.
`externalIds` - `[ExternalID!]!`
`giftCardAmountCents` - `Int`	The amount to be refunded to gift cards. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`giftCardAmountFormatted` - `String`	The amount to be refunded to gift cards. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`id` - `ID!`
`initiatedBy` - `RefundRequestInitiatorEnum`	The initiator of this refund request.
`invoice` - `Invoice!`	The invoice to which this refund request refers.
`legacyId` - `Int!`	The id used to identify the refund request.
`lineItemAmountTotalCents` - `Int`	The total refund value of the item/s within this refund request. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemAmountTotalFormatted` - `String`	The total refund value of the item/s within this refund request. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItemTaxTotalCents` - `Int`	The total value of the tax on the lineItemAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemTaxTotalFormatted` - `String`	The total value of the tax on the lineItemAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItems` - `[RefundRequestLineItem!]!`	Line items for which this refund is being requested.
`metadata` - `[Metadatum!]!`	Metadata key/values
`notes` - `[RefundRequestNote!]!`	Notes associated with this refund request.
`receipts` - `[Image!]!`	Receipts for the refund (e.g. screenshots from payment provider portal, etc.) Attachments should be added via RefundRequestNote.attachments. This field will be removed on 2022-12-15.
`recoveredAmountCents` - `Int`	The amount that will be recovered from the retailer. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`recoveredAmountFormatted` - `String`	The amount that will be recovered from the retailer. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`refundAmountCents` - `Int`	The total amount to be refunded to the customer. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`refundAmountFormatted` - `String`	The total amount to be refunded to the customer. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`refundedAt` - `ISO8601DateTime`	The timestamp at which this refund request was refunded to the customer (can be nil).
`remittanceAmountTotalCents` - `Int`	The total refund value of the remittance within this amendment. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceAmountTotalFormatted` - `String`	The total refund value of the remittance within this amendment. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittanceTaxTotalCents` - `Int`	The total value of the tax on the remittanceAmountTotal. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceTaxTotalFormatted` - `String`	The total value of the tax on the remittanceAmountTotal. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`requestValueCents` - `Int`	The value of the purchased items that are being refunded. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`requestValueFormatted` - `String`	The value of the purchased items that are being refunded. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`returnedConsignments` - `[Image!]!`	Documentation or photos related to the package received. Attachments should be added via RefundRequestNote.attachments. This field will be removed on 2022-12-15.
`shipments` - `[ReturnShipment!]!`	Shipments associated with this refund request.
`status` - `RefundRequestStatusEnum!`	The status of this refund request.
`totalCents` - `Int`	Total amount to be refunded. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String`	Total amount to be refunded. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`updatedAt` - `ISO8601DateTime!`	The timestamp at which this refund request was updated.

Example

{
  "cashAmountCents": 123,
  "cashAmountFormatted": "xyz789",
  "commissionAmountTotalCents": 123,
  "commissionAmountTotalFormatted": "xyz789",
  "commissionTaxTotalCents": 987,
  "commissionTaxTotalFormatted": "abc123",
  "createdAt": ISO8601DateTime,
  "externalIds": [ExternalID],
  "giftCardAmountCents": 123,
  "giftCardAmountFormatted": "xyz789",
  "id": 4,
  "initiatedBy": "ADMIN",
  "invoice": Invoice,
  "legacyId": 987,
  "lineItemAmountTotalCents": 123,
  "lineItemAmountTotalFormatted": "abc123",
  "lineItemTaxTotalCents": 987,
  "lineItemTaxTotalFormatted": "xyz789",
  "lineItems": [RefundRequestLineItem],
  "metadata": [Metadatum],
  "notes": [RefundRequestNote],
  "receipts": [Image],
  "recoveredAmountCents": 987,
  "recoveredAmountFormatted": "abc123",
  "refundAmountCents": 123,
  "refundAmountFormatted": "abc123",
  "refundedAt": ISO8601DateTime,
  "remittanceAmountTotalCents": 123,
  "remittanceAmountTotalFormatted": "xyz789",
  "remittanceTaxTotalCents": 987,
  "remittanceTaxTotalFormatted": "xyz789",
  "requestValueCents": 123,
  "requestValueFormatted": "xyz789",
  "returnedConsignments": [Image],
  "shipments": [ReturnShipment],
  "status": "AWAITING",
  "totalCents": 123,
  "totalFormatted": "xyz789",
  "updatedAt": ISO8601DateTime
}

Types

RefundRequestApproveInput

Fields

Input Field	Description
`refundRequestId` - `ID!`	The ID of the refund request to be approved. Supply only refund requests with status PROCESSED.
`note` - `RefundRequestNoteInput`	An optional input field allowing the storage of both a text string comment and attachments. Default = `null`
`lineItemPriceBreakdowns` - `[RefundRequestLineItemApproveInput!]`	LineItemPriceBreakdowns should be used if you intend to provide a price breakdown for all elements of that line item, otherwise don't supply this object and default values from the original invoice will be used for lineItems that are not provided. Default = `[]`
`newCustomLineItemPriceBreakdowns` - `[RefundRequestCustomLineItemApproveInput!]`	To be used when creating new custom line items that are not associated with an invoice line item. Default = `[]`

Example

{
  "refundRequestId": 4,
  "note": RefundRequestNoteInput,
  "lineItemPriceBreakdowns": [
    RefundRequestLineItemApproveInput
  ],
  "newCustomLineItemPriceBreakdowns": [
    RefundRequestCustomLineItemApproveInput
  ]
}

Types

RefundRequestApproveMutationPayload

Description

Autogenerated return type of RefundRequestApproveMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 123
}

Types

RefundRequestConnection

Description

The connection type for RefundRequest.

Fields

Field Name	Description
`edges` - `[RefundRequestEdge]`	A list of edges.
`nodes` - `[RefundRequest]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RefundRequestEdge],
  "nodes": [RefundRequest],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

RefundRequestCreateMutationInput

Description

Autogenerated input type of RefundRequestCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID!`	ID of the invoice.
`lineItems` - `[RefundRequestLineItemInput!]!`	Line items for which the refund is being requested.
`notes` - `[RefundRequestNoteInput!]!`	Notes on the refund request.
`initiatedBy` - `RefundRequestInitiatorEnum`	Initiator of the refund request. The default value is ADMIN
`externalIds` - `[KeyValueInput!]`	ExternalID (key/value). Default = `[]`
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs. Default = `[]`

Example

{
  "clientMutationId": "abc123",
  "invoiceId": 4,
  "lineItems": [RefundRequestLineItemInput],
  "notes": [RefundRequestNoteInput],
  "initiatedBy": "ADMIN",
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput]
}

Types

RefundRequestCreateMutationPayload

Description

Autogenerated return type of RefundRequestCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 987
}

Types

RefundRequestCustomLineItemApproveInput

Fields

Input Field	Description
`lineItemAmount` - `Int!`	The amount to be refunded to the shopper. Denominated in cents.
`lineItemTax` - `Int`	The tax amount on the lineItemAmount. Denominated in cents. If one is not provided it will be calculated using line_item_amount. Default = `null`
`commissionAmount` - `Int!`	The commission component of the lineItemAmount. Denominated in cents.
`commissionTax` - `Int`	The tax amount on the commissionAmount. Denominated in cents. If one is not provided it will be calculated using commission_amount. Default = `null`
`remittanceAmount` - `Int!`	The remittance component of the lineItemAmount. Denominated in cents.
`remittanceTax` - `Int`	The tax amount on the remittanceAmount. If one is not provided it will be calculated using commission_amount. Default = `null`
`custom` - `String!`	Description of custom refund request line item that is not associated with an invoice line item (to be used only when creating a new custom refund request line item)
`lineItemTaxRate` - `Decimal`	Tax rate for the custom line item (for display purposes only). Provide this value alongside lineItemTax. If not provided, it defaults to Marketplace default tax rate.
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch Prototypes. Default = `[]`

Example

{
  "lineItemAmount": 123,
  "lineItemTax": 987,
  "commissionAmount": 123,
  "commissionTax": 123,
  "remittanceAmount": 123,
  "remittanceTax": 987,
  "custom": "abc123",
  "lineItemTaxRate": Decimal,
  "externalIds": [KeyValueInput]
}

Types

RefundRequestDenyMutationInput

Description

Autogenerated input type of RefundRequestDenyMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestId` - `ID!`	ID of the refund request.
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.

Example

{
  "clientMutationId": "xyz789",
  "refundRequestId": "4",
  "notes": [RefundRequestNoteInput]
}

Types

RefundRequestDenyMutationPayload

Description

Autogenerated return type of RefundRequestDenyMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 123
}

Types

RefundRequestEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RefundRequest`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": RefundRequest
}

Types

RefundRequestFilters

Description

Attributes for filtering refund requests

Fields

Input Field	Description
`legacyId` - `Int`	Refund request with matching marketplacer database ID. Default = `null`
`invoiceLegacyId` - `Int`	Refund request with invoice id matching marketplacer database ID. Default = `null`
`buyerName` - `String`	Refund requests that are linked with a buyer name containing this value. Default = `null`
`buyerEmailAddress` - `String`	Refund requests that are linked with a buyer email address containing this value. Default = `null`
`businessName` - `String`	Refund requests that are linked with this seller business name. Default = `null`
`statuses` - `[RefundRequestStatusEnum!]`	Refund requests with one of these statuses. Default = `null`
`lineItemStatuses` - `[RefundRequestLineItemStatusEnum!]`	Refund requests with ANY line item with one of these statuses. Default = `null`
`invoicePaidAt` - `ISO8601Date`	Refund requests for invoices paid on this date. Default = `null`
`createdSince` - `ISO8601DateTime`	Refund requests created since this time. Default = `null`
`createdUntil` - `ISO8601DateTime`	Refund requests created until this time. Default = `null`
`refundedSince` - `ISO8601DateTime`	Refund requests refunded since this time. Default = `null`
`refundedUntil` - `ISO8601DateTime`	Refund requests refunded until this time. Default = `null`
`remitted` - `Boolean`	Refund requests for remitted invoices. Default = `null`

Example

{
  "legacyId": 123,
  "invoiceLegacyId": 123,
  "buyerName": "xyz789",
  "buyerEmailAddress": "abc123",
  "businessName": "abc123",
  "statuses": ["AWAITING"],
  "lineItemStatuses": ["PENDING_APPROVAL"],
  "invoicePaidAt": ISO8601Date,
  "createdSince": ISO8601DateTime,
  "createdUntil": ISO8601DateTime,
  "refundedSince": ISO8601DateTime,
  "refundedUntil": ISO8601DateTime,
  "remitted": true
}

Types

RefundRequestInitiatorEnum

Description

The initiator of this refund request.

Values

Enum Value	Description
`ADMIN`	A marketplace operator
`SELLER`	A seller on this marketplace
`BUYER`	A shopper at this marketplace

Example

"ADMIN"

Types

RefundRequestLineItem

Description

Line item on a refund request

Fields

Field Name	Description
`amountCents` - `Int!`	Money amount being requested for this refund. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountFormatted` - `String!`	Money amount being requested for this refund. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`amountPerItemCents` - `Int!`	Money amount for each item in this refund. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountPerItemFormatted` - `String!`	Money amount for each item in this refund. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountCents` - `Int`	The refunded value of the commission of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountFormatted` - `String`	The refunded value of the commission of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionTaxCents` - `Int`	The value of the tax on the commissionAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionTaxFormatted` - `String`	The value of the tax on the commissionAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`denyRefundReason` - `String`	The reason of action deny refund
`description` - `String`	Description of refund request line item (used only for custom line items not associated with invoice line items).
`dispatched` - `Boolean`	Does this refer to dispatched or not-yet-dispatched line items?
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`legacyId` - `Int!`
`lineItem` - `LineItem`	Invoice line item for which a refund is being requested.
`lineItemAmountCents` - `Int`	The refunded value of the item/s of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemAmountFormatted` - `String`	The refunded value of the item/s of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`lineItemTaxCents` - `Int`	The value of the tax on the lineItemAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`lineItemTaxFormatted` - `String`	The value of the tax on the lineItemAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`metadata` - `[Metadatum!]!`	Metadata key/values
`notes` - `[RefundRequestNote!]!`	Notes associated with this refund request.
`onlyRemittance` - `Boolean!`	True if this line item only changes the amount to reclaim from the retailer (remittance). Only a marketplace operator can supply this field.
`quantity` - `Int!`	Quantity of the item for which a refund is being requested.
`reason` - `String`	Reason the refund is being requested for this line item.
`refundRequest` - `RefundRequest!`	The refund request for which this is a line item.
`remittanceAmountCents` - `Int`	The refunded value of the remittance of this line item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceAmountFormatted` - `String`	The refunded value of the remittance of this line item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`remittanceTaxCents` - `Int`	The value of the tax on the remittanceAmount. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`remittanceTaxFormatted` - `String`	The value of the tax on the remittanceAmount. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`shipments` - `[ReturnShipment!]!`	Shipments associated with this refund request line item.
`status` - `RefundRequestLineItemStatusEnum!`	The status of this refund request line item

Example

{
  "amountCents": 987,
  "amountFormatted": "xyz789",
  "amountPerItemCents": 123,
  "amountPerItemFormatted": "abc123",
  "commissionAmountCents": 123,
  "commissionAmountFormatted": "abc123",
  "commissionTaxCents": 123,
  "commissionTaxFormatted": "xyz789",
  "denyRefundReason": "xyz789",
  "description": "abc123",
  "dispatched": false,
  "externalIds": [ExternalID],
  "id": "4",
  "legacyId": 123,
  "lineItem": LineItem,
  "lineItemAmountCents": 123,
  "lineItemAmountFormatted": "abc123",
  "lineItemTaxCents": 123,
  "lineItemTaxFormatted": "xyz789",
  "metadata": [Metadatum],
  "notes": [RefundRequestNote],
  "onlyRemittance": true,
  "quantity": 123,
  "reason": "abc123",
  "refundRequest": RefundRequest,
  "remittanceAmountCents": 987,
  "remittanceAmountFormatted": "abc123",
  "remittanceTaxCents": 123,
  "remittanceTaxFormatted": "abc123",
  "shipments": [ReturnShipment],
  "status": "PENDING_APPROVAL"
}

Types

RefundRequestLineItemAcceptMutationInput

Description

Autogenerated input type of RefundRequestLineItemAcceptMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestLineItemId` - `ID!`
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.

Example

{
  "clientMutationId": "xyz789",
  "refundRequestLineItemId": 4,
  "notes": [RefundRequestNoteInput]
}

Types

RefundRequestLineItemAcceptMutationPayload

Description

Autogenerated return type of RefundRequestLineItemAcceptMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequestLineItem` - `RefundRequestLineItem`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "refundRequestLineItem": RefundRequestLineItem,
  "status": 123
}

Types

RefundRequestLineItemApproveInput

Fields

Input Field	Description
`lineItemAmount` - `Int!`	The amount to be refunded to the shopper. Denominated in cents.
`lineItemTax` - `Int`	The tax amount on the lineItemAmount. Denominated in cents. If one is not provided it will be calculated using line_item_amount. Default = `null`
`commissionAmount` - `Int!`	The commission component of the lineItemAmount. Denominated in cents.
`commissionTax` - `Int`	The tax amount on the commissionAmount. Denominated in cents. If one is not provided it will be calculated using commission_amount. Default = `null`
`remittanceAmount` - `Int!`	The remittance component of the lineItemAmount. Denominated in cents.
`remittanceTax` - `Int`	The tax amount on the remittanceAmount. If one is not provided it will be calculated using commission_amount. Default = `null`
`id` - `ID!`	The ID for the refund request line item for refund. Supply only line items with status REFUND_ACCEPTED.

Example

{
  "lineItemAmount": 123,
  "lineItemTax": 987,
  "commissionAmount": 123,
  "commissionTax": 123,
  "remittanceAmount": 123,
  "remittanceTax": 123,
  "id": 4
}

Types

RefundRequestLineItemCreateStatusEnum

Description

The status to start the refund request line item in.

Values

Enum Value	Description
`PENDING_APPROVAL`	When a refund request has been initiated, line items will go to the Pending Approval status. At this state the Seller needs to make a decision on wanting the item shipped back to them.
`AWAITING_RETURN`	The line item will be in this status when a decision has been made to have the item shipped back to the Seller.
`REFUND_ACCEPTED`	The line item will be in this status when a decision has been made to not have the item shipped back to the Seller. The Seller wants a returnless refund.

Example

"PENDING_APPROVAL"

Types

RefundRequestLineItemDenyMutationInput

Description

Autogenerated input type of RefundRequestLineItemDenyMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestLineItemId` - `ID!`
`denyRefundReason` - `String!`	Reason for denying a refund for this line item.
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.

Example

{
  "clientMutationId": "abc123",
  "refundRequestLineItemId": 4,
  "denyRefundReason": "xyz789",
  "notes": [RefundRequestNoteInput]
}

Types

RefundRequestLineItemDenyMutationPayload

Description

Autogenerated return type of RefundRequestLineItemDenyMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequestLineItem` - `RefundRequestLineItem`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "refundRequestLineItem": RefundRequestLineItem,
  "status": 987
}

Types

RefundRequestLineItemInput

Description

Line item on a refund request.

Either a line item ID (which must be a line item from the invoice to which this refund request is related) and a reason OR both custom and amountPerItem must be supplied.

If you supply a line item ID you must supply a reason and cannot supply custom or amountPerItem. You should also supply the dispatched flag: In January 2022 you will be required to supply the dispatched flag in this case.

If you supply custom and amountPerItem then you cannot supply a line item ID, reason or dispatched flag.

Fields

Input Field	Description
`lineItemId` - `ID`	ID of the invoice line item to which this refund request line item refers.
`custom` - `String`	Custom line item (e.g. return postage refund) description.
`amountPerItemCents` - `Int`	Amount per item to be refunded. Denominated in cents.
`reason` - `String`	Reason the refund is being requested for this line item.
`quantity` - `Int!`	Quantity of the item for which a refund is being requested.
`onlyRemittance` - `Boolean`	True if this line item only changes the amount to reclaim from the retailer (remittance). Only a marketplace operator can supply this field.
`dispatched` - `Boolean`	This determines if the line item is a cancellation (not yet shipped) or a return. For a cancellation, mark this as false; For a return, mark this as true
`notes` - `[RefundRequestNoteInput!]`	Notes to create. Default = `[]`
`status` - `RefundRequestLineItemCreateStatusEnum`	The status to start the refund request line item in. Default = `AWAITING_RETURN`
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch Prototypes. Default = `[]`
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs. Default = `[]`

Example

{
  "lineItemId": "4",
  "custom": "xyz789",
  "amountPerItemCents": 123,
  "reason": "abc123",
  "quantity": 987,
  "onlyRemittance": false,
  "dispatched": false,
  "notes": [RefundRequestNoteInput],
  "status": "PENDING_APPROVAL",
  "externalIds": [KeyValueInput],
  "metadata": [KeyValueInput]
}

Types

RefundRequestLineItemReturnMutationInput

Description

Autogenerated input type of RefundRequestLineItemReturnMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestLineItemId` - `ID!`
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.

Example

{
  "clientMutationId": "abc123",
  "refundRequestLineItemId": 4,
  "notes": [RefundRequestNoteInput]
}

Types

RefundRequestLineItemReturnMutationPayload

Description

Autogenerated return type of RefundRequestLineItemReturnMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequestLineItem` - `RefundRequestLineItem`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "refundRequestLineItem": RefundRequestLineItem,
  "status": 987
}

Types

RefundRequestLineItemStatusEnum

Description

The current status of an refund request line item.

Values

Enum Value	Description
`PENDING_APPROVAL`	When a refund request has been initiated, line items will go to the Pending Approval status. At this state the Seller needs to make a decision on wanting the item shipped back to them.
`AWAITING_RETURN`	The line item will be in this status when a decision has been made to have the item shipped back to the Seller.
`REFUND_ACCEPTED`	The line item will be in this status when a decision has been made to not have the item shipped back to the Seller. The Seller wants a returnless refund.
`REFUND_DENIED`	When the Operator denies refunding the line item, then it moves to the Refund denied status.
`REFUNDED`	When the Operator refunds the line item, then it moves to the Refunded status.

Example

"PENDING_APPROVAL"

Types

RefundRequestNote

Description

Note on a refund request

Fields

Field Name	Description
`admin` - `Admin`	The admin who recorded the note.
`attachments` - `[Image!]!`	Receipts, documentation or photos related to the package received.
`id` - `ID!`
`ipAddress` - `String`	IP address of the person adding this note.
`newStatus` - `RefundRequestNoteStatusEnum!`	When this note was recorded, the status that the refund request or refund request line item was transitioned to.
`note` - `String`	Text of the note.
`refundRequest` - `RefundRequest!`	The refund request for which this is a note.
`refundRequestLineItem` - `RefundRequestLineItem`	The refund request line item for which this is a note.
`timestamp` - `ISO8601DateTime!`	Timestamp of when this note was recorded
`user` - `User`	The customer who recorded the note.

Example

{
  "admin": Admin,
  "attachments": [Image],
  "id": 4,
  "ipAddress": "abc123",
  "newStatus": "AWAITING",
  "note": "xyz789",
  "refundRequest": RefundRequest,
  "refundRequestLineItem": RefundRequestLineItem,
  "timestamp": ISO8601DateTime,
  "user": User
}

Types

RefundRequestNoteConnection

Description

The connection type for RefundRequestNote.

Fields

Field Name	Description
`edges` - `[RefundRequestNoteEdge]`	A list of edges.
`nodes` - `[RefundRequestNote]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RefundRequestNoteEdge],
  "nodes": [RefundRequestNote],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

RefundRequestNoteEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RefundRequestNote`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": RefundRequestNote
}

Types

RefundRequestNoteInput

Description

Note on a refund request

Fields

Input Field	Description
`ipAddress` - `String`	IP address of the person adding this note. Will default to the ip address from the request if not submitted. Default = `null`
`note` - `String`	Text of the note.
`userId` - `ID`	The customer who recorded the note. Will default to the user from the API key if not submitted. Default = `null`
`adminId` - `ID`	The admin who recorded the note.
`attachments` - `[ImageInput!]`	Receipts, documentation or photos related to the package received.

Example

{
  "ipAddress": "xyz789",
  "note": "abc123",
  "userId": "4",
  "adminId": "4",
  "attachments": [ImageInput]
}

Types

RefundRequestNoteStatusEnum

Description

The status of the refund request or refund request line item when the refund request note was created.

Values

Enum Value	Description
`AWAITING`	When the refund request is awaiting actions, usually when a line item is in Pending Approval or Awaiting Return status
`RETURNED`
`DENIED`	When all line items in the refund request are in the Refund Denied status
`PROCESSED`	When all line items in the refund request are in the Refund Accepted status
`PENDING_APPROVAL`	When a refund request has been initiated, line items will go to the Pending Approval status. At this state the Seller needs to make a decision on wanting the item shipped back to them.
`AWAITING_RETURN`	The line item will be in this status when a decision has been made to have the item shipped back to the Seller.
`REFUND_ACCEPTED`	The line item will be in this status when a decision has been made to not have the item shipped back to the Seller. The Seller wants a returnless refund.
`REFUND_DENIED`	When the Operator denies refunding the line item, then it moves to the Refund denied status.
`REFUNDED`	When the Operator refunds the line item, then it moves to the Refunded status.

Example

"AWAITING"

Types

RefundRequestRefundMutationInput

Description

Autogenerated input type of RefundRequestRefundMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestId` - `ID!`	ID of the refund request.
`cashAmountCents` - `Int`	Amount refunded (cash). In cents.
`recoveredAmountCents` - `Int`	Amount to be reclaimed from merchant (remittance). In cents. Should not be supplied, provide line items that add up to the correct amount. This will be removed in November 2021.
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.
`receipts` - `[ImageInput!]`	Image(s) of refund receipts(s). Attachments should be added via RefundRequestNote.attachments. This field will be removed on 2022-12-15.
`newLineItems` - `[RefundRequestLineItemInput!]`	Line items to add. Must be custom line items, not referencing an invoice line item.

Example

{
  "clientMutationId": "xyz789",
  "refundRequestId": 4,
  "cashAmountCents": 123,
  "recoveredAmountCents": 123,
  "notes": [RefundRequestNoteInput],
  "receipts": [ImageInput],
  "newLineItems": [RefundRequestLineItemInput]
}

Types

RefundRequestRefundMutationPayload

Description

Autogenerated return type of RefundRequestRefundMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 123
}

Types

RefundRequestReturnMutationInput

Description

Autogenerated input type of RefundRequestReturnMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestId` - `ID!`	ID of the refund request.
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.
`newLineItems` - `[RefundRequestLineItemInput!]`	Line items to add. Must be custom line items, not referencing an invoice line item.

Example

{
  "clientMutationId": "abc123",
  "refundRequestId": 4,
  "notes": [RefundRequestNoteInput],
  "newLineItems": [RefundRequestLineItemInput]
}

Types

RefundRequestReturnMutationPayload

Description

Autogenerated return type of RefundRequestReturnMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 123
}

Types

RefundRequestRevertDenialMutationInput

Description

Autogenerated input type of RefundRequestRevertDenialMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestId` - `ID!`	ID of the refund request.
`notes` - `[RefundRequestNoteInput!]!`	Notes to create.

Example

{
  "clientMutationId": "xyz789",
  "refundRequestId": 4,
  "notes": [RefundRequestNoteInput]
}

Types

RefundRequestRevertDenialMutationPayload

Description

Autogenerated return type of RefundRequestRevertDenialMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`refundRequest` - `RefundRequest`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "refundRequest": RefundRequest,
  "status": 123
}

Types

RefundRequestSpreadsheetDownloadMutationInput

Description

Autogenerated input type of RefundRequestSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`	ID of the seller. If omitted will return all refund requests
`format` - `SpreadsheetEnum`
`filters` - `RefundRequestFilters`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": 4,
  "format": "XLSX",
  "filters": RefundRequestFilters
}

Types

RefundRequestSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of RefundRequestSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 987
}

Types

RefundRequestStatusEnum

Description

The current status of an refund request.

Values

Enum Value	Description
`AWAITING`	When the refund request is awaiting actions, usually when a line item is in Pending Approval or Awaiting Return status
`RETURNED`
`REFUND_ACCEPTED`
`REFUND_DENIED`
`REFUNDED`	When any line items in the refund request are in the Refunded status
`DENIED`	When all line items in the refund request are in the Refund Denied status
`PROCESSED`	When all line items in the refund request are in the Refund Accepted status

Example

"AWAITING"

Types

Remittance

Description

Remittance for invoice or invoice amendment

Fields

Field Name	Description
`amountCents` - `Int!`	The remittance amount Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`amountFormatted` - `String!`	The remittance amount In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`commissionAmountCents` - `Int`	The value of the commission of this remittance. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountFormatted` - `String`	The value of the commission of this remittance. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`invoice` - `Invoice`	Invoice
`invoiceAmendment` - `InvoiceAmendment`	An amendment/change to an invoice. May be empty.
`pendingReasons` - `[String!]!`	Reasons that this remittance is pending
`released` - `Boolean!`
`seller` - `Seller!`	The seller associated with the remittance.

Example

{
  "amountCents": 123,
  "amountFormatted": "abc123",
  "commissionAmountCents": 123,
  "commissionAmountFormatted": "xyz789",
  "createdAt": ISO8601DateTime,
  "id": 4,
  "invoice": Invoice,
  "invoiceAmendment": InvoiceAmendment,
  "pendingReasons": ["xyz789"],
  "released": false,
  "seller": Seller
}

Types

RemittanceAction

Description

Remittance action

Fields

Field Name	Description
`completedAt` - `ISO8601DateTime`	The date the remittance action was completed.
`createdAt` - `ISO8601DateTime`	The date the remittance action was created.
`destination` - `String!`	The destination of the remittance action, e.g. 'hyperwallet', 'xero'.
`id` - `ID!`
`legacyId` - `Int!`	The id used to identify the remittance action.
`remittanceAdvice` - `RemittanceAdvice`
`remittanceEvents` - `[RemittanceEvent!]!`

Example

{
  "completedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "destination": "xyz789",
  "id": 4,
  "legacyId": 987,
  "remittanceAdvice": RemittanceAdvice,
  "remittanceEvents": [RemittanceEvent]
}

Types

RemittanceAdvice

Description

Remittance advice

Fields

Field Name	Description
`attachments` - `[Image!]!`	Supporting documents relating to actions taken on the remittance advice.
`commissionAmountTotalCents` - `Int`	The total value of the commission within this remittance advice. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`commissionAmountTotalFormatted` - `String`	The total value of the commission within this remittance advice. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`createdAt` - `ISO8601DateTime`	The date the remittance advice was created.
`id` - `ID!`
`legacyId` - `Int!`	The id used to identify the remittance advice.
`paidAt` - `ISO8601DateTime`	The date the remittance advice was paid.
`paymentReference` - `String`	External payment reference for the payment of the remittance advice.
`remittanceActions` - `[RemittanceAction!]!`
`remittances` - `[Remittance!]!`
`seller` - `Seller!`
`totalCents` - `Int!`	The total amount of the remittance advice Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalFormatted` - `String!`	The total amount of the remittance advice In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`totalPaidCents` - `Int`	The total amount paid on the remittance advice Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`totalPaidFormatted` - `String`	The total amount paid on the remittance advice In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.

Example

{
  "attachments": [Image],
  "commissionAmountTotalCents": 987,
  "commissionAmountTotalFormatted": "abc123",
  "createdAt": ISO8601DateTime,
  "id": 4,
  "legacyId": 987,
  "paidAt": ISO8601DateTime,
  "paymentReference": "xyz789",
  "remittanceActions": [RemittanceAction],
  "remittances": [Remittance],
  "seller": Seller,
  "totalCents": 123,
  "totalFormatted": "xyz789",
  "totalPaidCents": 123,
  "totalPaidFormatted": "xyz789"
}

Types

RemittanceAdviceConnection

Description

The connection type for RemittanceAdvice.

Fields

Field Name	Description
`edges` - `[RemittanceAdviceEdge]`	A list of edges.
`nodes` - `[RemittanceAdvice]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RemittanceAdviceEdge],
  "nodes": [RemittanceAdvice],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

RemittanceAdviceEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RemittanceAdvice`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": RemittanceAdvice
}

Types

RemittanceAdviceUpdateMutationInput

Description

Autogenerated input type of RemittanceAdviceUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`remittanceAdviceId` - `ID!`	ID of the remittance advice.
`totalPaidCents` - `Int!`	Total paid to the seller on this remittance advice denominated in cents.
`attachments` - `[ImageInput!]`	Supporting documents relating to actions taken on the remittance advice.
`paidAt` - `ISO8601DateTime`	The date the remittance advice was paid.
`paymentReference` - `String`	External payment reference for the payment of the remittance advice.

Example

{
  "clientMutationId": "abc123",
  "remittanceAdviceId": "4",
  "totalPaidCents": 123,
  "attachments": [ImageInput],
  "paidAt": ISO8601DateTime,
  "paymentReference": "abc123"
}

Types

RemittanceAdviceUpdateMutationPayload

Description

Autogenerated return type of RemittanceAdviceUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`remittanceAdvice` - `RemittanceAdvice`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "remittanceAdvice": RemittanceAdvice,
  "status": 987
}

Types

RemittanceConnection

Description

The connection type for Remittance.

Fields

Field Name	Description
`edges` - `[RemittanceEdge]`	A list of edges.
`nodes` - `[Remittance]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`
`totalRemittanceAmount` - `Money!`	Total remittance amount

Example

{
  "edges": [RemittanceEdge],
  "nodes": [Remittance],
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalRemittanceAmount": Money
}

Types

RemittanceEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Remittance`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Remittance
}

Types

RemittanceEvent

Description

Remittance event

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime`	Date the remittance event was created.
`eventId` - `Int!`	Remittance Event ID.
`id` - `ID!`
`message` - `String`	Success or error message.
`successful` - `Boolean`	Whether the remittance event was successful.

Example

{
  "createdAt": ISO8601DateTime,
  "eventId": 987,
  "id": 4,
  "message": "abc123",
  "successful": true
}

Types

RemittanceSummary

Fields

Field Name	Description
`rows` - `[RemittanceSummaryRow!]!`
`totals` - `RemittanceSummaryRow`

Example

{
  "rows": [RemittanceSummaryRow],
  "totals": RemittanceSummaryRow
}

Types

RemittanceSummaryGroupBy

Values

Enum Value	Description
`BY_YEAR`
`BY_MONTH`
`BY_DAY`

Example

"BY_YEAR"

Types

RemittanceSummaryRow

Fields

Field Name	Description
`date` - `String!`
`groupBy` - `SalesSummaryGroupBy!`
`invoicesCount` - `BigInt!`
`totalAmount` - `Money!`

Example

{
  "date": "xyz789",
  "groupBy": "BY_YEAR",
  "invoicesCount": {},
  "totalAmount": Money
}

Types

RemittancesReleaseMutationInput

Description

Autogenerated input type of RemittancesReleaseMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`remittanceIds` - `[ID!]!`	IDs for remittances

Example

{
  "clientMutationId": "xyz789",
  "remittanceIds": ["4"]
}

Types

RemittancesReleaseMutationPayload

Description

Autogenerated return type of RemittancesReleaseMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`remittances` - `[Remittance!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "remittances": [Remittance],
  "status": 123
}

Types

ResetUserPasswordMutationInput

Description

Autogenerated input type of ResetUserPasswordMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`emailAddress` - `String!`	The user's email address

Example

{
  "clientMutationId": "abc123",
  "emailAddress": "abc123"
}

Types

ResetUserPasswordMutationPayload

Description

Autogenerated return type of ResetUserPasswordMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123
}

Types

RetailerAccessConfig

Description

Category label and category slug for building seller category search links

Fields

Field Name	Description
`canAccessInsightsAndStatistics` - `Boolean!`
`canAccessMarketingTools` - `Boolean!`

Example

{"canAccessInsightsAndStatistics": false, "canAccessMarketingTools": true}

Types

ReturnShipment

Description

Shipment tracking information.

Fields

Field Name	Description
`attachments` - `[Image!]!`
`carrier` - `ShipmentCarrier!`	Carrier
`createdAt` - `ISO8601DateTime!`
`dropOffUrl` - `String`	Seller specified URL for a third-party drop-off location website
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`legacyId` - `Int!`
`metadata` - `[Metadatum!]!`	Metadata key/values
`note` - `String`	Note on the shipment
`refundRequest` - `RefundRequest!`
`shippedItems` - `[ReturnShippedItem!]`
`statusLog` - `ShipmentStatusConnection`
Arguments `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.
`trackingNumber` - `String!`	Tracking #
`updatedAt` - `ISO8601DateTime!`

Example

{
  "attachments": [Image],
  "carrier": ShipmentCarrier,
  "createdAt": ISO8601DateTime,
  "dropOffUrl": "xyz789",
  "externalIds": [ExternalID],
  "id": "4",
  "legacyId": 987,
  "metadata": [Metadatum],
  "note": "xyz789",
  "refundRequest": RefundRequest,
  "shippedItems": [ReturnShippedItem],
  "statusLog": ShipmentStatusConnection,
  "trackingNumber": "xyz789",
  "updatedAt": ISO8601DateTime
}

Types

ReturnShipmentCreateMutationInput

Description

Autogenerated input type of ReturnShipmentCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`refundRequestId` - `ID!`	ID of the refund request.
`shippedItems` - `[ReturnShippedItemInput!]!`
`carrierId` - `ID!`	ID of the carrier.
`trackingNumber` - `String!`	Shipment carrier tracking number.
`metadata` - `[KeyValueInput!]`	Metadata (key/value). Default = `[]`
`externalIds` - `[KeyValueInput!]`	ExternalID (key/value). Default = `[]`
`attachments` - `[ImageInput!]`
`note` - `String`
`dropOffUrl` - `String`	Seller specified URL for a third-party drop-off location website

Example

{
  "clientMutationId": "xyz789",
  "refundRequestId": "4",
  "shippedItems": [ReturnShippedItemInput],
  "carrierId": "4",
  "trackingNumber": "xyz789",
  "metadata": [KeyValueInput],
  "externalIds": [KeyValueInput],
  "attachments": [ImageInput],
  "note": "xyz789",
  "dropOffUrl": "xyz789"
}

Types

ReturnShipmentCreateMutationPayload

Description

Autogenerated return type of ReturnShipmentCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shipment` - `ReturnShipment`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shipment": ReturnShipment,
  "status": 123
}

Types

ReturnShipmentUpdateMutationInput

Description

Autogenerated input type of ReturnShipmentUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shipmentId` - `ID!`	ID of the refund request shipment.
`carrierId` - `ID`
`trackingNumber` - `String`
`metadata` - `[KeyValueInput!]`	Metadata (key/value).
`externalIds` - `[KeyValueInput!]`	ExternalID (key/value).
`attachments` - `[ImageInput!]`
`note` - `String`
`dropOffUrl` - `String`	Seller specified URL for a third-party drop-off location website

Example

{
  "clientMutationId": "abc123",
  "shipmentId": "4",
  "carrierId": 4,
  "trackingNumber": "abc123",
  "metadata": [KeyValueInput],
  "externalIds": [KeyValueInput],
  "attachments": [ImageInput],
  "note": "xyz789",
  "dropOffUrl": "abc123"
}

Types

ReturnShipmentUpdateMutationPayload

Description

Autogenerated return type of ReturnShipmentUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shipment` - `ReturnShipment`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "shipment": ReturnShipment,
  "status": 123
}

Types

ReturnShippedItem

Description

Quantity and LineItem which has been shipped as part of a parent ReturnShipment.

Fields

Field Name	Description
`id` - `ID!`
`lineItem` - `RefundRequestLineItem!`	RefundRequestLineItem which has had the quantity of items shipped
`quantity` - `Int!`

Example

{
  "id": "4",
  "lineItem": RefundRequestLineItem,
  "quantity": 987
}

Types

ReturnShippedItemInput

Fields

Input Field	Description
`quantity` - `Int!`
`lineItemId` - `ID!`	RefundRequestLineItem which has had the quantity of items shipped

Example

{"quantity": 123, "lineItemId": "4"}

Types

RithumAPIKey

Description

Rithum API key info

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`	The date the API key was created.
`createdById` - `Int!`	The user id of created API key.
`createdByType` - `String!`	The user type of created API key.
`expiryAt` - `ISO8601DateTime`	Expiry time of the created API key.
`id` - `ID!`

Example

{
  "createdAt": ISO8601DateTime,
  "createdById": 123,
  "createdByType": "xyz789",
  "expiryAt": ISO8601DateTime,
  "id": 4
}

Types

RithumAPIKeyCreateMutationInput

Description

Autogenerated input type of RithumAPIKeyCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`apiTermsOfUse` - `Boolean!`

Example

{
  "clientMutationId": "xyz789",
  "apiTermsOfUse": false
}

Types

RithumAPIKeyCreateMutationPayload

Description

Autogenerated return type of RithumAPIKeyCreateMutation.

Fields

Field Name	Description
`apiKey` - `String`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`rithumApiKey` - `RithumAPIKey`
`status` - `Int!`

Example

{
  "apiKey": "xyz789",
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "rithumApiKey": RithumAPIKey,
  "status": 123
}

Types

RithumAPIKeysConnection

Description

The connection type for RithumAPIKey.

Fields

Field Name	Description
`edges` - `[RithumAPIKeysEdge]`	A list of edges.
`nodes` - `[RithumAPIKey]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [RithumAPIKeysEdge],
  "nodes": [RithumAPIKey],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

RithumAPIKeysEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RithumAPIKey`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": RithumAPIKey
}

Types

SalesSummary

Fields

Field Name	Description
`rows` - `[SalesSummaryRow!]!`
`totals` - `SalesSummaryRow`

Example

{
  "rows": [SalesSummaryRow],
  "totals": SalesSummaryRow
}

Types

SalesSummaryGroupBy

Values

Enum Value	Description
`BY_YEAR`
`BY_MONTH`
`BY_DAY`

Example

"BY_YEAR"

Types

SalesSummaryRow

Fields

Field Name	Description
`commissionAmount` - `Money!`
`consumerPaid` - `Money!`
`date` - `String!`
`groupBy` - `SalesSummaryGroupBy!`
`merchantFee` - `Money!`
`ordersTotal` - `BigInt!`
`postage` - `Money!`
`productSales` - `Money!`

Example

{
  "commissionAmount": Money,
  "consumerPaid": Money,
  "date": "abc123",
  "groupBy": "BY_YEAR",
  "merchantFee": Money,
  "ordersTotal": {},
  "postage": Money,
  "productSales": Money
}

Types

SearchField

Description

Properties of a single search field

Types

Union Types
`FreeTextAndSelectField`
`FreeTextField`
`SelectField`

Example

FreeTextAndSelectField

Types

SearchSettings

Description

Customization settings pertaining to search

Fields

Field Name	Description
`saveSessionSearchPostcode` - `Boolean!`	Save search postcode in user session
`showAvailabilityFilter` - `Boolean!`	Show availability filter in search
`showBrandFilter` - `Boolean!`	Show brand filter in search
`showConditionFilter` - `Boolean!`	Show condition filter in search
`showGenderFilter` - `Boolean!`	Show gender filter in search
`showModelFilter` - `Boolean!`	Show model filter in search
`showSellerFilter` - `Boolean!`	Show seller filter in search

Example

{
  "saveSessionSearchPostcode": false,
  "showAvailabilityFilter": true,
  "showBrandFilter": false,
  "showConditionFilter": false,
  "showGenderFilter": true,
  "showModelFilter": false,
  "showSellerFilter": true
}

Types

SelectField

Description

Field where a list of predefined options is supplied

Fields

Field Name	Description
`defaultValue` - `String`	Default selection value (as exists in `options`)
`name` - `String!`
`options` - `[SelectOption!]!`

Example

{
  "defaultValue": "xyz789",
  "name": "abc123",
  "options": [SelectOption]
}

Types

SelectOption

Description

A single selectable option within a Select field

Fields

Field Name	Description
`label` - `String!`
`value` - `String!`

Example

{
  "label": "xyz789",
  "value": "abc123"
}

Types

Seller

Description

Retailer or private seller.

Fields

Field Name	Description
`accountCode` - `String`	Used to identify the Seller from an Account Management perspective
`accountName` - `String`	The bank's account name for direct debit. Only accessible to users: admin_authorized, seller_authorized.
`accountNumber` - `String`	The bank's account number for direct debit. Only accessible to users: admin_authorized, seller_authorized.
`accountType` - `String`	Account type of the Seller
`address` - `Address`
`advertVettingRequired` - `Boolean!`	True if product vetting is enabled for the seller.
`advertsCount` - `Int!`	Count of adverts belonging to the seller Only accessible to users: admin_authorized, seller_authorized.
`apiEnabled` - `Boolean`	True if API access is enabled for this seller.
`baseCommissionRate` - `Float`	Base Commission Level. Note: this is only visible when an API Key is provided, and excludes options like category based commissions. Only accessible to users: admin_visible.
`baseDomesticShippingCost` - `Float!`	Domestic shipping cost applied at the Seller level
`baseInternationalShippingCost` - `Float!`	International shipping cost applied at the Seller level
`bsb` - `String`	Bank State Branch for direct debit. Only accessible to users: admin_authorized, seller_authorized.
`businessName` - `String!`	The seller's trading name.
`businessNumber` - `String!`	National business identification number (e.g. ABN in Australia).
`chatMessages` - `ChatMessagesConnection!`	Chat message Only accessible to users: admin_authorized, seller_authorized. And admin users with permissions: 'Manage chat', 'Full GraphQL API access'.
Arguments `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.
`clickAndCollectPolicy` - `String`	Store Policies - Click and Collect Policy
`commissionPackage` - `CommissionPackage!`	The commission package of the seller. Only accessible to users: admin_authorized, seller_authorized. And admin users with permissions: 'Manage commissions', 'Full GraphQL API access'.
`commissionPackageVersionLogs` - `[CommissionPackageVersionLog!]`	Commission package versions logs of the seller. Only accessible to users: admin_authorized, seller_authorized. And admin users with permissions: 'Manage commissions', 'Full GraphQL API access'.
`createdAt` - `ISO8601DateTime`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`customFieldGroups` - `EntityCustomFieldGroupConnection`	Customised fields for the seller. Only accessible to users: admin_authorized, seller_authorized.
Arguments `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.
`deliveryDetails` - `String`	Store Policies - Shipping and Delivery Policy
`domesticShippingFreeThreshold` - `Float`	Orders over this threshold value will qualify for free shipping
`emailAddress` - `String!`
`emailCc` - `String`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`enableAdvertAutoMapping` - `Boolean!`	True if advert auto mapping is enabled for the seller Only accessible to users: admin_authorized, seller_authorized.
`enableWholesalePricing` - `Boolean!`	True if wholesale and rrp pricing are enabled for the seller
`enableWholesalePricingPromo` - `Boolean!`	True if wholesale pricing promo is enabled for the seller
`enableWholesaleProduct` - `Boolean!`	True if seller is allowed to mark variants as wholesale Only accessible to users: admin_authorized, seller_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`externalIds` - `[ExternalID!]!`
`hasStoredPaymentMethod` - `Boolean!`	This field identifies sellers that have a stored payment method Only accessible to users: admin_authorized, seller_authorized.
`hasUnpaidBillings` - `Boolean!`	True if seller has unpaid billings Only accessible to users: admin_authorized, seller_authorized.
`hideCommissionInvoice` - `Boolean!`	True if commission invoice should be hidden for the seller Only accessible to users: admin_authorized, seller_authorized.
`id` - `ID!`
`imageGallery` - `ImageGallery!`	Image gallery data for the shop page
`initiateRefundsEnabled` - `Boolean`	True if seller is allowed to initiate refunds Only accessible to users: admin_authorized, seller_authorized.
`integrationsManagerEnabled` - `Boolean`	True if Integrations manager is enabled for this seller
`integrationsManagerFullUrl` - `String`	Seller authenticated absolute url for the integration manager auth path Only accessible to users: admin_authorized, seller_authorized.
`integrationsManagerUrl` - `String`	Seller authenticated relative url for the integration manager auth path Only accessible to users: admin_authorized, seller_authorized.
`internationalShippingEnabled` - `Boolean!`	True if seller enabled international shipping
`internationalShippingFreeThreshold` - `Float`	Orders over this threshold value will qualify for free international shipping
`invoiceDispatchDaysThreshold` - `Int`	Maximum number of days allowed for dispatching an invoice. If the value is nil, the system will use the operator setting to measure SLA. Only accessible to users: admin_authorized, seller_authorized.
`isBillable` - `Boolean!`	True if seller is billable Only accessible to users: admin_authorized, seller_authorized.
`isPrivate` - `Boolean!`	True if the seller is a private store
`isRetailer` - `Boolean!`	True if the seller is a retailer
`lastStoredPaymentMethod` - `StoredPaymentMethod`	Last stored payment method used by the seller
`legacyId` - `Int!`	The id used to identify the seller.
`legalBusinessName` - `String!`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`logo` - `Image`	The company logo for the seller.
`logoUrl` - `String`	The company logo url for the seller. Deprecated as of March 2023. Use logo instead
`mStoreEnabled` - `Boolean!`	True if customisable storefront is enabled for the seller
`mailToUrl` - `String!`	Url for the seller contact page
`managedMultiStore` - `MultiStore`
`marketplaceShippingRulesEnabled` - `Boolean!`
`marketplacerApiKeys` - `[MarketplacerAPIKey!]!`	Collection of all Marketplacer API keys belonging to the seller
`metadata` - `[Metadatum!]!`	Metadata key/values
`missingHyperwalletDetails` - `Boolean!`	Pending remittance process as missing Hyperwallet details Only accessible to users: admin_authorized, seller_authorized.
`missingRemittanceDetails` - `Boolean!`	Pending remittance process because of missing remittance details Only accessible to users: admin_authorized, seller_authorized.
`missingXeroAccount` - `Boolean!`	Pending remittance process due to missing Xero account Only accessible to users: admin_authorized, seller_authorized.
`mobile` - `String`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`multiStoreParent` - `Boolean!`	True if the seller is the parent of multiple stores
`obscuredPhone` - `String`	The phone number of the seller, obscured
`online` - `Boolean!`	Shows if seller is online
`onlineOnly` - `Boolean!`	True if the seller is online only
`openingHours` - `String`
`paymentMethod` - `String`	Payment method for the seller Only accessible to users: admin_authorized, seller_authorized.
`pendingHyperwalletVerification` - `Boolean!`	Pending remittance process because of Hyperwallet verification status Only accessible to users: admin_authorized, seller_authorized.
`phone` - `String!`	The phone number of the seller
`policies` - `SellerPolicies!`
`posType` - `String`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`primaryUser` - `User`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`productLimitsEnabled` - `Boolean`	True if product limits are enabled for the seller Only accessible to users: admin_authorized, seller_authorized.
`rating` - `SellerRating`
`refundRequestAllowed` - `Boolean`	True if allow order cancellations is enabled for this seller Only accessible to users: admin_authorized, seller_authorized.
`registeredForTax` - `Boolean!`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`remittanceAccountName` - `String`	The bank's account name for remittance. Only accessible to users: admin_authorized, seller_authorized.
`remittanceAccountNumber` - `String`	The bank's account number for remittance. Only accessible to users: admin_authorized, seller_authorized.
`remittanceBsb` - `String`	Bank State Branch for remittance. Only accessible to users: admin_authorized, seller_authorized.
`requiresPaymentDetailsForBilling` - `Boolean!`	This field identifies sellers that require payment details for billing Only accessible to users: admin_authorized, seller_authorized.
`retailerAccessConfig` - `RetailerAccessConfig`	Retailer Access Config details for Sellers
`returnPolicy` - `String`	Store Policies - Exchange Policy
`rithumApiKeys` - `RithumAPIKeysConnection!`	Collection of all Rithum API keys belonging to the seller
Arguments `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.
`sellerIsContactable` - `Boolean!`	True if the seller is contactable
`sellerRating` - `String`	Rating associated to the seller by admin Only accessible to users: admin_authorized, admin_visible.
`servicePolicy` - `String`	Store Policies - Customer Service Policy
`shipmentAddresses` - `[Address!]`	Addresses for invoices to be shipped from. Only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`shopAdvertSearchPath` - `String`	Path to a retailer-specific advert search results page that only shows adverts from the given seller.
`showImageGallery` - `Boolean!`	True if we can display the image gallery
`showPhoneNumber` - `Boolean!`	True if we can show the phone number of the seller
`slaRating` - `Float`	Seller SLA rating value based on recent performance
`storeCategory` - `String`	Only applies to professional retailer accounts.
`storeDescription` - `String`
`storeDescriptionHtml` - `String!`	The store description html for the seller.
`storeImages` - `[Image!]!`
`storeSeoContentHtml` - `String!`	SEO content html for the seller
`tags` - `[String!]`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
`trackingInformationRequiredForBulkDispatch` - `Boolean`	True if seller is required to add a tracking number on a line item. Only accessible to users: admin_authorized, seller_authorized.
`trade` - `String`	The category with which the Seller is associated
`underAdDescription` - `String`	Text below will appear on all ads
`underAdImpressum` - `String`	Your store details to include with all ads
`updatedAt` - `ISO8601DateTime!`
`users` - `UserConnection!`	only accessible to the seller Only accessible to users: admin_authorized, seller_authorized.
Arguments `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.
`youtubeVideoUrl` - `String`	Store Video (retailer page)
`zeroOrNegativeTotalRemittanceAmount` - `Boolean!`	Pending remittance process because of zero or negative total remittance amount Only accessible to users: admin_authorized, seller_authorized.

Example

{
  "accountCode": "xyz789",
  "accountName": "abc123",
  "accountNumber": "xyz789",
  "accountType": "xyz789",
  "address": Address,
  "advertVettingRequired": false,
  "advertsCount": 987,
  "apiEnabled": false,
  "baseCommissionRate": 987.65,
  "baseDomesticShippingCost": 987.65,
  "baseInternationalShippingCost": 987.65,
  "bsb": "xyz789",
  "businessName": "xyz789",
  "businessNumber": "abc123",
  "chatMessages": ChatMessagesConnection,
  "clickAndCollectPolicy": "abc123",
  "commissionPackage": CommissionPackage,
  "commissionPackageVersionLogs": [
    CommissionPackageVersionLog
  ],
  "createdAt": ISO8601DateTime,
  "customFieldGroups": EntityCustomFieldGroupConnection,
  "deliveryDetails": "abc123",
  "domesticShippingFreeThreshold": 123.45,
  "emailAddress": "xyz789",
  "emailCc": "xyz789",
  "enableAdvertAutoMapping": false,
  "enableWholesalePricing": true,
  "enableWholesalePricingPromo": false,
  "enableWholesaleProduct": true,
  "externalIds": [ExternalID],
  "hasStoredPaymentMethod": true,
  "hasUnpaidBillings": false,
  "hideCommissionInvoice": true,
  "id": "4",
  "imageGallery": ImageGallery,
  "initiateRefundsEnabled": false,
  "integrationsManagerEnabled": false,
  "integrationsManagerFullUrl": "xyz789",
  "integrationsManagerUrl": "abc123",
  "internationalShippingEnabled": false,
  "internationalShippingFreeThreshold": 123.45,
  "invoiceDispatchDaysThreshold": 123,
  "isBillable": true,
  "isPrivate": true,
  "isRetailer": true,
  "lastStoredPaymentMethod": StoredPaymentMethod,
  "legacyId": 123,
  "legalBusinessName": "abc123",
  "logo": Image,
  "logoUrl": "abc123",
  "mStoreEnabled": false,
  "mailToUrl": "xyz789",
  "managedMultiStore": MultiStore,
  "marketplaceShippingRulesEnabled": true,
  "marketplacerApiKeys": [MarketplacerAPIKey],
  "metadata": [Metadatum],
  "missingHyperwalletDetails": false,
  "missingRemittanceDetails": true,
  "missingXeroAccount": false,
  "mobile": "abc123",
  "multiStoreParent": false,
  "obscuredPhone": "xyz789",
  "online": true,
  "onlineOnly": false,
  "openingHours": "xyz789",
  "paymentMethod": "xyz789",
  "pendingHyperwalletVerification": true,
  "phone": "abc123",
  "policies": SellerPolicies,
  "posType": "abc123",
  "primaryUser": User,
  "productLimitsEnabled": false,
  "rating": SellerRating,
  "refundRequestAllowed": false,
  "registeredForTax": true,
  "remittanceAccountName": "abc123",
  "remittanceAccountNumber": "xyz789",
  "remittanceBsb": "xyz789",
  "requiresPaymentDetailsForBilling": true,
  "retailerAccessConfig": RetailerAccessConfig,
  "returnPolicy": "xyz789",
  "rithumApiKeys": RithumAPIKeysConnection,
  "sellerIsContactable": true,
  "sellerRating": "abc123",
  "servicePolicy": "abc123",
  "shipmentAddresses": [Address],
  "shopAdvertSearchPath": "abc123",
  "showImageGallery": false,
  "showPhoneNumber": false,
  "slaRating": 123.45,
  "storeCategory": "abc123",
  "storeDescription": "xyz789",
  "storeDescriptionHtml": "abc123",
  "storeImages": [Image],
  "storeSeoContentHtml": "abc123",
  "tags": ["abc123"],
  "trackingInformationRequiredForBulkDispatch": false,
  "trade": "abc123",
  "underAdDescription": "abc123",
  "underAdImpressum": "abc123",
  "updatedAt": ISO8601DateTime,
  "users": UserConnection,
  "youtubeVideoUrl": "xyz789",
  "zeroOrNegativeTotalRemittanceAmount": false
}

Types

SellerAccountTypeEnum

Description

Seller account type

Values

Enum Value	Description
`PROSPECTIVE`	Prospective retailer account requiring admin review
`RETAILER`	Retailer account

Example

"PROSPECTIVE"

Types

SellerAdyenBillingPaymentMethodUpdateMutationInput

Description

Autogenerated input type of SellerAdyenBillingPaymentMethodUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`attributes` - `JSON!`	Data used to persist a payment method for Adyen.

Example

{
  "clientMutationId": "abc123",
  "sellerId": "4",
  "attributes": {}
}

Types

SellerAdyenBillingPaymentMethodUpdateMutationPayload

Description

Autogenerated return type of SellerAdyenBillingPaymentMethodUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`response` - `AdyenResponse`
`seller` - `Seller`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "response": AdyenResponse,
  "seller": Seller,
  "status": 987
}

Types

SellerBraintreeBillingPaymentMethodUpdateMutationInput

Description

Autogenerated input type of SellerBraintreeBillingPaymentMethodUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`paymentMethodNonce` - `String!`

Example

{
  "clientMutationId": "abc123",
  "sellerId": 4,
  "paymentMethodNonce": "xyz789"
}

Types

SellerBraintreeBillingPaymentMethodUpdateMutationPayload

Description

Autogenerated return type of SellerBraintreeBillingPaymentMethodUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`seller` - `Seller`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "seller": Seller,
  "status": 987
}

Types

SellerCategoryLink

Description

Category label and category slug for building seller category search links

Fields

Field Name	Description
`categoryLabel` - `String!`
`categorySlug` - `String!`

Example

{
  "categoryLabel": "abc123",
  "categorySlug": "xyz789"
}

Types

SellerConnection

Description

The connection type for Seller.

Fields

Field Name	Description
`edges` - `[SellerEdge]`	A list of edges.
`nodes` - `[Seller]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [SellerEdge],
  "nodes": [Seller],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

SellerCreateMutationInput

Description

Autogenerated input type of SellerCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `SellerInput!`	Attributes for creating a seller.

Example

{
  "clientMutationId": "abc123",
  "attributes": SellerInput
}

Types

SellerCreateMutationPayload

Description

Autogenerated return type of SellerCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`seller` - `Seller`
`status` - `Int!`
`user` - `User`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "seller": Seller,
  "status": 987,
  "user": User
}

Types

SellerEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Seller`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Seller
}

Types

SellerFilterOption

Description

Minimal subset of Seller type which can be used to build a seller filter for advert search

Fields

Field Name	Description
`businessName` - `String!`
`count` - `Int!`	The number of adverts associated with each seller filter option
`id` - `ID!`

Example

{
  "businessName": "abc123",
  "count": 987,
  "id": 4
}

Types

SellerGeolocation

Description

Coordinates of a Seller

Fields

Field Name	Description
`address` - `AddressGeolocation!`
`id` - `ID!`
`sellerCategorySlug` - `String`	The category slug with which the Seller is associated

Example

{
  "address": AddressGeolocation,
  "id": "4",
  "sellerCategorySlug": "xyz789"
}

Types

SellerInput

Description

Attributes for creating a seller.

Fields

Input Field	Description
`accountType` - `SellerAccountTypeEnum!`	Seller account type
`businessName` - `String!`	Business name for account
`legalBusinessName` - `String!`	Registered legal business name
`businessRegistrationCode` - `String`	Business registration code (eg: ABN)
`posType` - `String`	POS type used by seller
`emailAddress` - `String`	Business email address
`emailCc` - `String`	Notification cc email address
`phone` - `String!`	Business phone contact number
`mobile` - `String`	Business mobile contact number
`tags` - `[String!]`	List of seller tags
`user` - `UserCreateInput!`	Attributes to assign to the user account.
`address` - `AddressInput!`	Seller business address
`storeDescription` - `String`
`logo` - `ImageInput`
`customFields` - `[CustomFieldValueInput!]`	Attributes to assign to the CustomField.
`metadata` - `[KeyValueInput!]`	Metadata (key/value).
`enableAdvertAutoMapping` - `Boolean`	To enable advert auto mapping feature
`invoiceDispatchDaysThreshold` - `Int`	Maximum number of days allowed for dispatching an invoice. If the value is nil, the system will use the operator setting to measure SLA.

Example

{
  "accountType": "PROSPECTIVE",
  "businessName": "xyz789",
  "legalBusinessName": "abc123",
  "businessRegistrationCode": "xyz789",
  "posType": "abc123",
  "emailAddress": "abc123",
  "emailCc": "xyz789",
  "phone": "abc123",
  "mobile": "xyz789",
  "tags": ["abc123"],
  "user": UserCreateInput,
  "address": AddressInput,
  "storeDescription": "abc123",
  "logo": ImageInput,
  "customFields": [CustomFieldValueInput],
  "metadata": [KeyValueInput],
  "enableAdvertAutoMapping": true,
  "invoiceDispatchDaysThreshold": 123
}

Types

SellerPolicies

Description

Seller policies regarding products and/or services.

Fields

Field Name	Description
`returnPolicy` - `String!`
`servicePolicy` - `String!`
`shippingPolicy` - `String!`
`storePickupPolicy` - `String!`

Example

{
  "returnPolicy": "abc123",
  "servicePolicy": "xyz789",
  "shippingPolicy": "xyz789",
  "storePickupPolicy": "xyz789"
}

Types

SellerRating

Description

Rating data for Seller

Fields

Field Name	Description
`count` - `Int!`	The number of ratings that have been submitted
`externalId` - `String`	ID that belongs to this seller from the third party rating provider
`stars` - `Float!`	Averaged star-rating of all submitted reviews (1-5)

Example

{
  "count": 987,
  "externalId": "xyz789",
  "stars": 987.65
}

Types

SellerSearchInput

Description

Seller search arguments for building an ElasticSearch query.

Fields

Input Field	Description
`businessName` - `String`	Search by name of the company or store. Includes partial text matches in results.
`city` - `String`	Official name of a city or suburb. Takes precedence over postcode if both are provided.
`distance` - `Int`	Include sellers within this distance of the location searched. NOTE: As of June 2020, this currently defaults to 10 kms or miles (depending on country), but this will be deprecated in favour of defaulting to no limit on distance from the queried location. Default = `10`
`ignoreDistance` - `Boolean`	Whether to ignore the distance argument in favour of not limiting seller results by distance from the queried location. NOTE: As of June 2020, this is a temporary field that will be deprecated once the default for distance is changed from 10 to nil. Default = `false`
`id` - `ID`	Filter by ID of the seller.
`postcode` - `String`	Postcode/Zip code. Postcode will be ignored if city is also provided.
`state` - `String`	Full, official name of a state, region, or territory. State will be ignored if city or postcode is provided and is in a different state.
`onlineOnly` - `Boolean`	Flag to filter sellers to online only stores. Defaults to nil.
`geocoded` - `Boolean`	Flag to filter sellers to only those that have valid geocode data. Defaults to false.
`sellerCategory` - `String`	Filter by store category.
`sellerCategorySlug` - `String`	Filter by the URL slug of the store category.
`metadata` - `[KeyValueInput!]`	Filter by the metadata (exact match only).
`updatedSince` - `ISO8601DateTime`	Only return sellers which have been updated since this date. Default = `null`

Example

{
  "businessName": "xyz789",
  "city": "abc123",
  "distance": 123,
  "ignoreDistance": false,
  "id": "4",
  "postcode": "abc123",
  "state": "xyz789",
  "onlineOnly": false,
  "geocoded": true,
  "sellerCategory": "xyz789",
  "sellerCategorySlug": "abc123",
  "metadata": [KeyValueInput],
  "updatedSince": ISO8601DateTime
}

Types

SellerSearchPagination

Description

Pagination info returned by ElasticSearch with query results.

Fields

Field Name	Description
`currentPage` - `Int!`	Current page of the search results as determined by the associated query parameter. Use the relay style pagination on sellers directly
`resultsPerPage` - `Int!`	Number of results per page as determined by the associated query parameter. Use the relay style pagination on sellers directly
`totalPages` - `Int!`	Total number of results divided by results per page. Use the relay style pagination on sellers directly
`totalResults` - `Int!`	Total number of results. Use the relay style pagination on sellers directly

Example

{
  "currentPage": 987,
  "resultsPerPage": 123,
  "totalPages": 987,
  "totalResults": 123
}

Types

SellerSearchPaginationInput

Description

Advert search arguments for controlling pagination. NOTE: As of the 3rd of Sept. 2019, These arguments are deprecated in favour of using cursor-based pagination per the Relay spec and will be removed at the end of Sept. 2019.

Fields

Input Field	Description
`currentPage` - `Int`	Which page of the results you want to display.
`resultsPerPage` - `Int`	How many results you want per page.

Example

{"currentPage": 987, "resultsPerPage": 987}

Types

SellerSearchResponse

Description

Seller search response payload.

Fields

Field Name	Description
`pagination` - `SellerSearchPagination!`	Use the relay style pagination on sellers directly
`sellers` - `SellersConnection!`
Arguments `after` - `String` Returns the elements in the list that come after the specified cursor. `first` - `Int` Returns the first n elements from the list.
`seoContent` - `SeoContent`

Example

{
  "pagination": SellerSearchPagination,
  "sellers": SellersConnection,
  "seoContent": SeoContent
}

Types

SellerSendInvoiceToCustomerMutationInput

Description

Autogenerated input type of SellerSendInvoiceToCustomerMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID`

Example

{
  "clientMutationId": "abc123",
  "invoiceId": 4
}

Types

SellerSendInvoiceToCustomerMutationPayload

Description

Autogenerated return type of SellerSendInvoiceToCustomerMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987
}

Types

SellerSlaExportMetricMutationInput

Description

Autogenerated input type of SellerSlaExportMetricMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`rollingDateWindow` - `Int`

Example

{
  "clientMutationId": "xyz789",
  "rollingDateWindow": 987
}

Types

SellerSlaExportMetricMutationPayload

Description

Autogenerated return type of SellerSlaExportMetricMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 123
}

Types

SellerSlaRatingRangeInput

Description

Specify desired SLA rating ranges.

Fields

Input Field	Description
`gte` - `Float`	Rating greater than or equal to the given value
`lte` - `Float`	Rating less than or equal to the given value

Example

{"gte": 987.65, "lte": 987.65}

Types

SellerStats

Description

Insights and Statistics for a Seller.

Fields

Field Name	Description
`advertStatisticsSummary` - `[AdvertStatisticsSummary!]!`
Arguments `year` - `Int` Defaults to current year `numMonths` - `Int`
`id` - `ID!`	ID of the object.
`remittanceSummary` - `RemittanceSummary!`
Arguments `groupBy` - `RemittanceSummaryGroupBy` `year` - `Int` Only required for BY_MONTH and BY_DAY `month` - `Int` Only required for BY_DAY
`salesSummaryV2` - `SalesSummary!`
Arguments `groupBy` - `SalesSummaryGroupBy` `year` - `Int` Only required for BY_MONTH and BY_DAY `month` - `Int` Only required for BY_DAY
`seller` - `Seller!`

Example

{
  "advertStatisticsSummary": [AdvertStatisticsSummary],
  "id": 4,
  "remittanceSummary": RemittanceSummary,
  "salesSummaryV2": SalesSummary,
  "seller": Seller
}

Types

SellerUpdateInput

Description

Attributes for updating a seller.

Fields

Input Field	Description
`accountType` - `SellerAccountTypeEnum`	Seller account type
`businessName` - `String`	Business name for account
`legalBusinessName` - `String`	Registered legal business name
`tags` - `[String!]`	List of seller tags
`posType` - `String`	POS type used by seller
`emailAddress` - `String`	Business email address
`emailCc` - `String`	Notification cc email address
`phone` - `String`	Business phone contact number
`mobile` - `String`	Business mobile contact number
`storeDescription` - `String`
`businessNumber` - `String`	National business identification number (e.g. ABN in Australia).
`registeredForTax` - `Boolean`	only accessible to the seller
`remittanceBsb` - `String`	Bank State Branch for remittance.
`remittanceAccountNumber` - `String`	The bank's account number for remittance.
`remittanceAccountName` - `String`	The bank's account name for remittance.
`storeDescriptionHtml` - `String`	The store description html for the seller. Use store_description instead. This has always been broken
`showImageGallery` - `Boolean`	True if we can display the image gallery
`youtubeVideoUrl` - `String`	Store Video (retailer page)
`openingHours` - `String`
`underAdDescription` - `String`	Text below will appear on all ads
`underAdImpressum` - `String`	Your store details to include with all ads
`deliveryDetails` - `String`	Store Policies - Shipping and Delivery Policy
`clickAndCollectPolicy` - `String`	Store Policies - Click and Collect Policy
`servicePolicy` - `String`	Store Policies - Customer Service Policy
`returnPolicy` - `String`	Store Policies - Exchange Policy
`baseDomesticShippingCost` - `Decimal`	Domestic shipping cost applied at the Seller level
`domesticShippingFreeThreshold` - `Decimal`	Orders over this threshold value will qualify for free shipping
`baseInternationalShippingCost` - `Decimal`	International shipping cost applied at the Seller level
`internationalShippingFreeThreshold` - `Decimal`	Orders over this threshold value will qualify for free international shipping
`internationalShippingEnabled` - `Boolean`	True if seller enabled international shipping
`bsb` - `String`	Bank State Branch for direct debit.
`accountNumber` - `String`	The bank's account number for direct debit.
`accountName` - `String`	The bank's account name for direct debit.
`marketplaceShippingRulesEnabled` - `Boolean`
`pdfFooterText` - `String`	Footer text to be displayed on invoice and seller credit note PDF's
`storeImages` - `[ImageInput!]`
`logo` - `ImageInput`
`address` - `AddressInput`	Seller business address
`metadata` - `[KeyValueInput!]`	Metadata (key/value). Will upsert values.
`customFields` - `[CustomFieldValueInput!]`	Attributes to assign to the CustomField.
`enableAdvertAutoMapping` - `Boolean`	To enable advert auto mapping feature
`invoiceDispatchDaysThreshold` - `Int`	Maximum number of days allowed for dispatching an invoice. If the value is nil, the system will use the operator setting to measure SLA.

Example

{
  "accountType": "PROSPECTIVE",
  "businessName": "abc123",
  "legalBusinessName": "xyz789",
  "tags": ["abc123"],
  "posType": "abc123",
  "emailAddress": "xyz789",
  "emailCc": "xyz789",
  "phone": "abc123",
  "mobile": "xyz789",
  "storeDescription": "xyz789",
  "businessNumber": "abc123",
  "registeredForTax": true,
  "remittanceBsb": "xyz789",
  "remittanceAccountNumber": "abc123",
  "remittanceAccountName": "abc123",
  "storeDescriptionHtml": "xyz789",
  "showImageGallery": true,
  "youtubeVideoUrl": "abc123",
  "openingHours": "abc123",
  "underAdDescription": "abc123",
  "underAdImpressum": "abc123",
  "deliveryDetails": "xyz789",
  "clickAndCollectPolicy": "abc123",
  "servicePolicy": "abc123",
  "returnPolicy": "abc123",
  "baseDomesticShippingCost": Decimal,
  "domesticShippingFreeThreshold": Decimal,
  "baseInternationalShippingCost": Decimal,
  "internationalShippingFreeThreshold": Decimal,
  "internationalShippingEnabled": true,
  "bsb": "xyz789",
  "accountNumber": "abc123",
  "accountName": "xyz789",
  "marketplaceShippingRulesEnabled": false,
  "pdfFooterText": "abc123",
  "storeImages": [ImageInput],
  "logo": ImageInput,
  "address": AddressInput,
  "metadata": [KeyValueInput],
  "customFields": [CustomFieldValueInput],
  "enableAdvertAutoMapping": true,
  "invoiceDispatchDaysThreshold": 123
}

Types

SellerUpdateMutationInput

Description

Autogenerated input type of SellerUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`attributes` - `SellerUpdateInput`	Attributes to assign to the seller. Default = `null`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": "4",
  "attributes": SellerUpdateInput
}

Types

SellerUpdateMutationPayload

Description

Autogenerated return type of SellerUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`seller` - `Seller`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "seller": Seller,
  "status": 987
}

Types

SellersConnection

Description

The connection type for Seller.

Fields

Field Name	Description
`edges` - `[SellerEdge]`	A list of edges.
`nodes` - `[Seller]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [SellerEdge],
  "nodes": [Seller],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

SellersForChatsConnection

Description

The connection type for Seller.

Fields

Field Name	Description
`edges` - `[SellersForChatsEdge]`	A list of edges.
`nodes` - `[Seller]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [SellersForChatsEdge],
  "nodes": [Seller],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

SellersForChatsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Seller`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Seller
}

Types

SellersWhereSort

Description

Attributes for sorting sellers

Fields

Input Field	Description
`fields` - `[SellersWhereSortFieldEnum!]!`	Fields to sort sellers. Default = `[CREATED_AT]`
`ordering` - `SortOrderingEnum`	Ordering to sort the results. Default = `ASCENDING`

Example

{"fields": ["CREATED_AT"], "ordering": "ASCENDING"}

Types

SellersWhereSortFieldEnum

Description

The field that is used to sort sellers

Values

Enum Value	Description
`CREATED_AT`
`BUSINESS_NAME`
`SLA_RATING`

Example

"CREATED_AT"

Types

SendgridSettings

Description

Sendgrid settings

Fields

Field Name	Description
`apiKey` - `String`
`category` - `CategoryTypeEnum!`
`description` - `String!`
`edmEnabled` - `Boolean!`
`logoUrl` - `String!`
`providerHandle` - `String!`
`providerName` - `String!`
`status` - `StatusTypeEnum!`
`useLegacyCampaigns` - `Boolean`

Example

{
  "apiKey": "xyz789",
  "category": "RATINGS_AND_REVIEWS",
  "description": "abc123",
  "edmEnabled": false,
  "logoUrl": "abc123",
  "providerHandle": "abc123",
  "providerName": "abc123",
  "status": "AVAILABLE",
  "useLegacyCampaigns": false
}

Types

SendgridSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of SendgridSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`apiKey` - `String!`	SendGrid API key.
`useLegacyCampaigns` - `Boolean!`	Use SendGrid legacy Marketing Campaigns API?

Example

{
  "clientMutationId": "xyz789",
  "apiKey": "xyz789",
  "useLegacyCampaigns": true
}

Types

SendgridSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of SendgridSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sendgridSettings` - `SendgridSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "sendgridSettings": SendgridSettings,
  "status": 987
}

Types

SendgridSettingsDeleteMutationInput

Description

Autogenerated input type of SendgridSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

SendgridSettingsDeleteMutationPayload

Description

Autogenerated return type of SendgridSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sendgridSettings` - `SendgridSettings`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "sendgridSettings": SendgridSettings,
  "status": 123
}

Types

SeoContent

Description

SEO specific content for a particular page. Eg. advert search page

Fields

Field Name	Description
`contentAboveHtml` - `String!`	Content to use above the main content of the page
`contentBelowHtml` - `String!`	Content to use below the main content of the page
`description` - `String!`	Text for use as the page description
`heading` - `String!`	Text for use as the content of the main heading on the page
`id` - `ID!`
`title` - `String!`	Text for use as the page title

Example

{
  "contentAboveHtml": "xyz789",
  "contentBelowHtml": "xyz789",
  "description": "xyz789",
  "heading": "abc123",
  "id": 4,
  "title": "xyz789"
}

Types

SessionData

Description

Properties of the current session

Fields

Field Name	Description
`adminLoggedIn` - `Boolean!`	True if an admin is logged in

Example

{"adminLoggedIn": false}

Types

SessionLocationInformationUpdateMutationInput

Description

Autogenerated input type of SessionLocationInformationUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`postcode` - `String`	Postcode for filtering search results
`regionName` - `String`	Region name for filtering search results
`locationSlug` - `String`	Location slug for filtering search results
`showLocationModal` - `Boolean!`	True if we want to show the location modal

Example

{
  "clientMutationId": "abc123",
  "postcode": "xyz789",
  "regionName": "abc123",
  "locationSlug": "abc123",
  "showLocationModal": false
}

Types

SessionLocationInformationUpdateMutationPayload

Description

Autogenerated return type of SessionLocationInformationUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`locationSlug` - `String`
`postcode` - `String`
`regionName` - `String`
`showLocationModal` - `String`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "locationSlug": "abc123",
  "postcode": "xyz789",
  "regionName": "xyz789",
  "showLocationModal": "xyz789",
  "status": 987
}

Types

SessionTokenLogOutMutationInput

Description

Autogenerated input type of SessionTokenLogOutMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

SessionTokenLogOutMutationPayload

Description

Autogenerated return type of SessionTokenLogOutMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`loggedOut` - `Boolean`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "loggedOut": true,
  "status": 123
}

Types

Shipment

Description

Shipment tracking information.

Fields

Field Name	Description
`carrier` - `String!`	Carrier
`createdAt` - `ISO8601DateTime!`
`dispatchedAt` - `ISO8601DateTime!`	The date the shipment was dispatched.
`externalIds` - `[ExternalID!]!`
`homepageLink` - `String`	Homepage Link URL
`id` - `ID!`
`invoice` - `Invoice!`
`legacyId` - `Int!`
`metadata` - `[Metadatum!]!`	Metadata key/values
`note` - `String`	Note on the shipment
`shippedFrom` - `Address`	Where the item was shipped from (Seller only)
`shippedItems` - `[ShippedItem!]`
`statusLog` - `ShipmentStatusConnection`
Arguments `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.
`trackingLink` - `String`	Tracking Link URL
`trackingNumber` - `String!`	Tracking #
`updatedAt` - `ISO8601DateTime!`

Example

{
  "carrier": "xyz789",
  "createdAt": ISO8601DateTime,
  "dispatchedAt": ISO8601DateTime,
  "externalIds": [ExternalID],
  "homepageLink": "abc123",
  "id": "4",
  "invoice": Invoice,
  "legacyId": 123,
  "metadata": [Metadatum],
  "note": "abc123",
  "shippedFrom": Address,
  "shippedItems": [ShippedItem],
  "statusLog": ShipmentStatusConnection,
  "trackingLink": "xyz789",
  "trackingNumber": "xyz789",
  "updatedAt": ISO8601DateTime
}

Types

ShipmentAddressCreateMutationInput

Description

Autogenerated input type of ShipmentAddressCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`address` - `AddressInput!`
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise

Example

{
  "clientMutationId": "xyz789",
  "address": AddressInput,
  "sellerId": "4"
}

Types

ShipmentAddressCreateMutationPayload

Description

Autogenerated return type of ShipmentAddressCreateMutation.

Fields

Field Name	Description
`address` - `Address`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "address": Address,
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

ShipmentAddressSortMutationInput

Description

Autogenerated input type of ShipmentAddressSortMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`addressIds` - `[ID!]!`
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise

Example

{
  "clientMutationId": "xyz789",
  "addressIds": ["4"],
  "sellerId": 4
}

Types

ShipmentAddressSortMutationPayload

Description

Autogenerated return type of ShipmentAddressSortMutation.

Fields

Field Name	Description
`addresses` - `[Address!]`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "addresses": [Address],
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987
}

Types

ShipmentCarrier

Description

Shipment carriers available to assign to a shipment.

Fields

Field Name	Description
`homepageUrl` - `String`	The url for the homepage of the shipment carrier website
`id` - `ID!`
`name` - `String!`	The name of the Shipment Carrier
`trackingUrl` - `String`	The base tracking url for the carrier, used in combination with a tracking number.

Example

{
  "homepageUrl": "xyz789",
  "id": 4,
  "name": "abc123",
  "trackingUrl": "abc123"
}

Types

ShipmentCarrierConnection

Description

The connection type for ShipmentCarrier.

Fields

Field Name	Description
`edges` - `[ShipmentCarrierEdge]`	A list of edges.
`nodes` - `[ShipmentCarrier]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShipmentCarrierEdge],
  "nodes": [ShipmentCarrier],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ShipmentCarrierEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShipmentCarrier`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ShipmentCarrier
}

Types

ShipmentCreateMutationInput

Description

Autogenerated input type of ShipmentCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`invoiceId` - `ID!`	ID of the invoice.
`shippedItems` - `[ShippedItemInput!]!`
`postageCarrierId` - `ID!`
`dispatchedAt` - `ISO8601Date!`
`trackingNumber` - `String!`
`shippedFromId` - `ID`	See Seller.shipmentAddresses for available address ids.
`note` - `String`

Example

{
  "clientMutationId": "abc123",
  "invoiceId": "4",
  "shippedItems": [ShippedItemInput],
  "postageCarrierId": "4",
  "dispatchedAt": ISO8601Date,
  "trackingNumber": "xyz789",
  "shippedFromId": 4,
  "note": "abc123"
}

Types

ShipmentCreateMutationPayload

Description

Autogenerated return type of ShipmentCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shipment` - `Shipment`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shipment": Shipment,
  "status": 123
}

Types

ShipmentStatus

Description

Shipment status log.

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`
`id` - `ID!`
`shipment` - `ShipmentUnion!`
`status` - `ShipmentStatusEnum!`

Example

{
  "createdAt": ISO8601DateTime,
  "id": "4",
  "shipment": ReturnShipment,
  "status": "InfoReceived"
}

Types

ShipmentStatusConnection

Description

The connection type for ShipmentStatus.

Fields

Field Name	Description
`edges` - `[ShipmentStatusEdge]`	A list of edges.
`nodes` - `[ShipmentStatus]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShipmentStatusEdge],
  "nodes": [ShipmentStatus],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

ShipmentStatusCreateMutationInput

Description

Autogenerated input type of ShipmentStatusCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shipmentId` - `ID!`
`status` - `ShipmentStatusEnum!`

Example

{
  "clientMutationId": "abc123",
  "shipmentId": "4",
  "status": "InfoReceived"
}

Types

ShipmentStatusCreateMutationPayload

Description

Autogenerated return type of ShipmentStatusCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shipmentStatus` - `ShipmentStatus`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shipmentStatus": ShipmentStatus,
  "status": 123
}

Types

ShipmentStatusEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShipmentStatus`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ShipmentStatus
}

Types

ShipmentStatusEnum

Values

Enum Value	Description
`InfoReceived`	Carrier has received request from shipper and is about to pick up the shipment.
`InTransit`	Carrier has accepted or picked up shipment from shipper. The shipment is on the way.
`OutForDelivery`	Carrier is about to deliver the shipment , or it is ready to pickup.
`AttemptFail`	Carrier attempted to deliver but failed, and usually leaves a notice and will try to deliver again.
`Delivered`	The shipment was delivered successfully.
`AvailableForPickup`	The package arrived at a pickup point near you and is available for pickup.
`Exception`	Custom hold, undelivered, returned shipment to sender or any shipping exceptions.
`Expired`	Shipment has no tracking information for 30 days since added.
`Pending`	New shipments added that are pending to track, or new shipments without tracking information available yet.

Example

"InfoReceived"

Types

ShipmentUnion

Types

Union Types
`ReturnShipment`
`Shipment`

Example

ReturnShipment

Types

ShipmentUpdateMutationInput

Description

Autogenerated input type of ShipmentUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shipmentId` - `ID!`	ID of the shipment.
`postageCarrierId` - `ID`
`dispatchedAt` - `ISO8601DateTime`
`trackingNumber` - `String`
`shippedFromId` - `ID`	See Seller.shipmentAddresses for available address ids.
`note` - `String`

Example

{
  "clientMutationId": "xyz789",
  "shipmentId": "4",
  "postageCarrierId": "4",
  "dispatchedAt": ISO8601DateTime,
  "trackingNumber": "abc123",
  "shippedFromId": "4",
  "note": "abc123"
}

Types

ShipmentUpdateMutationPayload

Description

Autogenerated return type of ShipmentUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shipment` - `Shipment`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shipment": Shipment,
  "status": 987
}

Types

ShippedItem

Description

Quantity and LineItem which has been shipped as part of a parent Shipment.

Fields

Field Name	Description
`id` - `ID!`
`lineItem` - `LineItem!`	LineItem which has had the quantity of items shipped
`quantity` - `Int!`

Example

{
  "id": "4",
  "lineItem": LineItem,
  "quantity": 987
}

Types

ShippedItemInput

Fields

Input Field	Description
`quantity` - `Int!`
`lineItemId` - `ID!`	LineItem which has had the quantity of items shipped

Example

{"quantity": 123, "lineItemId": "4"}

Types

ShippingOption

Description

A shipping rule that might apply to a certain variant

Fields

Field Name	Description
`description` - `String`	Description for the shipping rule
`id` - `ID!`
`name` - `String!`	The name used to identify the shipping rule
`seller` - `Seller`	The seller who created the shipping rule. If null then it was created by the marketplace owner
`shippingProfiles` - `ShippingProfileConnection`
Arguments `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.
`shippingRates` - `ShippingRateConnection`
Arguments `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.
`shippingZones` - `ShippingZoneConnection`
Arguments `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.
`type` - `String!`	The type of shipping rule. Returns either 'marketplace' or 'seller'
`updatedAt` - `ISO8601DateTime!`

Example

{
  "description": "abc123",
  "id": "4",
  "name": "abc123",
  "seller": Seller,
  "shippingProfiles": ShippingProfileConnection,
  "shippingRates": ShippingRateConnection,
  "shippingZones": ShippingZoneConnection,
  "type": "abc123",
  "updatedAt": ISO8601DateTime
}

Types

ShippingOptionConnection

Description

The connection type for ShippingOption.

Fields

Field Name	Description
`edges` - `[ShippingOptionEdge]`	A list of edges.
`nodes` - `[ShippingOption]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShippingOptionEdge],
  "nodes": [ShippingOption],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ShippingOptionDeleteMutationInput

Description

Autogenerated input type of ShippingOptionDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the advert to mark as deleted

Example

{"clientMutationId": "xyz789", "id": 4}

Types

ShippingOptionDeleteMutationPayload

Description

Autogenerated return type of ShippingOptionDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingOption` - `ShippingOption`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippingOption": ShippingOption,
  "status": 123
}

Types

ShippingOptionEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShippingOption`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ShippingOption
}

Types

ShippingOptionFilters

Description

Attributes for filtering shipping options

Fields

Input Field	Description
`updatedSince` - `ISO8601DateTime`	ShippingOptions updated since this time. Default = `null`
`updatedUntil` - `ISO8601DateTime`	ShippingOptions updated until this time. Default = `null`

Example

{
  "updatedSince": ISO8601DateTime,
  "updatedUntil": ISO8601DateTime
}

Types

ShippingOptionUpsertInput

Fields

Input Field	Description
`name` - `String!`
`description` - `String`
`shippingZoneIds` - `[ID!]!`
`shippingProfileIds` - `[ID!]!`
`shippingRateIds` - `[ID!]!`

Example

{
  "name": "abc123",
  "description": "abc123",
  "shippingZoneIds": ["4"],
  "shippingProfileIds": [4],
  "shippingRateIds": [4]
}

Types

ShippingOptionUpsertMutationInput

Description

Autogenerated input type of ShippingOptionUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shippingOptionId` - `ID`
`sellerId` - `ID`
`attributes` - `ShippingOptionUpsertInput!`	Attributes to assign to the shipping rule.

Example

{
  "clientMutationId": "xyz789",
  "shippingOptionId": 4,
  "sellerId": 4,
  "attributes": ShippingOptionUpsertInput
}

Types

ShippingOptionUpsertMutationPayload

Description

Autogenerated return type of ShippingOptionUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingOption` - `ShippingOption`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippingOption": ShippingOption,
  "status": 987
}

Types

ShippingParcel

Description

Shipping Parcel dimensions and weight.

Fields

Field Name	Description
`depth` - `Float`
`depthInCm` - `Float`	Depth converted from 'distance_unit' to 'cm'
`distanceUnit` - `String!`
`id` - `ID!`
`length` - `Float`
`lengthInCm` - `Float`	Length converted from 'distance_unit' to 'cm'
`massUnit` - `String!`
`weight` - `Float`
`weightInKg` - `Float`	Weight converted from 'mass_unit' to 'kg'
`width` - `Float`
`widthInCm` - `Float`	Width converted from 'distance_unit' to 'cm'

Example

{
  "depth": 123.45,
  "depthInCm": 123.45,
  "distanceUnit": "xyz789",
  "id": 4,
  "length": 987.65,
  "lengthInCm": 123.45,
  "massUnit": "abc123",
  "weight": 123.45,
  "weightInKg": 987.65,
  "width": 987.65,
  "widthInCm": 987.65
}

Types

ShippingParcelDistanceEnum

Description

The distance type as permitted by a Shipping Parcel

Values

Enum Value	Description
`cm`	Distance as Centimeters.
`mm`	Distance as Millimeters.
`m`	Distance as Meters.
`in`	Distance as Inches.
`ft`	Distance as Feet.
`yd`	Distance as Yards.

Example

"cm"

Types

ShippingParcelInput

Fields

Input Field	Description
`weight` - `Float`
`massUnit` - `ShippingParcelMassEnum`	Measurement unit for weight. Null values are not accepted.
`length` - `Float`
`width` - `Float`
`depth` - `Float`
`distanceUnit` - `ShippingParcelDistanceEnum`	Measurement unit for distances. Null values are not accepted.

Example

{
  "weight": 987.65,
  "massUnit": "kg",
  "length": 987.65,
  "width": 987.65,
  "depth": 987.65,
  "distanceUnit": "cm"
}

Types

ShippingParcelMassEnum

Description

The mass type as permitted by a Shipping Parcel.

Values

Enum Value	Description
`kg`	Mass as Kilograms.
`g`	Mass as Grams.
`oz`	Mass as Ounces.
`lb`	Mass as Pounds.

Example

"kg"

Types

ShippingProfile

Description

A shipping rule that might apply to a certain variant

Fields

Field Name	Description
`description` - `String!`	The description used to describe the shipping profile
`id` - `ID!`
`legacyId` - `ID!`	This is the Legacy ID field for Shipping Profiles
`name` - `String!`	The name used to identify the shipping profile

Example

{
  "description": "xyz789",
  "id": "4",
  "legacyId": 4,
  "name": "xyz789"
}

Types

ShippingProfileConnection

Description

The connection type for ShippingProfile.

Fields

Field Name	Description
`edges` - `[ShippingProfileEdge]`	A list of edges.
`nodes` - `[ShippingProfile]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShippingProfileEdge],
  "nodes": [ShippingProfile],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ShippingProfileEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShippingProfile`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ShippingProfile
}

Types

ShippingRate

Description

A shipping rate defined in the marketplace

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`	The name used to identify the shipping rate
`rateCents` - `Int!`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`rateFormatted` - `String!`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`seller` - `Seller`	The seller who created the shipping rate. If null then it was created by the marketplace owner

Example

{
  "id": "4",
  "name": "abc123",
  "rateCents": 987,
  "rateFormatted": "xyz789",
  "seller": Seller
}

Types

ShippingRateConnection

Description

The connection type for ShippingRate.

Fields

Field Name	Description
`edges` - `[ShippingRateEdge]`	A list of edges.
`nodes` - `[ShippingRate]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShippingRateEdge],
  "nodes": [ShippingRate],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ShippingRateCreateOrUpdateMutationInput

Description

Autogenerated input type of ShippingRateCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shippingRateId` - `ID`
`sellerId` - `ID`
`attributes` - `ShippingRateInput!`	Attributes to assign to the shipping rate.

Example

{
  "clientMutationId": "abc123",
  "shippingRateId": "4",
  "sellerId": "4",
  "attributes": ShippingRateInput
}

Types

ShippingRateCreateOrUpdateMutationPayload

Description

Autogenerated return type of ShippingRateCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingRate` - `ShippingRate`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippingRate": ShippingRate,
  "status": 987
}

Types

ShippingRateDeleteMutationInput

Description

Autogenerated input type of ShippingRateDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the shipping rate to delete

Example

{
  "clientMutationId": "xyz789",
  "id": "4"
}

Types

ShippingRateDeleteMutationPayload

Description

Autogenerated return type of ShippingRateDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingRate` - `ShippingRate`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippingRate": ShippingRate,
  "status": 123
}

Types

ShippingRateEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShippingRate`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": ShippingRate
}

Types

ShippingRateInput

Fields

Input Field	Description
`name` - `String!`
`rate` - `Decimal!`

Example

{
  "name": "xyz789",
  "rate": Decimal
}

Types

ShippingZone

Description

A shipping area defined in the marketplace which consists of multiple postcodes

Fields

Field Name	Description
`description` - `String`	Description for the shipping zone
`id` - `ID!`
`name` - `String!`	The name used to identify the shipping zone
`postcodes` - `[String!]`
`seller` - `Seller`	The seller who created the shipping zone. If null then it was created by the marketplace owner

Example

{
  "description": "xyz789",
  "id": "4",
  "name": "abc123",
  "postcodes": ["abc123"],
  "seller": Seller
}

Types

ShippingZoneConnection

Description

The connection type for ShippingZone.

Fields

Field Name	Description
`edges` - `[ShippingZoneEdge]`	A list of edges.
`nodes` - `[ShippingZone]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ShippingZoneEdge],
  "nodes": [ShippingZone],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

ShippingZoneCreateOrUpdateMutationInput

Description

Autogenerated input type of ShippingZoneCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`shippingZoneId` - `ID`
`sellerId` - `ID`
`attributes` - `ShippingZoneInput!`	Attributes to assign to the shipping zone.

Example

{
  "clientMutationId": "abc123",
  "shippingZoneId": "4",
  "sellerId": "4",
  "attributes": ShippingZoneInput
}

Types

ShippingZoneCreateOrUpdateMutationPayload

Description

Autogenerated return type of ShippingZoneCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingZone` - `ShippingZone`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippingZone": ShippingZone,
  "status": 123
}

Types

ShippingZoneDeleteMutationInput

Description

Autogenerated input type of ShippingZoneDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the shipping zone to delete

Example

{"clientMutationId": "abc123", "id": 4}

Types

ShippingZoneDeleteMutationPayload

Description

Autogenerated return type of ShippingZoneDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippingZone` - `ShippingZone`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "shippingZone": ShippingZone,
  "status": 987
}

Types

ShippingZoneEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ShippingZone`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ShippingZone
}

Types

ShippingZoneInput

Fields

Input Field	Description
`name` - `String!`
`description` - `String`
`spreadsheet` - `FileInput`

Example

{
  "name": "abc123",
  "description": "xyz789",
  "spreadsheet": FileInput
}

Types

ShippingZoneSpreadsheetDownloadMutationInput

Description

Autogenerated input type of ShippingZoneSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`format` - `SpreadsheetEnum`
`shippingZoneId` - `ID`	ID of the shipping zone to export. Returns blank template file if not provided.

Example

{
  "clientMutationId": "abc123",
  "format": "XLSX",
  "shippingZoneId": "4"
}

Types

ShippingZoneSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of ShippingZoneSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`shippingZone` - `ShippingZone`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "shippingZone": ShippingZone,
  "status": 123
}

Types

ShippitCredentials

Description

Shippit Credentials

Fields

Field Name	Description
`apiKey` - `String!`
`enabled` - `Boolean!`
`useCalculatedShipping` - `Boolean!`

Example

{
  "apiKey": "abc123",
  "enabled": false,
  "useCalculatedShipping": false
}

Types

ShippitCredentialsUpsertInput

Fields

Input Field	Description
`enabled` - `Boolean`
`apiKey` - `String!`
`useCalculatedShipping` - `Boolean`

Example

{
  "enabled": false,
  "apiKey": "xyz789",
  "useCalculatedShipping": false
}

Types

ShippitCredentialsUpsertMutationInput

Description

Autogenerated input type of ShippitCredentialsUpsertMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`attributes` - `ShippitCredentialsUpsertInput!`	Attributes to assign to Shippit Credentials.

Example

{
  "clientMutationId": "xyz789",
  "sellerId": "4",
  "attributes": ShippitCredentialsUpsertInput
}

Types

ShippitCredentialsUpsertMutationPayload

Description

Autogenerated return type of ShippitCredentialsUpsertMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`shippitCredentials` - `ShippitCredentials`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "shippitCredentials": ShippitCredentials,
  "status": 987
}

Types

SiteConfig

Description

Site configuration properties, particularly for properties that affect more than just one page

Fields

Field Name	Description
`accountSettings` - `AccountSettings!`
`advancedRemittancesEnabled` - `Boolean!`	True if advanced remittances is enabled.
`advertAutomapEnabled` - `Boolean!`	True if advert automap is enabled.
`advertBrandLogoVisible` - `Boolean!`	True if brand logo should be visible on an advert
`advertSettings` - `AdvertSettings!`
`advertTileImageFormat` - `AdvertTileImageFormatEnum!`
`advertTileImageRatio` - `AdvertTileImageRatioEnum!`
`availableAdvertSpreadsheetColumns` - `[String!]!`	List of available columns that can be included in the advert spreadsheet download
`betaRemittancesEnabled` - `Boolean!`	True if beta remittances is enabled. Value is now accessible via the advancedRemittancesEnabled field. This will be removed no earlier than 2024-01-10.
`checkoutEnabled` - `Boolean!`	True if checkout is enabled for this site
`contactDetails` - `ContactDetails!`	Contact details
`contactUsLink` - `TextLink`	Contact us link
`country` - `SiteCountry!`	Site's country info
`customisationSettings` - `CustomisationSettings!`
`displayFavouriteStore` - `Boolean!`	True if favourite store is enabled for the marketplace
`externalAccountSettings` - `ExternalAccountSettings!`
`favouriteStore` - `Int`	Id of the favourite store of the current user
`financeSettings` - `FinanceSettings!`
`googleAnalyticsAccountIds` - `[GoogleAnalyticsTracker!]`	Google Analytics (Universal Analytics) account IDs relevant to the current Vertical (and MStore, when in use)
`googleMaps` - `GoogleMapsCredentials`	Google Maps credentials
`googleRecaptcha` - `GoogleRecaptchaCredentials`	Google reCAPTCHA credentials
`googleTagManagerAccountId` - `String`	Google Tag Manager account ID
`gtagDebugMode` - `Boolean!`	GTag Debug Mode We do not collect analytics data anymore. This field will be removed no earlier than 2024-04-01.
`gtagStreamMeasurementId` - `String`	GTag Stream Measurement ID We do not collect analytics data anymore. This field will be removed no earlier than 2024-04-01.
`hideAdvertTileSellerName` - `Boolean!`	True if seller name should not be visible on adverts
`id` - `ID!`
`liveSiblingCountries` - `[SiteCountry!]`	Other countries with this marketplace (if exist)
`locale` - `String!`	Current vertical's locale
`marketfacerPagesEnabled` - `MarketfacerPagesEnabled`
`memberSettings` - `MemberSettings!`
`officialName` - `String!`	The current site's official business name
`productionEnvironment` - `Boolean!`	True if on production environment
`searchSettings` - `SearchSettings!`
`sellerMfaEnabled` - `Boolean!`	Are sellers allowed to set up multi-factor authentication? feature in development, subject to change without warning
`sellerMfaRequired` - `Boolean!`	Are sellers required to have multi-factor authentication set up? feature in development, subject to change without warning
`showBazaarVoice` - `Boolean!`	Always false Bazaar Voice integration has been removed. This field will be removed no earlier than 2024-01-01.
`showRetailerAddress` - `Boolean!`	True if retailer address can be shown
`siteEmail` - `String!`	The current site's presentational email
`siteName` - `String!`	The current site's presentational name
`sitePhone` - `String!`	The current site's presentational phone
`siteWidePromotion` - `Promotion`	A promotion suitable for use across all pages
`siteWidePromotions` - `[Promotion!]!`	Promotions suitable for use across all pages
`skipConsumerEmails` - `Boolean!`	True if sending emails to consumers is skipped
`socialLinks` - `[SocialLink!]`	Social links (Facebook, Twitter, etc.)
`storeFront` - `Boolean!`	True if the current site is a storefront
`storeNewsletterRecipientLink` - `TextLink`	Store newsletter link
`verifyViaTwilio` - `Boolean!`	True if marketplace has enabled twilio verification
`verticalCode` - `String!`	Internal site name
`verticalLogo` - `VerticalLogo!`
`wishlistEnabled` - `Boolean!`	True if wishlist is enabled for this site
`yotpoSettings` - `YotpoSettingsSiteConfig!`

Example

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

Types

SiteCountry

Description

Site country information

Fields

Field Name	Description
`code` - `String!`	Two-letter UPPERCASE country code, e.g. "DE"
`currencyCode` - `String!`	Currency code, e.g. "AUD"
`id` - `ID!`
`name` - `String!`	Country name, e.g. "Germany"
`nameInLocale` - `String`	Country name in its native locale (if exists), e.g. "Deutschland"
`siteUrl` - `String`	URL of the current vertical's site in this country (if exists)
`taxInclusive` - `Boolean!`	Returns if marketplace is tax inclusive or not
`taxRate` - `Float!`
`taxableCommission` - `Boolean!`	True if commission is taxable for this country

Example

{
  "code": "xyz789",
  "currencyCode": "xyz789",
  "id": 4,
  "name": "abc123",
  "nameInLocale": "abc123",
  "siteUrl": "abc123",
  "taxInclusive": true,
  "taxRate": 987.65,
  "taxableCommission": false
}

Types

SizeMatrix

Fields

Field Name	Description
`brand` - `Brand`
`data` - `JSON`
`id` - `ID!`
`taxon` - `Taxon`

Example

{
  "brand": Brand,
  "data": {},
  "id": 4,
  "taxon": Taxon
}

Types

Slug

Description

Object with fields for constructing URL slugs based on its parent object.

Fields

Field Name	Description
`foreignKeyLabel` - `String!`	Field name for ID of parent object.
`foreignKeyLegacyId` - `Int!`	ID for the foreign table
`node` - `BrandOrTaxon`	A link to the node
`slug` - `String!`

Example

{
  "foreignKeyLabel": "abc123",
  "foreignKeyLegacyId": 123,
  "node": Brand,
  "slug": "abc123"
}

Types

SocialLink

Description

Social link

Fields

Field Name	Description
`rel` - `String`	"rel" value of the link, e.g. "publisher"
`socialNetwork` - `SocialNetworkEnum!`	Name of the social network.
`url` - `String!`

Example

{
  "rel": "xyz789",
  "socialNetwork": "FACEBOOK",
  "url": "abc123"
}

Types

SocialNetworkEnum

Description

Social network names.

Values

Enum Value	Description
`FACEBOOK`
`TWITTER`
`PINTEREST`
`INSTAGRAM`
`LINKEDIN`
`YOUTUBE`

Example

"FACEBOOK"

Types

SortOrderingEnum

Description

Base ordering to sort the results

Values

Enum Value	Description
`ASCENDING`	Sort in ascending order
`DESCENDING`	Sort in descending order

Example

"ASCENDING"

Types

SpreadsheetEnum

Description

Spreadsheet type

Values

Enum Value	Description
`XLSX`
`CSV`

Example

"XLSX"

Types

State

Description

Geographic state

Fields

Field Name	Description
`country` - `Country!`
`id` - `ID!`
`name` - `String!`
`short` - `String!`	Abbreviation of state name.
`slug` - `String!`	Normalized version of state name appropriate for inclusion in URLs

Example

{
  "country": Country,
  "id": 4,
  "name": "xyz789",
  "short": "xyz789",
  "slug": "xyz789"
}

Types

StateInput

Description

Input for associating a state with an address. One argument is required for creation. If more than one argument is given, the first valid argument will define the state (the order is "id", "short", then "name").

Fields

Input Field	Description
`short` - `String`	Abbreviation of the state name.
`name` - `String`	Full name of the state.
`id` - `ID`	Database ID for the given state.

Example

{
  "short": "abc123",
  "name": "abc123",
  "id": "4"
}

Types

StatesConnection

Description

The connection type for State.

Fields

Field Name	Description
`edges` - `[StatesEdge]`	A list of edges.
`nodes` - `[State]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [StatesEdge],
  "nodes": [State],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

StatesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `State`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": State
}

Types

StatusInfo

Description

Data for individual health checks

Fields

Field Name	Description
`message` - `String!`	message about the health check
`name` - `String!`	name of health check
`success` - `Boolean!`	True if pass health check, false if fail
`time` - `Float!`	Time it took to perform the health check

Example

{
  "message": "xyz789",
  "name": "xyz789",
  "success": true,
  "time": 123.45
}

Types

StatusTypeEnum

Description

All statuses for partner integrations.

Values

Enum Value	Description
`AVAILABLE`
`UNAVAILABLE`
`CONNECTED`
`ERROR`

Example

"AVAILABLE"

Types

StockLevelsSpreadsheetDownloadMutationInput

Description

Autogenerated input type of StockLevelsSpreadsheetDownloadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`format` - `SpreadsheetEnum`

Example

{
  "clientMutationId": "xyz789",
  "sellerId": 4,
  "format": "XLSX"
}

Types

StockLevelsSpreadsheetDownloadMutationPayload

Description

Autogenerated return type of StockLevelsSpreadsheetDownloadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`export` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "export": ImportExport,
  "status": 987
}

Types

StockLevelsSpreadsheetUploadMutationInput

Description

Autogenerated input type of StockLevelsSpreadsheetUploadMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`spreadsheet` - `FileInput!`
`sellerId` - `ID`	ID of the seller. May be omitted if using a seller api key, but is required otherwise

Example

{
  "clientMutationId": "abc123",
  "spreadsheet": FileInput,
  "sellerId": 4
}

Types

StockLevelsSpreadsheetUploadMutationPayload

Description

Autogenerated return type of StockLevelsSpreadsheetUploadMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`import` - `ImportExport`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "import": ImportExport,
  "status": 123
}

Types

StoredPaymentMethod

Description

Sellers stored payment method settings

Fields

Field Name	Description
`creditCardExpiryDate` - `String`
`creditCardLast4` - `String`
`creditCardType` - `String`
`imageUrl` - `String`
`paymentMethodType` - `String`
`paypalEmail` - `String`
`providerHandle` - `String`
`status` - `String`

Example

{
  "creditCardExpiryDate": "abc123",
  "creditCardLast4": "abc123",
  "creditCardType": "abc123",
  "imageUrl": "abc123",
  "paymentMethodType": "abc123",
  "paypalEmail": "xyz789",
  "providerHandle": "xyz789",
  "status": "abc123"
}

Types

String

Description

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

Subscription

Description

Email marketing subscription info

Fields

Field Name	Description
`email` - `String!`	Email
`firstName` - `String`	First name
`lastName` - `String`	Last name
`postcode` - `String`	Postcode
`sourceType` - `String`	Source type - eg. Checkout Subscribe, Email Seller and Account
`subscribedAt` - `ISO8601DateTime!`	Subscribed At

Example

{
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "postcode": "abc123",
  "sourceType": "abc123",
  "subscribedAt": ISO8601DateTime
}

Types

SubscriptionsConnection

Description

The connection type for Subscription.

Fields

Field Name	Description
`edges` - `[SubscriptionsEdge]`	A list of edges.
`nodes` - `[Subscription]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [SubscriptionsEdge],
  "nodes": [Subscription],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

SubscriptionsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Subscription`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Subscription
}

Types

SuggestionsUnion

Types

Union Types
`Brand`
`OptionValue`
`Taxon`

Example

Brand

Types

TOTP

Description

A TOTP Authenticator

Fields

Field Name	Description
`id` - `ID!`
`provisioningQrcodeSvg` - `String!`	QR code SVG to permit enrolment into an authenticator app

Example

{"id": 4, "provisioningQrcodeSvg": "abc123"}

Types

TaxCode

Description

Tax code

Fields

Field Name	Description
`code` - `String!`
`id` - `ID!`
`name` - `String!`

Example

{
  "code": "abc123",
  "id": 4,
  "name": "xyz789"
}

Types

TaxCodeCreateOrUpdateMutationInput

Description

Autogenerated input type of TaxCodeCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`name` - `String!`	Tax code name.
`code` - `String!`	Tax code.

Example

{
  "clientMutationId": "abc123",
  "name": "abc123",
  "code": "xyz789"
}

Types

TaxCodeCreateOrUpdateMutationPayload

Description

Autogenerated return type of TaxCodeCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`taxCode` - `TaxCode`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "taxCode": TaxCode
}

Types

Taxon

Description

Category or Sub-category for organising adverts. Has a tree-like structure with parents and children.

Fields

Field Name	Description
`additionalSearchTerms` - `String`	Alternative term that could be used to reference this taxon.
`advertSuggestions` - `AdvertsConnection!`	The adverts that belong to this taxon. Experimental, will change without notice.
Arguments `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. `includeLinkedToDescendants` - `Boolean` Request adverts associated with taxon or its child taxons.
`adverts` - `AdvertsConnection!`	The adverts that belong to this taxon.
Arguments `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. `onlineOnly` - `Boolean` Request only online adverts associated with the taxon. Default is true. `includeLinkedToDescendants` - `Boolean` Request adverts associated with taxon or its child taxons.
`children` - `TaxonsConnection!`
Arguments `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. `showOnlineOnly` - `Boolean` Request only taxons that have online adverts associated with them.
`description` - `String`
`displayName` - `String!`
`externalIds` - `[ExternalID!]!`
`googleCategory` - `String`	Google category associated to the taxon - supplied to the Google Content API
`hasBrands` - `Boolean!`	A boolean for whether a taxon has brands or not
`id` - `ID!`
`image` - `Image`	The display image for each taxon.
`legacyId` - `Int!`
`maxPurchaseQuantity` - `Int`	Maximum purchase quantity allowed for successful checkout
`minPurchaseQuantity` - `Int`	Minimum purchase quantity required for successful checkout
`parent` - `Taxon`
`prototype` - `Prototype!`
`taxCode` - `String`	The tax code the category falls under
`taxRate` - `Float`	The tax rate applied to this category
`taxonType` - `TaxonTypeEnum!`
`title` - `String!`	Taxon title. Mostly for internal organisation.
`treeName` - `String!`	Taxon tree formatted to string
Arguments `separator` - `String` Separator for taxon hierarchy tree
`urlSlug` - `String!`	The URL subpath associated with the given taxon. Mostly used for building URLs for advert search results.

Example

{
  "additionalSearchTerms": "abc123",
  "advertSuggestions": AdvertsConnection,
  "adverts": AdvertsConnection,
  "children": TaxonsConnection,
  "description": "xyz789",
  "displayName": "xyz789",
  "externalIds": [ExternalID],
  "googleCategory": "xyz789",
  "hasBrands": false,
  "id": "4",
  "image": Image,
  "legacyId": 987,
  "maxPurchaseQuantity": 123,
  "minPurchaseQuantity": 123,
  "parent": Taxon,
  "prototype": Prototype,
  "taxCode": "abc123",
  "taxRate": 987.65,
  "taxonType": "PRODUCT",
  "title": "xyz789",
  "treeName": "abc123",
  "urlSlug": "abc123"
}

Types

TaxonConnection

Description

The connection type for Taxon.

Fields

Field Name	Description
`edges` - `[TaxonEdge]`	A list of edges.
`nodes` - `[Taxon]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [TaxonEdge],
  "nodes": [Taxon],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

TaxonCreateOrUpdateMutationInput

Description

Autogenerated input type of TaxonCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID`	ID of the Taxon to update
`displayName` - `String`	Taxon name. eg. 'Shoes'
`title` - `String`	Taxon title. Mostly for internal organisation
`prototypeId` - `ID`	ID of the associated Prototype
`parentId` - `ID`	ID of the parent Taxon
`externalIds` - `[KeyValueInput!]`	IDs used by external systems to fetch Taxons

Example

{
  "clientMutationId": "xyz789",
  "id": "4",
  "displayName": "xyz789",
  "title": "abc123",
  "prototypeId": "4",
  "parentId": 4,
  "externalIds": [KeyValueInput]
}

Types

TaxonCreateOrUpdateMutationPayload

Description

Autogenerated return type of TaxonCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`taxon` - `Taxon`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "taxon": Taxon
}

Types

TaxonEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Taxon`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Taxon
}

Types

TaxonFilterOption

Description

Minimal subset of Taxon type which can be used to build a taxonomy filter for advert search

Fields

Field Name	Description
`count` - `Int!`	The number of adverts associated with each taxon filter option
`displayName` - `String!`
`hasChildren` - `Boolean!`	True if the taxon filter option has child taxon filter options
`id` - `ID!`
`parentId` - `ID`
`urlSlug` - `String!`	The URL subpath associated with the given taxon. Mostly used for building URLs for advert search results.

Example

{
  "count": 987,
  "displayName": "xyz789",
  "hasChildren": true,
  "id": 4,
  "parentId": "4",
  "urlSlug": "xyz789"
}

Types

TaxonTypeEnum

Description

Category label for the taxon. Represents different types of adverts.

Values

Enum Value	Description
`PRODUCT`
`EVENT`
`SERVICE`

Example

"PRODUCT"

Types

TaxonsConnection

Description

The connection type for Taxon.

Fields

Field Name	Description
`edges` - `[TaxonsEdge]`	A list of edges.
`nodes` - `[Taxon]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [TaxonsEdge],
  "nodes": [Taxon],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

TaxonsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Taxon`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Taxon
}

Types

TextLink

Description

Text link

Fields

Field Name	Description
`newWindow` - `Boolean`	If true, open link in a new window
`text` - `String!`	Link text
`url` - `String!`

Example

{
  "newWindow": true,
  "text": "xyz789",
  "url": "abc123"
}

Types

TextQuerySuggestion

Description

Object with taxon or brand info returned by autocomplete functionality when a user is typing into a search field.

Fields

Field Name	Description
`name` - `String!`
`parentName` - `String`	Name of the suggested object's parent.
`slugs` - `[Slug!]!`

Example

{
  "name": "abc123",
  "parentName": "xyz789",
  "slugs": [Slug]
}

Types

Theme

Description

Site-wide attributes used for theming, such as colours and fonts.

Fields

Field Name	Description
`bodyFontFamily` - `String!`	Font family for body/paragraph text.
`brandColor` - `String!`	Primary brand color for your site.
`brandTextColor` - `String!`	Text color to use when the brand color is the background color
`ecommerceActionColor` - `String!`	Color used for ecommerce action buttons (e.g. add item to cart).
`ecommerceActionTextColor` - `String!`	Text color used for ecommerce action buttons (e.g. add item to cart).
`fontUrl` - `String!`	URL for loading the relevant fonts.
`footerBackgroundColor` - `String!`	Background color for the main footer.
`footerLinkColor` - `String!`	Color for links in the main footer.
`footerTextColor` - `String!`	Color for text in the main footer.
`headerBackgroundColor` - `String!`	Background color for the main header.
`headerBorderColor` - `String!`	Border color used to separate elements within the main header.
`headerTextColor` - `String!`	Color for text in the main header.
`headingFontFamily` - `String!`	Font family for header/title text.
`leadActionColor` - `String!`	Color used for lead generation action buttons (e.g. contact seller, show address).
`leadActionTextColor` - `String!`	Text color used for lead generation action buttons (e.g. contact seller, show address).
`primaryActionColor` - `String!`	Color used for primary action buttons (e.g. submit a form, or proceed to checkout).
`primaryActionTextColor` - `String!`	Text color used for primary action buttons (e.g. submit a form, or proceed to checkout).
`promotionBannerColor` - `String!`	Color used for promotions and featured banners.
`promotionBannerTextColor` - `String!`	Text color used for promotions and featured banners.

Example

{
  "bodyFontFamily": "abc123",
  "brandColor": "xyz789",
  "brandTextColor": "abc123",
  "ecommerceActionColor": "abc123",
  "ecommerceActionTextColor": "xyz789",
  "fontUrl": "abc123",
  "footerBackgroundColor": "abc123",
  "footerLinkColor": "xyz789",
  "footerTextColor": "xyz789",
  "headerBackgroundColor": "abc123",
  "headerBorderColor": "xyz789",
  "headerTextColor": "xyz789",
  "headingFontFamily": "abc123",
  "leadActionColor": "xyz789",
  "leadActionTextColor": "abc123",
  "primaryActionColor": "xyz789",
  "primaryActionTextColor": "abc123",
  "promotionBannerColor": "abc123",
  "promotionBannerTextColor": "xyz789"
}

Types

ThirdPartyLoginLink

Description

Third party login link

Fields

Field Name	Description
`link` - `String!`	URL to GET in order to initiate a login with this provider
`name` - `String!`	Name of the provider
`scope` - `ThirdPartyLoginLinkScopeEnum!`	What kind of accounts can log in with this provider

Example

{
  "link": "xyz789",
  "name": "xyz789",
  "scope": "OPERATOR"
}

Types

ThirdPartyLoginLinkConnection

Description

The connection type for ThirdPartyLoginLink.

Fields

Field Name	Description
`edges` - `[ThirdPartyLoginLinkEdge]`	A list of edges.
`nodes` - `[ThirdPartyLoginLink]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [ThirdPartyLoginLinkEdge],
  "nodes": [ThirdPartyLoginLink],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

ThirdPartyLoginLinkEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `ThirdPartyLoginLink`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": ThirdPartyLoginLink
}

Types

ThirdPartyLoginLinkScopeEnum

Description

Third party login scope

Values

Enum Value	Description
`OPERATOR`
`SELLER`

Example

"OPERATOR"

Types

Translation

Description

Object with translation key path and value.

Fields

Field Name	Description
`translation` - `String!`
`translationKeyPath` - `String!`

Example

{
  "translation": "abc123",
  "translationKeyPath": "abc123"
}

Types

TranslationInput

Description

The YAML path and param values for a given translation.

Fields

Input Field	Description
`translationKeyPath` - `String!`	Full path to the requested translation (e.g. "root_key.branch_1.branch_t.translation"
`translationParams` - `[KeyValueInput!]`	Key-Value pairs to pass named parameters to translations when relevant.

Example

{
  "translationKeyPath": "xyz789",
  "translationParams": [KeyValueInput]
}

Types

UnpublishedAdvert

Description

An unpublished advert

Fields

Field Name	Description
`details` - `Advert!`	Details for this advert. This is generally not necessary
`externalIds` - `[ExternalID!]!`
`id` - `ID!`
`legacyId` - `Int!`
`updatedAt` - `ISO8601DateTime!`
`variants` - `AllAdvertVariantConnection!`
Arguments `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

{
  "details": Advert,
  "externalIds": [ExternalID],
  "id": "4",
  "legacyId": 987,
  "updatedAt": ISO8601DateTime,
  "variants": AllAdvertVariantConnection
}

Types

UpdatedCartsConnection

Description

The connection type for Cart.

Fields

Field Name	Description
`edges` - `[UpdatedCartsEdge]`	A list of edges.
`nodes` - `[Cart]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [UpdatedCartsEdge],
  "nodes": [Cart],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

UpdatedCartsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Cart`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Cart
}

Types

UpdatedOrdersConnection

Description

The connection type for Order.

Fields

Field Name	Description
`edges` - `[UpdatedOrdersEdge]`	A list of edges.
`nodes` - `[Order]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [UpdatedOrdersEdge],
  "nodes": [Order],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

UpdatedOrdersEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Order`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Order
}

Types

UpdatedRefundRequestsConnection

Description

The connection type for RefundRequest.

Fields

Field Name	Description
`edges` - `[UpdatedRefundRequestsEdge]`	A list of edges.
`nodes` - `[RefundRequest]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [UpdatedRefundRequestsEdge],
  "nodes": [RefundRequest],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

UpdatedRefundRequestsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `RefundRequest`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": RefundRequest
}

Types

User

Description

Properties of the currently logged in User

Fields

Field Name	Description
`cartSessionId` - `ID`	Cart session id for the current user
`emailAddress` - `String`	A users email address
`firstName` - `String`	A users first name
`id` - `ID!`
`legacyId` - `Int`	The id used to identify the user
`locationData` - `UserLocation!`	Location session data on user
`loggedIn` - `Boolean!`	Whether the current user is logged in
`selectedCurrency` - `Currency!`
`seller` - `Seller`
`surname` - `String`	A users surname
`termsAndConditionsAcceptedAt` - `ISO8601DateTime`	The date user accepted terms and conditions for marketplacer
`userAccountName` - `String`	Username displayed on navbar for current user
`username` - `String`	A users username

Example

{
  "cartSessionId": 4,
  "emailAddress": "xyz789",
  "firstName": "abc123",
  "id": "4",
  "legacyId": 987,
  "locationData": UserLocation,
  "loggedIn": true,
  "selectedCurrency": Currency,
  "seller": Seller,
  "surname": "xyz789",
  "termsAndConditionsAcceptedAt": ISO8601DateTime,
  "userAccountName": "abc123",
  "username": "xyz789"
}

Types

UserConnection

Description

The connection type for User.

Fields

Field Name	Description
`edges` - `[UserEdge]`	A list of edges.
`nodes` - `[User]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [UserEdge],
  "nodes": [User],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

UserCreateInput

Description

Attributes for creating a user.

Fields

Input Field	Description
`firstName` - `String!`	A users first name
`surname` - `String!`	A users surname
`emailAddress` - `String!`	A users email address, also used as login username
`password` - `String`	The password for the user. (Must match repeatPassword)
`passwordConfirmation` - `String`	The password for the user. (Must match password)

Example

{
  "firstName": "abc123",
  "surname": "abc123",
  "emailAddress": "abc123",
  "password": "abc123",
  "passwordConfirmation": "xyz789"
}

Types

UserCreateMutationInput

Description

Autogenerated input type of UserCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `ID`
`attributes` - `UserCreateSecondaryInput!`	Attributes to assign to the new user.

Example

{
  "clientMutationId": "abc123",
  "sellerId": 4,
  "attributes": UserCreateSecondaryInput
}

Types

UserCreateMutationPayload

Description

Autogenerated return type of UserCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`user` - `User`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123,
  "user": User
}

Types

UserCreateSecondaryInput

Description

Attributes for creating a user. (secondary for seller).

Fields

Input Field	Description
`username` - `String`	A users username
`firstName` - `String!`	A users first name
`surname` - `String!`	A users surname
`emailAddress` - `String!`	A users email address, also used as login username

Example

{
  "username": "xyz789",
  "firstName": "xyz789",
  "surname": "abc123",
  "emailAddress": "abc123"
}

Types

UserCurrencySelectMutationInput

Description

Autogenerated input type of UserCurrencySelectMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`currencyCode` - `String!`	User selected currency code

Example

{
  "clientMutationId": "xyz789",
  "currencyCode": "abc123"
}

Types

UserCurrencySelectMutationPayload

Description

Autogenerated return type of UserCurrencySelectMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`currencyChangedNotice` - `String`
`errors` - `[ValidationError!]`
`selectedCurrency` - `Currency`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "currencyChangedNotice": "xyz789",
  "errors": [ValidationError],
  "selectedCurrency": Currency,
  "status": 987
}

Types

UserDeleteMutationInput

Description

Autogenerated input type of UserDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`userId` - `ID!`

Example

{
  "clientMutationId": "abc123",
  "userId": "4"
}

Types

UserDeleteMutationPayload

Description

Autogenerated return type of UserDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

UserEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `User`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": User
}

Types

UserInput

Description

Attributes for updating a user.

Fields

Input Field	Description
`username` - `String`	A users username
`firstName` - `String`	A users first name
`surname` - `String`	A users surname
`emailAddress` - `String`	A users email address

Example

{
  "username": "xyz789",
  "firstName": "abc123",
  "surname": "xyz789",
  "emailAddress": "xyz789"
}

Types

UserLocation

Description

Location data saved on the user session

Fields

Field Name	Description
`locationSlug` - `String`	Location slug for filtering search results
`postcode` - `String`	Postcode for filtering search results
`regionName` - `String`	Region name for filtering search results
`showLocationModal` - `Boolean!`	True if we want to show the location modal

Example

{
  "locationSlug": "xyz789",
  "postcode": "abc123",
  "regionName": "abc123",
  "showLocationModal": true
}

Types

UserLogOutMutationInput

Description

Autogenerated input type of UserLogOutMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

UserLogOutMutationPayload

Description

Autogenerated return type of UserLogOutMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`loggedOut` - `Boolean`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "loggedOut": false,
  "status": 123
}

Types

UserLoginTokenMutationInput

Description

Autogenerated input type of UserLoginTokenMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`token` - `String!`	The SSO token

Example

{
  "clientMutationId": "abc123",
  "token": "xyz789"
}

Types

UserLoginTokenMutationPayload

Description

Autogenerated return type of UserLoginTokenMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sessionToken` - `String`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "sessionToken": "xyz789",
  "status": 123
}

Types

UserLoginUsernameMutationInput

Description

Autogenerated input type of UserLoginUsernameMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`username` - `String!`	The user's username
`password` - `String!`	The user's password
`mfaToken` - `String`	The user's MFA token

Example

{
  "clientMutationId": "xyz789",
  "username": "xyz789",
  "password": "abc123",
  "mfaToken": "xyz789"
}

Types

UserLoginUsernameMutationPayload

Description

Autogenerated return type of UserLoginUsernameMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`sessionToken` - `String`
`status` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "sessionToken": "xyz789",
  "status": 987
}

Types

UserUpdateFavouriteStoreMutationInput

Description

Autogenerated input type of UserUpdateFavouriteStoreMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`sellerId` - `String!`	Id of the seller. The seller id will be used to update the user's favourite store. When the seller id matches the user's favourite store, the favourite store will be removed.

Example

{
  "clientMutationId": "abc123",
  "sellerId": "abc123"
}

Types

UserUpdateFavouriteStoreMutationPayload

Description

Autogenerated return type of UserUpdateFavouriteStoreMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`favouriteStoreAssigned` - `Boolean`
`status` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "favouriteStoreAssigned": true,
  "status": 123
}

Types

UserUpdateMutationInput

Description

Autogenerated input type of UserUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`userId` - `ID`
`attributes` - `UserInput`	Attributes to assign to the user updated. Default = `null`

Example

{
  "clientMutationId": "abc123",
  "userId": "4",
  "attributes": UserInput
}

Types

UserUpdateMutationPayload

Description

Autogenerated return type of UserUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`user` - `User`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 987,
  "user": User
}

Types

ValidationError

Description

Field-specific model validation error messages for when params are invalid.

Fields

Field Name	Description
`field` - `String!`
`messages` - `[String!]!`

Example

{
  "field": "xyz789",
  "messages": ["abc123"]
}

Types

Variant

Description

A unique option type/option value combination that represents a variation of a purchasable item.

Fields

Field Name	Description
`administrativeBodyWarning` - `String`	A message from the organisation responsible for therapeutic goods labelling.
`advert` - `AllAdvert!`	Associated advert
`allergenContains` - `String`	The ingredients always in this item that cause allergic reactions.
`allergenMayContain` - `String`	The ingredients possibly in this item that cause allergic reactions.
`barcode` - `String`
`buyable` - `Boolean!`	Whether an item associated with the given variant can be added to cart.
`catalogRulesErrors` - `[CatalogRulesError!]`
`commissionPackageRate` - `Decimal`	The commission rate for the variant.
`comparableSize` - `Float`	The comparable size of the item. Used for comparable unit pricing.
`comparableUnit` - `String`	The comparable unit used to measure the item. Used for comparable unit pricing.
`countOnHand` - `Int!`	Number of items available with a given variant.
`createdAt` - `ISO8601DateTime!`	The date the variant was created Only accessible to users: admin_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`directions` - `String`	Usage instructions for the item.
`displayable` - `Boolean!`	Whether to display the given variant in the associated advert.
`duplicateBarcodeAdverts` - `[Advert!]!`	Links to adverts with the same barcode as this variant. Only accessible to users: admin_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`duplicateBarcodeVariants` - `[Variant!]!`	Links to variants with the same barcode as this variant. Only accessible to users: admin_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`editablePrice` - `Decimal`	Price used for editing by sellers
`editablePriceCents` - `Int`	Price used for editing by sellers Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`editablePriceFormatted` - `String`	Price used for editing by sellers In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`editableSalePrice` - `Decimal`	Price used for editing by sellers
`editableSalePriceCents` - `Int`	Price used for editing by sellers Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`editableSalePriceFormatted` - `String`	Price used for editing by sellers In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`externalId` - `String`	An ID that is managed the retailer.
`externalIds` - `[ExternalID!]!`
`goldenProductVariant` - `GoldenProductVariant`	Golden Product Variant associated to this variant
`healthWarnings` - `String`	The health warnings of the item.
`id` - `ID!`
`images` - `ImagesConnection!`
Arguments `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.
`infiniteQuantity` - `Boolean!`	Whether the quantity for the given variant is unlimited.
`ingredients` - `String`	The ingredients in the item.
`intendedPurpose` - `String`	The intended purpose of the item.
`inventories` - `InventorysConnection`	support multi-store location inventory
Arguments `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.
`itemSize` - `Float`	The size of the item. Used for comparable unit pricing.
`itemTaxRate` - `Decimal`	The individual item tax rate on variant.
`itemUnit` - `String`	The unit used to measure the item. Used for comparable unit pricing.
`label` - `String!`	The displayable label for the variant. Includes variant type and value (e.g. "size / M"). Falls back to SKU if no option values set, ID if no SKU is set.
`legacyId` - `Int!`
`lowestOriginalPrice` - `String`	Lowest non-sale price available for the item.
`lowestOriginalPriceCents` - `Int`	Lowest non-sale price available for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use lowestOriginalPrice instead. This field will be removed no earlier than July 1st, 2025.
`lowestPrice` - `String`	Absolute lowest price (sale price or original price) available for the item.
`lowestPriceCents` - `Int`	Absolute lowest price (sale price or original price) available for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use lowestPrice instead. This field will be removed no earlier than July 1st, 2025.
`maxPurchaseQuantity` - `Int`	Maximum purchase quantity allowed for successful checkout
`measureType` - `String`	Measure type of how is the item supplied.
`measurementComparableUnit` - `MeasurementUnit`	Comparable Unit as a Configurable Unit of Measure
`measurementItemUnit` - `MeasurementUnit`	Item Unit as a Configurable Unit of Measure
`metadata` - `[Metadatum!]!`	Metadata key/values
`minPurchaseQuantity` - `Int`	Minimum purchase quantity required for successful checkout
`notes` - `String`
`nutritionInformation` - `String`	The nutritional profile of the item.
`optionValues` - `OptionValueConnection!`	This field returns option values from single-select and multi-select option types. This field is deprecated in favour of VariantOptionValues.
Arguments `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.
`optionValuesBeforeMapping` - `[String!]!`	Option value labels before being mapped to canonical option values. (Includes the original values for both unmapped and mapped option values)
`optionValuesInclusiveValid` - `Boolean!`	Boolean for whether a variant is valid, where a variant is valid if it has a barcode, has a sku which is not longer than 255 characters, has a count_on_hand which is an integer greater than zero, has a price and a sale_price which is greater than zero unless free adverts are enabled, has a description which is not longer than 140 characters, where the sale_price is less than the price, the options values are unique, and the option values match the expected values for this prototype.
`pricingModel` - `PricingModelEnum!`	Pricing model of the variant
`productWarnings` - `String`	The product warnings of the item.
`published` - `Boolean!`	Whether seller published a variant.
`recommendedRetailPrice` - `String`	The recommended retail price (RRP) for the item.
`recommendedRetailPriceCents` - `Int`	The recommended retail price (RRP) for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`recommendedRetailPriceFormatted` - `String`	The recommended retail price (RRP) for the item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`salePriceEndAt` - `ISO8601DateTime`	End of the period in which the sale price is valid (or null)
`salePriceStartAt` - `ISO8601DateTime`	Start of the period in which the sale price is valid (or null)
`shippingOptions` - `ShippingOptionConnection`	Shipping options available for the variant
Arguments `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.
`shippingParcel` - `ShippingParcel`	The direct shipping parcel information for the variant.
`shippingParcelToUse` - `ShippingParcel`	Either a direct parcel information or inferred from taxon
`shippingProfile` - `ShippingProfile`
`shippingProfileId` - `ID`	The shipping profile ID for the variant.
`sku` - `String`
`sourceName` - `String`	"Internal" or "External"
`storageInstructions` - `String`	How to store the item.
`suitableFor` - `String`	The suitability of the item for various ailments.
`taxCode` - `String`
`updatedAt` - `ISO8601DateTime!`	The date the variant was last updated Only accessible to users: admin_authorized. And admin users with permissions: 'Manage product catalog', 'Full GraphQL API access'.
`url` - `String`
`variantOptionValues` - `VariantOptionValueConnection!`	This field returns option type values set to the variant.
Arguments `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.
`wholesalePrice` - `String`	The wholesale price for the item.
`wholesalePriceCents` - `Int`	The wholesale price for the item. Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`wholesalePriceFormatted` - `String`	The wholesale price for the item. In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`wholesalePromoPrice` - `Decimal`	Wholesale promo price of the variant
`wholesalePromoPriceCents` - `Int`	Wholesale promo price of the variant Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`wholesalePromoPriceEndAt` - `ISO8601DateTime`	End of the period in which the wholesale promo price is valid (or null)
`wholesalePromoPriceFormatted` - `String`	Wholesale promo price of the variant In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`wholesalePromoPriceStartAt` - `ISO8601DateTime`	Start of the period in which the wholesale promo price is valid (or null)

Example

{
  "administrativeBodyWarning": "abc123",
  "advert": Advert,
  "allergenContains": "abc123",
  "allergenMayContain": "abc123",
  "barcode": "xyz789",
  "buyable": true,
  "catalogRulesErrors": [CatalogRulesError],
  "commissionPackageRate": Decimal,
  "comparableSize": 123.45,
  "comparableUnit": "xyz789",
  "countOnHand": 123,
  "createdAt": ISO8601DateTime,
  "directions": "abc123",
  "displayable": false,
  "duplicateBarcodeAdverts": [Advert],
  "duplicateBarcodeVariants": [Variant],
  "editablePrice": Decimal,
  "editablePriceCents": 123,
  "editablePriceFormatted": "abc123",
  "editableSalePrice": Decimal,
  "editableSalePriceCents": 987,
  "editableSalePriceFormatted": "abc123",
  "externalId": "xyz789",
  "externalIds": [ExternalID],
  "goldenProductVariant": GoldenProductVariant,
  "healthWarnings": "xyz789",
  "id": 4,
  "images": ImagesConnection,
  "infiniteQuantity": true,
  "ingredients": "abc123",
  "intendedPurpose": "xyz789",
  "inventories": InventorysConnection,
  "itemSize": 987.65,
  "itemTaxRate": Decimal,
  "itemUnit": "abc123",
  "label": "xyz789",
  "legacyId": 987,
  "lowestOriginalPrice": "xyz789",
  "lowestOriginalPriceCents": 987,
  "lowestPrice": "abc123",
  "lowestPriceCents": 123,
  "maxPurchaseQuantity": 987,
  "measureType": "xyz789",
  "measurementComparableUnit": MeasurementUnit,
  "measurementItemUnit": MeasurementUnit,
  "metadata": [Metadatum],
  "minPurchaseQuantity": 987,
  "notes": "abc123",
  "nutritionInformation": "xyz789",
  "optionValues": OptionValueConnection,
  "optionValuesBeforeMapping": ["xyz789"],
  "optionValuesInclusiveValid": true,
  "pricingModel": "MARKETPLACE",
  "productWarnings": "xyz789",
  "published": true,
  "recommendedRetailPrice": "abc123",
  "recommendedRetailPriceCents": 123,
  "recommendedRetailPriceFormatted": "abc123",
  "salePriceEndAt": ISO8601DateTime,
  "salePriceStartAt": ISO8601DateTime,
  "shippingOptions": ShippingOptionConnection,
  "shippingParcel": ShippingParcel,
  "shippingParcelToUse": ShippingParcel,
  "shippingProfile": ShippingProfile,
  "shippingProfileId": 4,
  "sku": "xyz789",
  "sourceName": "xyz789",
  "storageInstructions": "abc123",
  "suitableFor": "xyz789",
  "taxCode": "abc123",
  "updatedAt": ISO8601DateTime,
  "url": "abc123",
  "variantOptionValues": VariantOptionValueConnection,
  "wholesalePrice": "abc123",
  "wholesalePriceCents": 987,
  "wholesalePriceFormatted": "xyz789",
  "wholesalePromoPrice": Decimal,
  "wholesalePromoPriceCents": 987,
  "wholesalePromoPriceEndAt": ISO8601DateTime,
  "wholesalePromoPriceFormatted": "abc123",
  "wholesalePromoPriceStartAt": ISO8601DateTime
}

Types

VariantConnection

Description

The connection type for Variant.

Fields

Field Name	Description
`edges` - `[VariantEdge]`	A list of edges.
`nodes` - `[Variant]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [VariantEdge],
  "nodes": [Variant],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

VariantDeleteMutationInput

Description

Autogenerated input type of VariantDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	ID of the existing variant.

Example

{
  "clientMutationId": "xyz789",
  "id": "4"
}

Types

VariantDeleteMutationPayload

Description

Autogenerated return type of VariantDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`variant` - `Variant`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123,
  "variant": Variant
}

Types

VariantEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Variant`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Variant
}

Types

VariantFilterInput

Fields

Input Field	Description
`barcodes` - `[String!]`	Select adverts that have associated variants with one of the given barcodes. Default = `[]`
`skus` - `[String!]`	Select adverts that have associated variants with one of the given skus. Default = `[]`
`quantityFrom` - `Int`
`quantityTo` - `Int`
`stocked` - `Boolean`
`infiniteQuantity` - `Boolean`
`externalId` - `ExternalIDInput`	Select variants with a particular External ID. Default = `null`

Example

{
  "barcodes": ["xyz789"],
  "skus": ["xyz789"],
  "quantityFrom": 123,
  "quantityTo": 123,
  "stocked": true,
  "infiniteQuantity": true,
  "externalId": ExternalIDInput
}

Types

VariantInput

Fields

Input Field	Description
`id` - `ID`
`description` - `String`
`sku` - `String`
`price` - `Decimal`
`salePrice` - `Decimal`
`barcode` - `String`
`countOnHand` - `Int`
`infiniteQuantity` - `Boolean`
`optionValueIds` - `[ID!]`	DEPRECATED: This argument is deprecated in favour of VariantOptionValues. Option value ids for single-select and multi-select option types
`variantOptionValues` - `[VariantOptionValueInput!]`	Variant option values of the variant. If this argument is given, variant option values will be updated to match the input and delete the missing ones.
`images` - `[ImageInput!]`
`externalId` - `String`	Optional external id to identify the product
`metadata` - `[KeyValueInput!]`	Metadata key/value pairs.
`externalIds` - `[KeyValueInput!]`	External IDs key/value pairs.
`published` - `Boolean`	Whether seller published a variant.
`maxPurchaseQuantity` - `Int`	Maximum purchase quantity allowed for successful checkout
`minPurchaseQuantity` - `Int`	Minimum purchase quantity allowed for successful checkout
`itemSize` - `Float`	The size of the item. Used for comparable unit pricing.
`comparableSize` - `Float`	The comparable size of the item. Used for comparable unit pricing.
`itemUnit` - `ComparableUnitEnum`	The unit used to measure the item. Used for comparable unit pricing.
`comparableUnit` - `ComparableUnitEnum`	The comparable unit used to measure the item. Used for comparable unit pricing.
`variantPricingModel` - `VariantPricingModelInput`
`measurementItemUnitId` - `ID`	The configurable measurement unit.
`measurementComparableUnitId` - `ID`	The comparable configurable measurement unit.
`recommendedRetailPrice` - `String`
`wholesalePrice` - `String`
`salePriceStartAt` - `ISO8601DateTime`
`salePriceEndAt` - `ISO8601DateTime`
`wholesalePromoPrice` - `String`
`wholesalePromoPriceStartAt` - `ISO8601DateTime`
`wholesalePromoPriceEndAt` - `ISO8601DateTime`
`administrativeBodyWarning` - `String`
`productWarnings` - `String`
`healthWarnings` - `String`
`intendedPurpose` - `String`
`ingredients` - `String`
`directions` - `String`
`storageInstructions` - `String`
`suitableFor` - `String`
`allergenContains` - `String`
`allergenMayContain` - `String`
`nutritionInformation` - `String`
`taxCode` - `String`
`itemTaxRate` - `Decimal`
`notes` - `String`
`shippingParcelAttributes` - `ShippingParcelInput`
`shippingProfileId` - `ID`

Example

{
  "id": 4,
  "description": "abc123",
  "sku": "abc123",
  "price": Decimal,
  "salePrice": Decimal,
  "barcode": "xyz789",
  "countOnHand": 123,
  "infiniteQuantity": false,
  "optionValueIds": [4],
  "variantOptionValues": [VariantOptionValueInput],
  "images": [ImageInput],
  "externalId": "xyz789",
  "metadata": [KeyValueInput],
  "externalIds": [KeyValueInput],
  "published": true,
  "maxPurchaseQuantity": 987,
  "minPurchaseQuantity": 987,
  "itemSize": 123.45,
  "comparableSize": 123.45,
  "itemUnit": "MM",
  "comparableUnit": "MM",
  "variantPricingModel": VariantPricingModelInput,
  "measurementItemUnitId": "4",
  "measurementComparableUnitId": "4",
  "recommendedRetailPrice": "abc123",
  "wholesalePrice": "xyz789",
  "salePriceStartAt": ISO8601DateTime,
  "salePriceEndAt": ISO8601DateTime,
  "wholesalePromoPrice": "abc123",
  "wholesalePromoPriceStartAt": ISO8601DateTime,
  "wholesalePromoPriceEndAt": ISO8601DateTime,
  "administrativeBodyWarning": "abc123",
  "productWarnings": "abc123",
  "healthWarnings": "abc123",
  "intendedPurpose": "xyz789",
  "ingredients": "xyz789",
  "directions": "xyz789",
  "storageInstructions": "abc123",
  "suitableFor": "xyz789",
  "allergenContains": "abc123",
  "allergenMayContain": "abc123",
  "nutritionInformation": "xyz789",
  "taxCode": "abc123",
  "itemTaxRate": Decimal,
  "notes": "abc123",
  "shippingParcelAttributes": ShippingParcelInput,
  "shippingProfileId": 4
}

Types

VariantOptionValue

Description

Variant option value for a variant's option type supporting all field types.

Fields

Field Name	Description
`id` - `ID!`	ID for the value. This value is less likely to change when the field values are unchanged but cannot guaranty.
`optionType` - `OptionType!`	Option Type the value belongs to
`optionValue` - `OptionValue`	Option value for single-select or multi-select Option Type
`textValue` - `String`	Value for free-text Option Type

Example

{
  "id": 4,
  "optionType": OptionType,
  "optionValue": OptionValue,
  "textValue": "xyz789"
}

Types

VariantOptionValueConnection

Description

The connection type for VariantOptionValue.

Fields

Field Name	Description
`edges` - `[VariantOptionValueEdge]`	A list of edges.
`nodes` - `[VariantOptionValue]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [VariantOptionValueEdge],
  "nodes": [VariantOptionValue],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

VariantOptionValueEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `VariantOptionValue`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": VariantOptionValue
}

Types

VariantOptionValueInput

Description

Input for updating a variant option value. Set only optionValueId for single-select and multi-select option types, and set only optionTypeId and textValue for a free-text option type.

Fields

Input Field	Description
`optionValueId` - `ID`	Option Value ID used for single-select and multi-select option types
`textValue` - `String`	Free-text value used for a free-text option type
`optionTypeId` - `ID`	Option Type ID required for a free-text option type

Example

{
  "optionValueId": 4,
  "textValue": "xyz789",
  "optionTypeId": 4
}

Types

VariantPricingModelInput

Fields

Input Field	Description
`pricingModel` - `PricingModelEnum`

Example

{"pricingModel": "MARKETPLACE"}

Types

VariantUpdateMutationInput

Description

Autogenerated input type of VariantUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`variantId` - `ID`
`attributes` - `VariantInput!`

Example

{
  "clientMutationId": "abc123",
  "variantId": 4,
  "attributes": VariantInput
}

Types

VariantUpdateMutationPayload

Description

Autogenerated return type of VariantUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`variant` - `Variant`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "variant": Variant
}

Types

VariantsConnection

Description

The connection type for Variant.

Fields

Field Name	Description
`edges` - `[VariantsEdge]`	A list of edges.
`nodes` - `[Variant]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [VariantsEdge],
  "nodes": [Variant],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

VariantsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Variant`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": Variant
}

Types

VerifyAuthenticatorMutationInput

Description

Autogenerated input type of VerifyAuthenticatorMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`mfaToken` - `String!`	A code from the user's authenticator, to verify that they are able to generate codes correctly before we confirm the authenticator as being set up.

Example

{
  "clientMutationId": "abc123",
  "mfaToken": "xyz789"
}

Types

VerifyAuthenticatorMutationPayload

Description

Autogenerated return type of VerifyAuthenticatorMutation.

Fields

Field Name	Description
`authenticator` - `TOTP`
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`

Example

{
  "authenticator": TOTP,
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123
}

Types

VerticalLogo

Description

Logo for the Marketplace

Fields

Field Name	Description
`defaultOpengraph` - `Image`	experimental
`email` - `Image`	experimental
`header` - `Image`	experimental
`logo` - `Image`	experimental
`verticalLogoUrl` - `String`	Marketplace logo url

Example

{
  "defaultOpengraph": Image,
  "email": Image,
  "header": Image,
  "logo": Image,
  "verticalLogoUrl": "abc123"
}

Types

Video

Description

Video data stored on seller

Fields

Field Name	Description
`embedSrc` - `String`	Embedded src
`id` - `ID!`
`previewSrc` - `String`	Preview src
`thumbSrc` - `String`	Thumb src

Example

{
  "embedSrc": "xyz789",
  "id": 4,
  "previewSrc": "abc123",
  "thumbSrc": "xyz789"
}

Types

Webhook

Description

Returns the webhooks linked to marketplacer events.

Fields

Field Name	Description
`allowSkip` - `Boolean`	Allow Skip? (With this enabled, identical payloads will be skipped)
`concurrentSendLimit` - `Int!`	Maximum number of events we will attempt to deliver for this webhook at a time.
`enabled` - `Boolean`	Activate webhook? (true/false)
`eventName` - `WebhookEventEnum`	Additional event filter that allows you to specify the type of event traffic generated, e.g. Create, Update and Destroy. If not specified all events will be sent
`events` - `[WebhookEvent!]`	Webhook events
`headers` - `JSON`	Optional headers supplied as JSON that can be used to access further configure webhook HTTP POST requests (e.g. { Authorization: "Basic x123" })
`id` - `ID!`
`legacyFormat` - `Boolean`	Set to false to enable the use of additional error reporting in webhook payloads, or false if you want to retain the legacy format for payloads with no error reporting.
`maxRetries` - `Int!`	Maximum number of times we will retry sending each event.Note that we will stop after 30 days regardless of the number of retry attempts.
`queryString` - `String`	Optional GraphQL query that can be used to determine the result will be sent when the Webhook is triggered. If left blank, the Webhook will return a default query (e.g. "query($id: ID!){ node(id: $id) { __typename } }")
`seller` - `Seller`
`type` - `WebhookKlassEnum!`	The name of the Marketplacer object that webhook events are being generated for
`url` - `String!`	External URL listening for incoming HTTP POST

Example

{
  "allowSkip": false,
  "concurrentSendLimit": 987,
  "enabled": false,
  "eventName": "CREATE",
  "events": [WebhookEvent],
  "headers": {},
  "id": "4",
  "legacyFormat": false,
  "maxRetries": 123,
  "queryString": "abc123",
  "seller": Seller,
  "type": "REFUND_REQUEST",
  "url": "abc123"
}

Types

WebhookCreateInput

Description

Attributes for creating a webhook.

Fields

Input Field	Description
`url` - `String!`	External URL listening for incoming HTTP POST
`type` - `WebhookKlassEnum!`	The name of the Marketplacer object that webhook events are being generated for
`headers` - `JSON`	Optional headers supplied as JSON that can be used to access further configure webhook HTTP POST requests (e.g. { Authorization: "Basic x123" })
`enabled` - `Boolean`	Active webhook? (true/false)
`allowSkip` - `Boolean`	Allow Skip? (With this enabled, identical payloads will be skipped)
`queryString` - `String`	Optional GraphQL query that can be used to determine the result will be sent when the Webhook is triggered. If left blank, the Webhook will return a default query (e.g. "query($id: ID!){ node(id: $id) { __typename } }")
`eventName` - `WebhookEventEnum`	Additional event filter that allows you to specify the type of event traffic generated, e.g. Create, Update and Destroy. If not specified all events will be sent
`sellerId` - `ID`	Seller ID to assign the webhook to a specific Seller.
`hmacKey` - `String`	This will be used to validate the authenticity of webhooks.
`maxRetries` - `Int`	Maximum number of times we will retry sending each event.Value >=0 and <= 50. Default is 25 if this value is not supplied. Note that we will stop after 30 days regardless of the number of retry attempts.
`concurrentSendLimit` - `Int`	Maximum number of events we will attempt to deliver for this webhook at a time.Value >=1 and <= 200. Default is 100 if this value is not supplied.

Example

{
  "url": "abc123",
  "type": "REFUND_REQUEST",
  "headers": {},
  "enabled": true,
  "allowSkip": false,
  "queryString": "abc123",
  "eventName": "CREATE",
  "sellerId": "4",
  "hmacKey": "abc123",
  "maxRetries": 987,
  "concurrentSendLimit": 987
}

Types

WebhookCreateMutationInput

Description

Autogenerated input type of WebhookCreateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`attributes` - `WebhookCreateInput!`	Attributes for creating a webhook.

Example

{
  "clientMutationId": "xyz789",
  "attributes": WebhookCreateInput
}

Types

WebhookCreateMutationPayload

Description

Autogenerated return type of WebhookCreateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`webhook` - `Webhook`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "webhook": Webhook
}

Types

WebhookEvent

Description

Returns the webhooks event linked to a webhook.

Fields

Field Name	Description
`createdAt` - `ISO8601DateTime!`
`eventName` - `String`	The name of the event executed
`id` - `ID!`
`invoice` - `Invoice`	Invoice
`payload` - `JSON`	Payload supplied as JSON that can be used to access further information of the event
`processedAt` - `ISO8601DateTime`	Processed At
`refundRequest` - `RefundRequest`	Refund Request
`responses` - `[WebhookEventResponse!]`	Webhook event responses
`retryAfter` - `ISO8601DateTime`	Retry After
`sentAt` - `ISO8601DateTime`	Sent At This field is deprecated, use "processedAt" and "status" instead. This field will be removed no later than 2024-04-01.
`shipment` - `Shipment`	Shipment
`skipped` - `Boolean`	Whether this event was skipped (only relevant if webhook has "allowSkip" set true)
`status` - `String!`	Status

Example

{
  "createdAt": ISO8601DateTime,
  "eventName": "abc123",
  "id": "4",
  "invoice": Invoice,
  "payload": {},
  "processedAt": ISO8601DateTime,
  "refundRequest": RefundRequest,
  "responses": [WebhookEventResponse],
  "retryAfter": ISO8601DateTime,
  "sentAt": ISO8601DateTime,
  "shipment": Shipment,
  "skipped": true,
  "status": "xyz789"
}

Types

WebhookEventEnum

Description

The field that is used to select/filter webhooks by event

Values

Enum Value	Description
`CREATE`
`UPDATE`
`DESTROY`

Example

"CREATE"

Types

WebhookEventResponse

Description

Returns the webhooks event response linked to marketplacer events.

Fields

Field Name	Description
`body` - `JSON`	Body of the response received from the webhook URL
`createdAt` - `ISO8601DateTime!`	Timestamp for when the response was created
`headers` - `JSON`	Headers supplied as JSON that can be used to access further information of the event
`id` - `ID!`
`status` - `Int!`

Example

{
  "body": {},
  "createdAt": ISO8601DateTime,
  "headers": {},
  "id": "4",
  "status": 987
}

Types

WebhookEventsConnection

Description

The connection type for WebhookEvent.

Fields

Field Name	Description
`edges` - `[WebhookEventsEdge]`	A list of edges.
`nodes` - `[WebhookEvent]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [WebhookEventsEdge],
  "nodes": [WebhookEvent],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

WebhookEventsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `WebhookEvent`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": WebhookEvent
}

Types

WebhookInput

Description

Webhook Attributes.

Fields

Input Field	Description
`url` - `String`	External URL listening for incoming HTTP POST
`type` - `WebhookKlassEnum`	The name of the Marketplacer object that webhook events are being generated for
`headers` - `JSON`	Optional headers supplied as JSON that can be used to access further configure webhook HTTP POST requests (e.g. { Authorization: "Basic x123" })
`enabled` - `Boolean`	Active webhook? (true/false)
`allowSkip` - `Boolean`	Allow Skip? (With this enabled, identical payloads will be skipped)
`queryString` - `String`	Optional GraphQL query that can be used to determine the result will be sent when the Webhook is triggered. If left blank, the Webhook will return a default query (e.g. "query($id: ID!){ node(id: $id) { __typename } }")
`eventName` - `WebhookEventEnum`	Additional event filter that allows you to specify the type of event traffic generated, e.g. Create, Update and Destroy. If not specified all events will be sent
`sellerId` - `ID`	Seller ID to assign the webhook to a specific Seller.
`hmacKey` - `String`	This will be used to validate the authenticity of webhooks.
`maxRetries` - `Int`	Maximum number of times we will retry sending each event.Value >=0 and <= 50. Default is 25 if this value is not supplied. Note that we will stop after 30 days regardless of the number of retry attempts.
`concurrentSendLimit` - `Int`	Maximum number of events we will attempt to deliver for this webhook at a time.Value >=1 and <= 200. Default is 100 if this value is not supplied.

Example

{
  "url": "abc123",
  "type": "REFUND_REQUEST",
  "headers": {},
  "enabled": true,
  "allowSkip": true,
  "queryString": "xyz789",
  "eventName": "CREATE",
  "sellerId": "4",
  "hmacKey": "xyz789",
  "maxRetries": 987,
  "concurrentSendLimit": 123
}

Types

WebhookKlassEnum

Description

Specifies the Marketplacer object type that webhook events are generated for.

Values

Enum Value	Description
`REFUND_REQUEST`
`REFUND_REQUEST_LINE_ITEM`
`REMITTANCE_ADVICE`
`VARIANT`
`INVOICE`
`INVOICE_ANNOTATION`
`COMMISSION_PACKAGE`
`ADVERT`
`SHIPMENT`
`RETURN_SHIPMENT`
`SELLER`
`SHIPPING_OPTION`
`OPTION_TYPE`
`OPTION_VALUE`
`PROMOTION`
`TAXON`

Example

"REFUND_REQUEST"

Types

WebhookUpdateMutationInput

Description

Autogenerated input type of WebhookUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`webhookId` - `ID!`	Webhook ID to be updated.
`attributes` - `WebhookInput`	Attributes for updating the webhook.

Example

{
  "clientMutationId": "xyz789",
  "webhookId": 4,
  "attributes": WebhookInput
}

Types

WebhookUpdateMutationPayload

Description

Autogenerated return type of WebhookUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`webhook` - `Webhook`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987,
  "webhook": Webhook
}

Types

WebhooksConnection

Description

The connection type for Webhook.

Fields

Field Name	Description
`edges` - `[WebhooksEdge]`	A list of edges.
`nodes` - `[Webhook]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [WebhooksEdge],
  "nodes": [Webhook],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

WebhooksEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Webhook`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Webhook
}

Types

YotpoSettings

Description

Yotpo settings

Fields

Field Name	Description
`category` - `CategoryTypeEnum!`
`description` - `String!`
`displayWidgetAdvertPageEnabled` - `Boolean!`
`displayWidgetSearchPageEnabled` - `Boolean!`
`displayWidgetShopPageEnabled` - `Boolean!`
`id` - `ID!`
`logoUrl` - `String!`
`orderCreateForProductsOnCheckoutEnabled` - `Boolean!`
`orderCreateForSellersOnCheckoutEnabled` - `Boolean!`
`productSyncEnabled` - `Boolean!`
`providerHandle` - `String!`
`providerName` - `String!`
`secretKey` - `String`
`sellerSyncEnabled` - `Boolean!`
`status` - `StatusTypeEnum!`
`storeId` - `String`

Example

{
  "category": "RATINGS_AND_REVIEWS",
  "description": "xyz789",
  "displayWidgetAdvertPageEnabled": false,
  "displayWidgetSearchPageEnabled": false,
  "displayWidgetShopPageEnabled": false,
  "id": 4,
  "logoUrl": "xyz789",
  "orderCreateForProductsOnCheckoutEnabled": true,
  "orderCreateForSellersOnCheckoutEnabled": true,
  "productSyncEnabled": false,
  "providerHandle": "xyz789",
  "providerName": "xyz789",
  "secretKey": "abc123",
  "sellerSyncEnabled": true,
  "status": "AVAILABLE",
  "storeId": "abc123"
}

Types

YotpoSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of YotpoSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`storeId` - `String!`	Yotpo App Key.
`secretKey` - `String!`	Yotpo App Secret.
`productSyncEnabled` - `Boolean!`	Enable syncing products.
`sellerSyncEnabled` - `Boolean!`	Enable syncing seller.
`displayWidgetAdvertPageEnabled` - `Boolean!`	Enable to display widget on advert page.
`displayWidgetShopPageEnabled` - `Boolean!`	Enable to display widget on shop page.
`displayWidgetSearchPageEnabled` - `Boolean!`	Enable to display widget on search page.
`orderCreateForProductsOnCheckoutEnabled` - `Boolean!`	Enable to create order for products on checkout.
`orderCreateForSellersOnCheckoutEnabled` - `Boolean!`	Enable to create order for sellers on checkout.

Example

{
  "clientMutationId": "abc123",
  "storeId": "xyz789",
  "secretKey": "xyz789",
  "productSyncEnabled": true,
  "sellerSyncEnabled": false,
  "displayWidgetAdvertPageEnabled": true,
  "displayWidgetShopPageEnabled": false,
  "displayWidgetSearchPageEnabled": false,
  "orderCreateForProductsOnCheckoutEnabled": true,
  "orderCreateForSellersOnCheckoutEnabled": true
}

Types

YotpoSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of YotpoSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`yotpoSettings` - `YotpoSettings`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "yotpoSettings": YotpoSettings
}

Types

YotpoSettingsDeleteMutationInput

Description

Autogenerated input type of YotpoSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

YotpoSettingsDeleteMutationPayload

Description

Autogenerated return type of YotpoSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`yotpoSettings` - `YotpoSettings`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123,
  "yotpoSettings": YotpoSettings
}

Types

YotpoSettingsSiteConfig

Description

Yotpo Site Configuration settings

Fields

Field Name	Description
`displayWidgetSearchPageEnabled` - `Boolean`
`displayWidgetShopPageEnabled` - `Boolean`
`id` - `ID!`
`storeId` - `String`

Example

{
  "displayWidgetSearchPageEnabled": false,
  "displayWidgetShopPageEnabled": false,
  "id": 4,
  "storeId": "abc123"
}

Types

ZipSettings

Description

Zip settings.

Fields

Field Name	Description
`category` - `CategoryTypeEnum!`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`logoUrl` - `String!`
`merchantApiKey` - `String`
`merchantPublicKey` - `String`
`overrideCustomMerchantFee` - `Boolean!`
`providerHandle` - `String!`
`providerName` - `String!`
`status` - `StatusTypeEnum!`
`zipEnabled` - `Boolean`

Example

{
  "category": "RATINGS_AND_REVIEWS",
  "customMerchantBaseFeeCents": 987,
  "customMerchantBaseFeeFormatted": "abc123",
  "customMerchantFee": 123.45,
  "description": "xyz789",
  "logoUrl": "xyz789",
  "merchantApiKey": "abc123",
  "merchantPublicKey": "xyz789",
  "overrideCustomMerchantFee": false,
  "providerHandle": "abc123",
  "providerName": "xyz789",
  "status": "AVAILABLE",
  "zipEnabled": false
}

Types

ZipSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of ZipSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`merchantApiKey` - `String!`	Zip merchant API key.
`merchantPublicKey` - `String!`	Zip public key
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.

Example

{
  "clientMutationId": "xyz789",
  "merchantApiKey": "abc123",
  "merchantPublicKey": "abc123",
  "overrideCustomMerchantFee": false,
  "customMerchantFee": "xyz789",
  "customMerchantBaseFee": "xyz789"
}

Types

ZipSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of ZipSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`zipSettings` - `ZipSettings`

Example

{
  "clientMutationId": "xyz789",
  "errors": [ValidationError],
  "status": 123,
  "zipSettings": ZipSettings
}

Types

ZipSettingsDeleteMutationInput

Description

Autogenerated input type of ZipSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

ZipSettingsDeleteMutationPayload

Description

Autogenerated return type of ZipSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`zipSettings` - `ZipSettings`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 123,
  "zipSettings": ZipSettings
}

Types

ZoozSettings

Description

Zooz settings type

Fields

Field Name	Description
`appId` - `String`
`balotoPaymentMethod` - `ID`
`bankReferencedPaymentMethod` - `ID`
`bankTransferPaymentMethod` - `ID`
`category` - `CategoryTypeEnum!`
`creditCardPaymentMethod` - `ID`
`customMerchantBaseFeeCents` - `Int`	Denominated in cents. Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
`customMerchantBaseFeeFormatted` - `String`	In string with currency symbol.
Arguments `currency` - `String` Currency in which to display money fields. Defaults to the currency of the marketplace's home country.
`customMerchantFee` - `Float`
`description` - `String!`
`efectyPaymentMethod` - `ID`
`logoUrl` - `String!`
`overrideCustomMerchantFee` - `Boolean!`
`payUApiKey` - `String`
`payUApiLogin` - `String`
`pendingPaymentConfirmationPageUrl` - `String`
`privateKey` - `String`
`providerHandle` - `String!`
`providerName` - `String!`
`publicKey` - `String`
`status` - `StatusTypeEnum!`
`suRedPaymentMethod` - `ID`

Example

{
  "appId": "abc123",
  "balotoPaymentMethod": 4,
  "bankReferencedPaymentMethod": 4,
  "bankTransferPaymentMethod": 4,
  "category": "RATINGS_AND_REVIEWS",
  "creditCardPaymentMethod": "4",
  "customMerchantBaseFeeCents": 123,
  "customMerchantBaseFeeFormatted": "abc123",
  "customMerchantFee": 123.45,
  "description": "abc123",
  "efectyPaymentMethod": "4",
  "logoUrl": "abc123",
  "overrideCustomMerchantFee": false,
  "payUApiKey": "abc123",
  "payUApiLogin": "abc123",
  "pendingPaymentConfirmationPageUrl": "xyz789",
  "privateKey": "xyz789",
  "providerHandle": "xyz789",
  "providerName": "xyz789",
  "publicKey": "abc123",
  "status": "AVAILABLE",
  "suRedPaymentMethod": "4"
}

Types

ZoozSettingsCreateOrUpdateMutationInput

Description

Autogenerated input type of ZoozSettingsCreateOrUpdateMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`appId` - `String!`	Zooz App ID.
`publicKey` - `String!`	Zooz public key
`privateKey` - `String!`	Zooz private key
`payUApiLogin` - `String!`	PayU API login used to fetch a list of banks for PSE payments.
`payUApiKey` - `String!`	PayU API key used to fetch a list of banks for PSE payments.
`pendingPaymentConfirmationPageUrl` - `String`	URL to redirect the customer to for pending transactions.
`overrideCustomMerchantFee` - `Boolean`	Override the custom merchant fee.
`customMerchantFee` - `String`	Percentage of the order total to be charged for the merchant fee.
`customMerchantBaseFee` - `String`	Merchant base fee.

Example

{
  "clientMutationId": "abc123",
  "appId": "xyz789",
  "publicKey": "xyz789",
  "privateKey": "abc123",
  "payUApiLogin": "abc123",
  "payUApiKey": "abc123",
  "pendingPaymentConfirmationPageUrl": "abc123",
  "overrideCustomMerchantFee": false,
  "customMerchantFee": "xyz789",
  "customMerchantBaseFee": "abc123"
}

Types

ZoozSettingsCreateOrUpdateMutationPayload

Description

Autogenerated return type of ZoozSettingsCreateOrUpdateMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`zoozSettings` - `ZoozSettings`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987,
  "zoozSettings": ZoozSettings
}

Types

ZoozSettingsDeleteMutationInput

Description

Autogenerated input type of ZoozSettingsDeleteMutation

Fields

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.

Example

{"clientMutationId": "xyz789"}

Types

ZoozSettingsDeleteMutationPayload

Description

Autogenerated return type of ZoozSettingsDeleteMutation.

Fields

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[ValidationError!]`
`status` - `Int!`
`zoozSettings` - `ZoozSettings`

Example

{
  "clientMutationId": "abc123",
  "errors": [ValidationError],
  "status": 987,
  "zoozSettings": ZoozSettings
}

Documentation by Anvil SpectaQL