SCALAR
ID
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.
link GraphQL Schema definition
- scalar ID
link Require by
- AccountSettingsSite wide customization settings for a marketplace
- ActivityLogDownloadMutationInputAutogenerated input type of ActivityLogDownloadMutation
- AddCartItemInputArguments for finding variants and adding them to a cart.
- AddressAll information necessary for a complete address.
- AddressGeolocationCoordinates and their associated DB ID
- AddressInputInput attributes for creating or updating an address.
- AdjustmentAdjustments to a line item or invoice, e.g. promotion discounts, fees, etc.
- AdjustmentInputApply one or more adjustments to a line item or invoice.
- AdminProperties of an admin
- AdminRoleAdmin role
- AdminRoleDeleteMutationInputAutogenerated input type of AdminRoleDeleteMutation
- AdminRoleUpdateMutationInputAutogenerated input type of AdminRoleUpdateMutation
- AdvertAn advert
- AdvertCategorySuggestionAn advert category suggestion generated by an AI.
- AdvertDeleteMutationInputAutogenerated input type of AdvertDeleteMutation
- AdvertDocumentPDF documents relating to the advert
- AdvertDocumentInputAdvert document upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.
- AdvertFilterInputnull
- AdvertFiltersAttributes for filtering adverts
- AdvertInputnull
- AdvertOptionValueAdvert option value for an advert's option type supporting all field types.
- AdvertOptionValueInputInput 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.
- AdvertPublishedUpdateMutationInputAutogenerated input type of AdvertPublishedUpdateMutation
- AdvertSearchInputAdvert search arguments for building an ElasticSearch query.
- AdvertSettingsSite wide advert settings for a marketplace
- AdvertSpreadsheetConfirmImportMutationInputAutogenerated input type of AdvertSpreadsheetConfirmImportMutation
- AdvertSpreadsheetDownloadMutationInputAutogenerated input type of AdvertSpreadsheetDownloadMutation
- AdvertSpreadsheetUploadMutationInputAutogenerated input type of AdvertSpreadsheetUploadMutation
- AdvertUpsertMutationInputAutogenerated input type of AdvertUpsertMutation
- AdvertVettingApproveInputnull
- AdvertVettingRejectInputnull
- AdvertVettingResubmitInputnull
- AdyenBillingSettingsAdyen settings for billing.
- AdyenEcommerceSettingsAdyen settings for ecommerce.
- AllAdvertVariantVariant IDs on deleted and unpublished adverts
- Attachmentfile attachment
- AttemptBillingInvoicePaymentMutationInputAutogenerated input type of AttemptBillingInvoicePaymentMutation
- AvailabilityFilterOptionAvailability type which can be used to build an availability filter for advert search
- BillingBilling record.
- BillingHistoryDownloadMutationInputAutogenerated input type of BillingHistoryDownloadMutation
- BillingLineItemBilling line items associated with a billing.
- BrandProduct brand
- BrandFilterOptionMinimal subset of Brand type which can be used to build a brand filter for advert search
- CancelBillingInvoiceMutationInputAutogenerated input type of CancelBillingInvoiceMutation
- CartA cart object just waiting to transform into an order.
- CartAddCartItemMutationInputAutogenerated input type of CartAddCartItemMutation
- CartAddItemMutationInputAutogenerated input type of CartAddItemMutation
- CartCheckoutMutationInputAutogenerated input type of CartCheckoutMutation
- CartDeleteMutationInputAutogenerated input type of CartDeleteMutation
- CartItemA good or service that a user has added to their cart.
- CartRemoveCartItemMutationInputAutogenerated input type of CartRemoveCartItemMutation
- CartUpdateCartItemMutationInputAutogenerated input type of CartUpdateCartItemMutation
- CartUpdateMutationInputAutogenerated input type of CartUpdateMutation
- CatalogRuleCatalog rule
- CatalogRuleDeleteMutationInputAutogenerated input type of CatalogRuleDeleteMutation
- CatalogRulesErrorCatalog rules error
- CatalogRuleUpdateMutationInputAutogenerated input type of CatalogRuleUpdateMutation
- ChangeLogLog for record changes.
- ClickAndCollectStatusUpdateMutationInputAutogenerated input type of ClickAndCollectStatusUpdateMutation
- CommissionPackageCommission package holding commission rates for all taxons (or categories)
- CommissionPackageSchedulenull
- CommissionPackageScheduleItemCommission package schedule item within a commission package schedule
- CommissionPackageVersionChange log of commission packages
- CommissionPackageVersionLogChange log of commission packages belonging a retailer
- ConditionFilterOptionCondition type which can be used to build a Condition filter for advert search
- ContextualHistorynull
- CountryCountry information.
- CountryInputInput 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").
- CustomCommissionRateCustom commission rate belonging to a taxon (or category) within a commission package
- CustomFieldCustom 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).
- CustomFieldCreateOrUpdateMutationInputAutogenerated input type of CustomFieldCreateOrUpdateMutation
- CustomFieldDeleteMutationInputAutogenerated input type of CustomFieldDeleteMutation
- CustomFieldGroupInformation relating to a group of CustomFields, including the information for any associated CustomField records
- CustomFieldGroupCreateOrUpdateMutationInputAutogenerated input type of CustomFieldGroupCreateOrUpdateMutation
- CustomFieldGroupDeleteMutationInputAutogenerated input type of CustomFieldGroupDeleteMutation
- CustomFieldInputAttributes for creating or updating a CustomField
- CustomFieldOptionA type representing a custom field option.
- CustomFieldValueInputAttributes for creating or updating a CustomFieldValues
- CustomisationSettingsSite wide customization settings for a marketplace
- DeletedAdvertA deleted advert
- DeletedSellerA deleted seller
- DirectLinkA menu entry with a direct link
- EmailMarketingEmail direct marketing data
- EntityCustomFieldCustom 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).
- EntityCustomFieldGroupInformation relating to a group of CustomFields, including the information for any associated CustomField records
- ESAdvertAn advert (elasticsearch cached)
- ESBrandA brand (elasticsearch cached)
- ESBrandSearchA searched brand (elasticsearch cached)
- ESSellerA brand (elasticsearch cached)
- ESTaxonA taxon (elasticsearch cached)
- ExternalAccountSettingsExternal service account settings
- ExternalIDExternal IDs
- ExternalIdsUpsertMutationInputAutogenerated input type of ExternalIdsUpsertMutation
- ExternalIDUpsertMutationInputAutogenerated input type of ExternalIDUpsertMutation
- FooterData for composing a site footer
- FreetextOptionValuenull
- GenderFilterOptionGender type which can be used to build a gender filter for advert search
- GivexSettingsGivex settings for ecommerce.
- GlobalSearchResultMixed search result records belonging to retailer
- GoldenProductA golden product record.
- GoldenProductDeleteMutationInputAutogenerated input type of GoldenProductDeleteMutation
- GoldenProductDocumentPDF documents relating to the golden product.
- GoldenProductDocumentInputGolden product document upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.
- GoldenProductInputnull
- GoldenProductOptionValueGolden Product option value for a golden product's option type supporting all field types.
- GoldenProductOptionValueInputInput 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.
- GoldenProductUpdateInputnull
- GoldenProductUpdateMutationInputAutogenerated input type of GoldenProductUpdateMutation
- GoldenProductVariantA variant under the golden product record.
- GoldenProductVariantDeleteMutationInputAutogenerated input type of GoldenProductVariantDeleteMutation
- GoldenProductVariantInputnull
- GoldenProductVariantLinkVariantsMutationInputAutogenerated input type of GoldenProductVariantLinkVariantsMutation
- GoldenProductVariantOptionValueGolden Product Variant option value for a golden product variant's option type supporting all field types.
- GoldenProductVariantOptionValueInputInput 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.
- GoldenProductVariantsActivateMutationInputAutogenerated input type of GoldenProductVariantsActivateMutation
- GoldenProductVariantsDeactivateMutationInputAutogenerated input type of GoldenProductVariantsDeactivateMutation
- GoldenProductVariantUnlinkVariantsMutationInputAutogenerated input type of GoldenProductVariantUnlinkVariantsMutation
- GoldenProductVariantUpdateInputnull
- GoldenProductVariantUpdateMutationInputAutogenerated input type of GoldenProductVariantUpdateMutation
- ImageImage attachment for adverts and some other models
- ImageGalleryImage gallery data for the shop page
- ImageInputImage upload. Exactly one of (dataBase64 AND filename) or sourceUrl must be supplied.
- ImportExportnull
- Inquirynull
- InquiryCreateInputInquiry Attributes.
- InventoryRecord to handle multi-store inventory.
- InvoiceInvoice items associated with an order.
- InvoiceAmendmentAmendments to an invoice.
- InvoiceAmendmentCreateMutationInputAutogenerated input type of InvoiceAmendmentCreateMutation
- InvoiceAmendmentLineItemLine items associated with an invoice amendment.
- InvoiceAmendmentLineItemInputLine 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.
- InvoiceAnnotationAnnotation on an invoice.
- InvoiceAnnotationCreateMutationInputAutogenerated input type of InvoiceAnnotationCreateMutation
- InvoiceAnnotationResolveMutationInputAutogenerated input type of InvoiceAnnotationResolveMutation
- InvoiceAnnotationTypeA type of invoice annotation.
- InvoiceAnnotationTypeDiscardMutationInputAutogenerated input type of InvoiceAnnotationTypeDiscardMutation
- InvoiceAnnotationTypeUpdateMutationInputAutogenerated input type of InvoiceAnnotationTypeUpdateMutation
- InvoiceAnnotationUpdateMutationInputAutogenerated input type of InvoiceAnnotationUpdateMutation
- InvoiceFiltersAttributes for filtering invoices
- LineItemLine items associated with a cart or order.
- LineItemInputLine items associated with a cart or order.
- LineItemsForShipmentsSpreadsheetDownloadMutationInputAutogenerated input type of LineItemsForShipmentsSpreadsheetDownloadMutation
- LineItemsForShipmentsSpreadsheetUploadMutationInputAutogenerated input type of LineItemsForShipmentsSpreadsheetUploadMutation
- LoyaltyProgramLevelLoyalty program levels
- Mappingnull
- MappingSetMutationInputAutogenerated input type of MappingSetMutation
- MarkdownA menu entry with markdown contents
- MarketplacerAPIKeyMarketplacer API key info
- MeasurementUnitMeasurement unit
- MemberSettingsMember settings on marketplace
- Metadata2UpsertMutationInputAutogenerated input type of Metadata2UpsertMutation
- MetadataUpsertMutationInputAutogenerated input type of MetadataUpsertMutation
- MetadatumMetadata key value tuples
- ModelProduct model
- ModelFilterOptionMinimal subset of Model type which can be used to build a model filter for advert search
- NodeAn object with an ID.
- OptionalOptionValuenull
- OptionTypeAn advert's option type (e.g. colour, size, shape).
- OptionTypeCreateOrUpdateMutationInputAutogenerated input type of OptionTypeCreateOrUpdateMutation
- OptionValueOption value for an advert's option type (e.g. 'red', 'large')
- OptionValueCreateOrUpdateMutationInputAutogenerated input type of OptionValueCreateOrUpdateMutation
- OptionValueDeleteMutationInputAutogenerated input type of OptionValueDeleteMutation
- OptionValueFilterOptionMinimal subset of OptionValue type which can be used as a value of an option type filter for advert search
- OrderA cart that has turned into an immutable order.
- OrderHistoryDownloadMutationInputAutogenerated input type of OrderHistoryDownloadMutation
- OrderUpdateMutationInputAutogenerated input type of OrderUpdateMutation
- PaymentEventPayment Event
- PaymentMethodPayment method.
- PaymentMethodDeleteMutationInputAutogenerated input type of PaymentMethodDeleteMutation
- PromotionA promotion, sale, or special discount.
- PromotionInputnull
- PromotionUpsertMutationInputAutogenerated input type of PromotionUpsertMutation
- PrototypePrototypes contain the attributes from which all Adverts in a Category inherit eg. Clothing
- PrototypeCreateOrUpdateMutationInputAutogenerated input type of PrototypeCreateOrUpdateMutation
- PurgeOrderDataMutationInputAutogenerated input type of PurgeOrderDataMutation
- QueryRoot queries that don't modify database records.
- RankedResultRankedResult records - force first adverts for category/brand
- RankedResultDeleteMutationInputAutogenerated input type of RankedResultDeleteMutation
- RankedResultUpsertMutationInputAutogenerated input type of RankedResultUpsertMutation
- RedirectAll redirects for the marketplace
- RefundReasonnull
- RefundRequestRefund requests associated with an invoice
- RefundRequestApproveInputnull
- RefundRequestCreateMutationInputAutogenerated input type of RefundRequestCreateMutation
- RefundRequestDenyMutationInputAutogenerated input type of RefundRequestDenyMutation
- RefundRequestLineItemLine item on a refund request
- RefundRequestLineItemAcceptMutationInputAutogenerated input type of RefundRequestLineItemAcceptMutation
- RefundRequestLineItemApproveInputnull
- RefundRequestLineItemDenyMutationInputAutogenerated input type of RefundRequestLineItemDenyMutation
- RefundRequestLineItemInputLine 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.
- RefundRequestLineItemReturnMutationInputAutogenerated input type of RefundRequestLineItemReturnMutation
- RefundRequestNoteNote on a refund request
- RefundRequestNoteInputNote on a refund request
- RefundRequestRefundMutationInputAutogenerated input type of RefundRequestRefundMutation
- RefundRequestReturnMutationInputAutogenerated input type of RefundRequestReturnMutation
- RefundRequestRevertDenialMutationInputAutogenerated input type of RefundRequestRevertDenialMutation
- RefundRequestSpreadsheetDownloadMutationInputAutogenerated input type of RefundRequestSpreadsheetDownloadMutation
- RemittanceRemittance for invoice or invoice amendment
- RemittanceActionRemittance action
- RemittanceAdviceRemittance advice
- RemittanceAdviceUpdateMutationInputAutogenerated input type of RemittanceAdviceUpdateMutation
- RemittanceEventRemittance event
- RemittancesReleaseMutationInputAutogenerated input type of RemittancesReleaseMutation
- ReturnShipmentShipment tracking information.
- ReturnShipmentCreateMutationInputAutogenerated input type of ReturnShipmentCreateMutation
- ReturnShipmentUpdateMutationInputAutogenerated input type of ReturnShipmentUpdateMutation
- ReturnShippedItemQuantity and LineItem which has been shipped as part of a parent ReturnShipment.
- ReturnShippedItemInputnull
- RithumAPIKeyRithum API key info
- SellerRetailer or private seller.
- SellerAdyenBillingPaymentMethodUpdateMutationInputAutogenerated input type of SellerAdyenBillingPaymentMethodUpdateMutation
- SellerBraintreeBillingPaymentMethodUpdateMutationInputAutogenerated input type of SellerBraintreeBillingPaymentMethodUpdateMutation
- SellerFilterOptionMinimal subset of Seller type which can be used to build a seller filter for advert search
- SellerGeolocationCoordinates of a Seller
- SellerOnboardingProcessReturns the seller onboarding processes.
- SellerSearchInputSeller search arguments for building an ElasticSearch query.
- SellerSendInvoiceToCustomerMutationInputAutogenerated input type of SellerSendInvoiceToCustomerMutation
- SellerStatsInsights and Statistics for a Seller.
- SellerUpdateMutationInputAutogenerated input type of SellerUpdateMutation
- SeoContentSEO specific content for a particular page. Eg. advert search page
- ShipmentShipment tracking information.
- ShipmentAddressCreateMutationInputAutogenerated input type of ShipmentAddressCreateMutation
- ShipmentAddressSortMutationInputAutogenerated input type of ShipmentAddressSortMutation
- ShipmentCarrierShipment carriers available to assign to a shipment.
- ShipmentCreateMutationInputAutogenerated input type of ShipmentCreateMutation
- ShipmentStatusShipment status log.
- ShipmentStatusCreateMutationInputAutogenerated input type of ShipmentStatusCreateMutation
- ShipmentUpdateMutationInputAutogenerated input type of ShipmentUpdateMutation
- ShippedItemQuantity and LineItem which has been shipped as part of a parent Shipment.
- ShippedItemInputnull
- ShippingOptionA shipping rule that might apply to a certain variant
- ShippingOptionDeleteMutationInputAutogenerated input type of ShippingOptionDeleteMutation
- ShippingOptionUpsertInputnull
- ShippingOptionUpsertMutationInputAutogenerated input type of ShippingOptionUpsertMutation
- ShippingParcelShipping Parcel dimensions and weight.
- ShippingProfileA shipping rule that might apply to a certain variant
- ShippingRateA shipping rate defined in the marketplace
- ShippingRateCreateOrUpdateMutationInputAutogenerated input type of ShippingRateCreateOrUpdateMutation
- ShippingRateDeleteMutationInputAutogenerated input type of ShippingRateDeleteMutation
- ShippingZoneA shipping area defined in the marketplace which consists of multiple postcodes
- ShippingZoneCreateOrUpdateMutationInputAutogenerated input type of ShippingZoneCreateOrUpdateMutation
- ShippingZoneDeleteMutationInputAutogenerated input type of ShippingZoneDeleteMutation
- ShippingZoneSpreadsheetDownloadMutationInputAutogenerated input type of ShippingZoneSpreadsheetDownloadMutation
- ShippitCredentialsUpsertMutationInputAutogenerated input type of ShippitCredentialsUpsertMutation
- SiteConfigSite configuration properties, particularly for properties that affect more than just one page
- SiteCountrySite country information
- SizeMatrixnull
- StateGeographic state
- StateInputInput 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").
- StockLevelsSpreadsheetDownloadMutationInputAutogenerated input type of StockLevelsSpreadsheetDownloadMutation
- StockLevelsSpreadsheetUploadMutationInputAutogenerated input type of StockLevelsSpreadsheetUploadMutation
- TaxCodeTax code
- TaxonCategory or Sub-category for organising adverts. Has a tree-like structure with parents and children.
- TaxonCreateOrUpdateMutationInputAutogenerated input type of TaxonCreateOrUpdateMutation
- TaxonFilterOptionMinimal subset of Taxon type which can be used to build a taxonomy filter for advert search
- TOTPA TOTP Authenticator
- UnpublishedAdvertAn unpublished advert
- UserProperties of the currently logged in User
- UserCreateMutationInputAutogenerated input type of UserCreateMutation
- UserDeleteMutationInputAutogenerated input type of UserDeleteMutation
- UserUpdateMutationInputAutogenerated input type of UserUpdateMutation
- VariantA unique option type/option value combination that represents a variation of a purchasable item.
- VariantDeleteMutationInputAutogenerated input type of VariantDeleteMutation
- VariantInputnull
- VariantOptionValueVariant option value for a variant's option type supporting all field types.
- VariantOptionValueInputInput 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.
- VariantUpdateMutationInputAutogenerated input type of VariantUpdateMutation
- VideoVideo data stored on seller
- WebhookReturns the webhooks linked to marketplacer events.
- WebhookCreateInputAttributes for creating a webhook.
- WebhookEventReturns the webhooks event linked to a webhook.
- WebhookEventResponseReturns the webhooks event response linked to marketplacer events.
- WebhookInputWebhook Attributes.
- WebhookUpdateMutationInputAutogenerated input type of WebhookUpdateMutation
- YotpoSettingsYotpo settings
- YotpoSettingsSiteConfigYotpo Site Configuration settings
- ZoozSettingsZooz settings type