API reference
Generated from the published connect.graphql schema at build time. Every root field of /connect/graphql is listed with its arguments, return type and a ready-to-paste operation; follow the types to see each field.
Use your browser’s find (Ctrl/⌘ F) — the whole reference is on one page per group.
Catalogue, offers and stock
| Name | Returns | Description |
|---|---|---|
| apiBrandsQuery | ApiBrandPage! | Shop API: active brands, filterable by name, paged by cursor; etag covers the whole filtered set. |
| apiCategoriesQuery | ApiCategoryPage! | Shop API: the active category tree (ordered by path) for the import wizard. Send back etag as ifNoneMatch to receive an empty page when nothing changed. |
| apiCategoryAttributesQuery | ApiCategoryAttributesView! | Shop API: the attributes apiSubmitListing validates for a category (and family), with options and which codes are required or variant axes. |
| apiDeclareStockMutation | StockAvailabilityView! | — |
| apiDeclareStocksMutation | ApiBatchResultView! | Shop API: on-hand quantities for up to 200 SKUs in one call, with a per-item result. Counts against the bulk budget. |
| apiFamiliesQuery | ApiFamilyPage! | Shop API: product families with their attribute codes (etag as apiCategories). |
| apiMatchListingsQuery | [ApiListingMatchView!]! | Shop API: finds the Wamia product behind each shop SKU by GTIN, then brand + MPN. Read-only; feeds the import wizard before apiSubmitListing. |
| apiMyListingsQuery | ApiListingPage! | Shop API: the state of every listed SKU, oldest change first. Poll with updatedSince and the last nextCursor; nothing is missed between two polls. |
| apiMyStockQuery | [StockAvailabilityView!]! | Shop API: available quantity per offer, oldest change first. updatedSince and cursor narrow the list; prefer apiMyStockPage to receive nextCursor. |
| apiMyStockPageQuery | StockAvailabilityPage! | Shop API: available quantities ordered by last change with a keyset cursor (contract §7). Poll with updatedSince and the last nextCursor. |
| apiProposeListingEditMutation | ApiListingView! | Shop API: proposes content changes on an own live product; a moderator accepts them. Price and stock go through apiUpsertOffers / apiDeclareStocks. |
| apiSetOfferReturnTermsBySkuMutation | OfferReturnTermsView | Sets or clears the return terms of the offer with this SKU. |
| apiSetWarrantyTermsBySkuMutation | WarrantyTermsView | Sets or clears the warranty terms of the offer with this SKU. |
| apiStockByLocationQuery | [ApiStockBalanceView!]! | — |
| apiSubmitListingMutation | ApiListingView! | Shop API: lists one shop SKU. Attaches an offer to a known product, or opens a new product in the moderation pipeline exactly like a dashboard draft (contract §5). Idempotent by idempotencyKey. |
| apiUpsertOfferMutation | OfferView! | — |
| apiUpsertOffersMutation | ApiBatchResultView! | Shop API: price, handling time, fulfilment mode and pause for up to 200 SKUs in one call, with a per-item result. Counts against the bulk budget. |
Media
| Name | Returns | Description |
|---|---|---|
| apiAssignProductMediaMutation | Product! | Shop API: attaches an image to one variant of an owned product, or back to the shared gallery when variantId is null (docs/adr/0110). Requires the catalog.media or offers.manage scope. |
| apiCreateMediaUploadMutation | MediaUpload! | Shop API: a 15-minute signed PUT for one image the plugin uploads itself (contract §6). Send the required headers, then call apiFinalizeMediaUpload. |
| apiFinalizeMediaUploadMutation | MediaAsset! | Shop API: closes a signed upload: checks the object, records its size and starts processing. The asset id can then go to apiSubmitListing.mediaAssetIds or apiAssignProductMedia. |
| apiIngestMediaFromUrlsMutation | ApiMediaIngestResultView! | Shop API: asks Wamia to fetch up to 20 images the shop serves by https URL. Fetches run out of band (10 MB max, JPEG/PNG/WebP/GIF, one same-host redirect); poll apiMyMediaImports or read mediaState on apiMyListings. Idempotent by key. |
| apiMyMediaImportsQuery | ApiMediaImportPage! | Shop API: the imports requested by this store, oldest change first; filter by ids or poll with updatedSince and cursor. |
Orders, fulfilment and returns
| Name | Returns | Description |
|---|---|---|
| apiAcknowledgeSliceMutation | SellerOrderSliceView! | — |
| apiDecideReturnMutation | RmaView! | — |
| apiMarkSlicePreparedMutation | SellerOrderSliceView! | — |
| apiMyOrdersQuery | [SellerOrderSliceView!]! | Shop API: the store’s slices, newest first. With updatedSince or cursor the order becomes oldest change first; prefer apiMyOrdersPage to receive nextCursor. |
| apiMyOrderSliceQuery | SellerOrderSliceView! | — |
| apiMyOrdersPageQuery | SellerOrderSlicePage! | Shop API: slices ordered by last change with a keyset cursor (contract §7). Poll with updatedSince and the last nextCursor; a slice is never skipped or repeated. |
| apiMyReturnPolicyQuery | SellerPolicyBundleView! | The store’s return policy (active, draft) and the platform baseline. |
| apiMySliceReturnsQuery | [RmaView!]! | Shop API: returns touching the store’s slices, newest first. With updatedSince or cursor the order becomes oldest change first; prefer apiMySliceReturnsPage. |
| apiMySliceReturnsPageQuery | SellerReturnPage! | Shop API: returns ordered by last change with a keyset cursor (contract §7). |
| apiShipmentsQuery | [ApiShipmentView!]! | — |
Inbound, appointments and withdrawals
| Name | Returns | Description |
|---|---|---|
| apiBookInboundAppointmentMutation | InboundShipmentView! | — |
| apiBookWithdrawalAppointmentMutation | WithdrawalRequestView! | Books a dock slot for an approved withdrawal. Slots: apiInboundSlots. |
| apiDeclareInboundMutation | InboundShipmentView! | — |
| apiInboundShipmentQuery | InboundShipmentDetailView! | — |
| apiInboundShipmentsQuery | [InboundShipmentView!]! | — |
| apiInboundSlotGridQuery | [AppointmentSlotDayView!]! | Dock slots per day over a window of at most 14 days. |
| apiInboundSlotsQuery | [AppointmentSlotView!]! | — |
| apiRequestWithdrawalMutation | WithdrawalRequestView! | — |
| apiRescheduleInboundAppointmentMutation | InboundShipmentView! | Moves a scheduled shipment to another slot; the previous appointment is freed. |
| apiRescheduleWithdrawalAppointmentMutation | WithdrawalRequestView! | Moves a withdrawal to another slot; the previous slot is freed. |
| apiStockedPositionsQuery | ApiStockedPositionPage! | Seller API: the quantities Wamia holds for the store, offers in stocked mode only, oldest change first. Poll with updatedSince and the last nextCursor to mirror salable quantities into an ERP; the batch apiDeclareStocks never writes these. |
| apiWithdrawalsQuery | [WithdrawalRequestView!]! | — |
Webhooks
| Name | Returns | Description |
|---|---|---|
| apiDeleteWebhookMutation | WebhookEndpointView! | Shop API: removes an endpoint and its delivery log. |
| apiMyWebhooksQuery | [WebhookEndpointView!]! | Shop API: the endpoints of this store with their health, newest first. |
| apiRegisterWebhookMutation | RegisteredWebhookView! | Shop API: registers an https endpoint for the given events (order.*, listing.state_changed, …). Returns the signing secret once. At most 10 per store. |
| apiTestWebhookMutation | WebhookDeliveryView! | Shop API: posts a signed connect.test event to the endpoint right away and returns the attempt with the HTTP status the receiver answered. |
| webhookEventTypesQueryPublic — no key needed | [WebhookEventFamilyView!]! | Event types a webhook may subscribe to, by family (docs/connect/contract.md §8). <family>.* subscribes to a whole family, * to everything. |
Guardrails, dry-run and insights
| Name | Returns | Description |
|---|---|---|
| apiConfirmBatchMutation | ApiBatchResultView! | Shop API: applies a held batch as submitted, breaker bypassed. Confirming twice replays the first result. |
| apiDiscardBatchMutation | ApiPendingBatchView! | Shop API: drops a held batch; nothing of it is applied. |
| apiMyInsightsQuery | ApiInsightsView! | Shop API: the dashboard overview (sales, orders to pack, returns, low stock, top products…) over days (7–90, default 14) plus listing states and webhook health. |
| apiMyPerformanceQuery | ApiPerformanceView! | — |
| apiPendingBatchQuery | ApiPendingBatchView! | Shop API: one held batch with its items. |
| apiPendingBatchesQuery | [ApiPendingBatchView!]! | Shop API: bulk writes a circuit breaker held, newest first (pending, confirmed and discarded of the last batches). |
| apiReconcileReportQuery | ApiReconcileReportView! | Shop API: listing counts per state, SKUs changed since since and a fingerprint over every listed SKU. Always granted to a connection key; run it nightly. |
Connectors and sandbox
| Name | Returns | Description |
|---|---|---|
| apiConnectionStatusQuery | ApiConnectionStatusView! | Shop API: the connection behind this key — scopes, expiry, rotation advice, limits and remaining budget. Always granted to a connection key. |
| apiConnectorLatestQuery | ApiConnectorLatestView! | Shop API: the newest release of this key’s connector (channel from the argument, default stable), compared with the version in the User-Agent, with a fresh 10-minute download link. Custom keys get NOT_FOUND. |
| connectorAppsQueryPublic — no key needed | [ConnectorAppView!]! | Active first-party connectors (docs/adr/0126). Public, no secrets. |
| connectorReleasesQueryPublic — no key needed | [ConnectorReleaseView!]! | Published releases of a connector, newest first (yanked ones included with their reason). Downloads need a shop session or a key. |
| createSandboxSellerMutationPublic — no key needed | SandboxSellerView! | Developer sandbox: opens an active test store with an owner account, a custom key carrying every scope and, optionally, a pairing code for a connector app. Only on the sandbox API; refused with NOT_FOUND elsewhere. |
Account, settings, finance and ads
| Name | Returns | Description |
|---|---|---|
| apiMyAdBoostQuery | AdBoostView! | — |
| apiMyAdBoostsQuery | [AdBoostView!]! | The shop’s Meta boosts as the shop sees them: TND only (docs/adr/0098). |
| apiMyBalanceQuery | SellerBalanceView! | — |
| apiMyLedgerQuery | SellerLedgerPage! | — |
| apiMyPayoutsQuery | [PayoutView!]! | — |
| apiMySettingsQuery | SellerSettingsView! | — |
| apiMyStatementsQuery | [SellerStatementView!]! | — |
| apiMyStatementUrlQuery | SignedReadView! | — |
| apiMyVacationsQuery | [SellerVacationView!]! | — |
| apiRotateKeyMutation | ApiRotatedKeyView! | Shop API: a fresh key for the same connection; this key keeps working 24 hours (contract §2.3). Store the new secret before the overlap ends. |
| apiSetVacationMutation | SellerVacationView! | — |
Types
Object types (144)
- AdBoostIssueView
- AdBoostSalesView
- AdBoostTotalsView
- AdBoostView
- AdCreativeImageView
- AdCreativeView
- AdVideoView
- ApiAttributeOptionView
- ApiAttributeView
- ApiBatchItemResultView
- ApiBatchResultView
- ApiBrandPage
- ApiBrandView
- ApiCategoryAttributesView
- ApiCategoryPage
- ApiCategoryView
- ApiConnectionStatusView
- ApiConnectorLatestView
- ApiFamilyPage
- ApiFamilyView
- ApiInsightsView
- ApiListingMatchHitView
- ApiListingMatchView
- ApiListingPage
- ApiListingView
- ApiMediaImportPage
- ApiMediaImportView
- ApiMediaIngestResultView
- ApiPendingBatchItemView
- ApiPendingBatchView
- ApiPerformanceView
- ApiReconcileReportView
- ApiRotatedKeyView
- ApiShipmentPackageView
- ApiShipmentView
- ApiStateCountView
- ApiStockBalanceView
- ApiStockedPositionPage
- ApiStockedPositionView
- AppointmentSlotDayView
- AppointmentSlotView
- AppointmentView
- BaselinePolicyView
- ConnectModerationNoteView
- ConnectorAppView
- ConnectorDownloadView
- ConnectorReleaseCompatView
- ConnectorReleaseView
- ConnectRateLimitView
- ConnectRemainingView
- DisputeSuggestionView
- DropoffVisitShipmentView
- DropoffVisitView
- FeeInvoiceLineView
- HealthComponentView
- InboundDiscrepancyView
- InboundLineView
- InboundReportView
- InboundShipmentDetailView
- InboundShipmentView
- LocalizedText
- LocalizedTextView
- MediaAsset
- MediaHeader
- MediaUpload
- OdooCustomerServicesView
- OdooDocumentView
- OdooSellerBillView
- OdooServiceLineView
- OfferReturnTermsView
- OfferView
- OrderAddressView
- OrderLineView
- OrderSliceView
- PayoutView
- PickupQrView
- PickupTaskView
- PolicyProblemView
- Product
- ProductFlags
- ProductMediaAssignment
- ProductQualityScore
- ProductSeo
- ProductVariant
- RefundLineView
- RefundView
- RegisteredWebhookView
- ReleaseDayView
- ReturnArrivalLineView
- ReturnArrivalOutcomeView
- ReturnArrivalTransferView
- ReturnArrivalView
- ReturnArrivalWithdrawalView
- ReturnLocationView
- ReturnLogisticsView
- ReturnPickupView
- RmaCarrierTicketView
- RmaCustomerHistoryView
- RmaExchangeSummaryView
- RmaItemView
- RmaMessageView
- RmaReturnShipmentView
- RmaRiskHoldView
- RmaView
- SandboxSellerView
- SellerBalanceView
- SellerClockView
- SellerDashboardCategoryView
- SellerDashboardDayView
- SellerDashboardPaymentView
- SellerDashboardProductView
- SellerDashboardRecentSliceView
- SellerDashboardReviewsView
- SellerDashboardStatusCountView
- SellerDashboardView
- SellerFeeInvoiceView
- SellerHealthView
- SellerInvoicePaymentView
- SellerLedgerLineView
- SellerLedgerPage
- SellerOrderSlicePage
- SellerOrderSliceView
- SellerPickupAddressView
- SellerPolicyBundleView
- SellerPolicyCategoryOverrideView
- SellerReturnPage
- SellerReturnPolicyView
- SellerSettingsView
- SellerStatementView
- SellerVacationView
- SellerWarningView
- SignedReadView
- SliceInboundView
- StockAvailabilityPage
- StockAvailabilityView
- StockOfferFactsView
- UserRefView
- WarrantyServiceCenterContactView
- WarrantyTermsView
- WebhookDeliveryView
- WebhookEndpointView
- WebhookEventFamilyView
- WithdrawalAppointmentView
- WithdrawalRequestView
Input types (16)
- ApiListingInput
- ApiListingMatchItemInput
- ApiMediaIngestItemInput
- ApiOfferItemInput
- ApiStockItemInput
- ApiWithdrawalInput
- ApiWithdrawalLineInput
- DeclareInboundInput
- InboundLineInput
- LocalizedTextInput
- OfferInput
- OfferReturnTermsInput
- PickupDetailsInput
- SandboxSellerInput
- WarrantyServiceCenterContactInput
- WarrantyTermsInput
Enums (61)
- AdBoostMetaStatus
- AdBoostScope
- AdBoostStatus
- AdChannel
- AdCreativeKind
- AdOptimizationEvent
- AdVideoStatus
- AppointmentStatus
- BatteryContent
- ConnectBuyBoxStanding
- ConnectListingState
- ConnectMatchConfidence
- ConnectMediaImportStatus
- ConnectorAppStatus
- ConnectorReleaseChannel
- ConnectorReleaseStatus
- ConnectPendingBatchKind
- ConnectPendingBatchStatus
- DisputeKind
- DropoffRunDecision
- ExchangeEligibilityOutcome
- ExpressRouteStatus
- ExpressStopStatus
- FinalSaleReason
- FulfilmentMode
- InboundDiscrepancyKind
- InboundDiscrepancyStatus
- InboundMode
- InboundOrigin
- InboundStatus
- MediaAssetKind
- MediaAssetStatus
- OdooDocumentKind
- OfferStatus
- OrderSliceKind
- OrderSliceStatus
- PickupTaskStatus
- ProductKind
- ProductStatus
- RefundLineStatus
- RefundMethod
- RefundStatus
- ReturnArrivalKind
- ReturnArrivalStatus
- ReturnCountMethod
- ReturnDestination
- RmaCondition
- RmaPayer
- RmaReason
- RmaResolution
- RmaReturnMethod
- RmaStatus
- SellerClockKind
- SellerReturnPolicyStatus
- SellerVacationStatus
- StockState
- WarrantyClaimChannel
- WarrantyKind
- WebhookDeliveryStatus
- WebhookEndpointStatus
- WithdrawalStatus
Scalars (1)
Deprecations
| Name | Description |
|---|---|
| OrderLineView.storageType | Use fulfilmentMode (fbo = stocked, fbs = cross_dock). |
| OrderSliceView.storageType | Use fulfilmentMode (fbo = stocked, fbs = cross_dock). |