مطوّرو واميا
القائمة

مرجع الواجهة

مولّد وقت البناء من مخطط connect.graphql المنشور. يُسرد كل حقل جذري في /connect/graphql مع وسائطه ونوع إرجاعه وعملية جاهزة للصق؛ تتبّع الأنواع لرؤية كل حقل.

استخدم بحث المتصفح (Ctrl/⌘ F) — كل مجموعة في صفحة واحدة.

الكتالوج والعروض والمخزون

الاسميُرجعالوصف
apiBrandsاستعلامApiBrandPage!Shop API: active brands, filterable by name, paged by cursor; etag covers the whole filtered set.
apiCategoriesاستعلام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.
apiCategoryAttributesاستعلامApiCategoryAttributesView!Shop API: the attributes apiSubmitListing validates for a category (and family), with options and which codes are required or variant axes.
apiDeclareStockتعديلStockAvailabilityView!—
apiDeclareStocksتعديلApiBatchResultView!Shop API: on-hand quantities for up to 200 SKUs in one call, with a per-item result. Counts against the bulk budget.
apiFamiliesاستعلامApiFamilyPage!Shop API: product families with their attribute codes (etag as apiCategories).
apiMatchListingsاستعلام[ApiListingMatchView!]!Shop API: finds the Wamia product behind each shop SKU by GTIN, then brand + MPN. Read-only; feeds the import wizard before apiSubmitListing.
apiMyListingsاستعلام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.
apiMyStockاستعلام[StockAvailabilityView!]!Shop API: available quantity per offer, oldest change first. updatedSince and cursor narrow the list; prefer apiMyStockPage to receive nextCursor.
apiMyStockPageاستعلامStockAvailabilityPage!Shop API: available quantities ordered by last change with a keyset cursor (contract §7). Poll with updatedSince and the last nextCursor.
apiProposeListingEditتعديلApiListingView!Shop API: proposes content changes on an own live product; a moderator accepts them. Price and stock go through apiUpsertOffers / apiDeclareStocks.
apiSetOfferReturnTermsBySkuتعديلOfferReturnTermsViewSets or clears the return terms of the offer with this SKU.
apiSetWarrantyTermsBySkuتعديلWarrantyTermsViewSets or clears the warranty terms of the offer with this SKU.
apiStockByLocationاستعلام[ApiStockBalanceView!]!—
apiSubmitListingتعديل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.
apiUpsertOfferتعديلOfferView!—
apiUpsertOffersتعديل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.

الوسائط

الاسميُرجعالوصف
apiAssignProductMediaتعديل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.
apiCreateMediaUploadتعديلMediaUpload!Shop API: a 15-minute signed PUT for one image the plugin uploads itself (contract §6). Send the required headers, then call apiFinalizeMediaUpload.
apiFinalizeMediaUploadتعديل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.
apiIngestMediaFromUrlsتعديل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.
apiMyMediaImportsاستعلامApiMediaImportPage!Shop API: the imports requested by this store, oldest change first; filter by ids or poll with updatedSince and cursor.

الطلبات والتجهيز والمرتجعات

الاسميُرجعالوصف
apiAcknowledgeSliceتعديلSellerOrderSliceView!—
apiDecideReturnتعديلRmaView!—
apiMarkSlicePreparedتعديلSellerOrderSliceView!—
apiMyOrdersاستعلام[SellerOrderSliceView!]!Shop API: the store’s slices, newest first. With updatedSince or cursor the order becomes oldest change first; prefer apiMyOrdersPage to receive nextCursor.
apiMyOrderSliceاستعلامSellerOrderSliceView!—
apiMyOrdersPageاستعلام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.
apiMyReturnPolicyاستعلامSellerPolicyBundleView!The store’s return policy (active, draft) and the platform baseline.
apiMySliceReturnsاستعلام[RmaView!]!Shop API: returns touching the store’s slices, newest first. With updatedSince or cursor the order becomes oldest change first; prefer apiMySliceReturnsPage.
apiMySliceReturnsPageاستعلامSellerReturnPage!Shop API: returns ordered by last change with a keyset cursor (contract §7).
apiShipmentsاستعلام[ApiShipmentView!]!—

التوريدات والمواعيد والسحوبات

الاسميُرجعالوصف
apiBookInboundAppointmentتعديلInboundShipmentView!—
apiBookWithdrawalAppointmentتعديلWithdrawalRequestView!Books a dock slot for an approved withdrawal. Slots: apiInboundSlots.
apiDeclareInboundتعديلInboundShipmentView!—
apiInboundShipmentاستعلامInboundShipmentDetailView!—
apiInboundShipmentsاستعلام[InboundShipmentView!]!—
apiInboundSlotGridاستعلام[AppointmentSlotDayView!]!Dock slots per day over a window of at most 14 days.
apiInboundSlotsاستعلام[AppointmentSlotView!]!—
apiRequestWithdrawalتعديلWithdrawalRequestView!—
apiRescheduleInboundAppointmentتعديلInboundShipmentView!Moves a scheduled shipment to another slot; the previous appointment is freed.
apiRescheduleWithdrawalAppointmentتعديلWithdrawalRequestView!Moves a withdrawal to another slot; the previous slot is freed.
apiStockedPositionsاستعلام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.
apiWithdrawalsاستعلام[WithdrawalRequestView!]!—

الويب هوك

الاسميُرجعالوصف
apiDeleteWebhookتعديلWebhookEndpointView!Shop API: removes an endpoint and its delivery log.
apiMyWebhooksاستعلام[WebhookEndpointView!]!Shop API: the endpoints of this store with their health, newest first.
apiRegisterWebhookتعديل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.
apiTestWebhookتعديل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.
webhookEventTypesاستعلامعام — بدون مفتاح[WebhookEventFamilyView!]!Event types a webhook may subscribe to, by family (docs/connect/contract.md §8). <family>.* subscribes to a whole family, * to everything.

الضوابط والمحاكاة والمؤشرات

الاسميُرجعالوصف
apiConfirmBatchتعديلApiBatchResultView!Shop API: applies a held batch as submitted, breaker bypassed. Confirming twice replays the first result.
apiDiscardBatchتعديلApiPendingBatchView!Shop API: drops a held batch; nothing of it is applied.
apiMyInsightsاستعلام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.
apiMyPerformanceاستعلامApiPerformanceView!—
apiPendingBatchاستعلامApiPendingBatchView!Shop API: one held batch with its items.
apiPendingBatchesاستعلام[ApiPendingBatchView!]!Shop API: bulk writes a circuit breaker held, newest first (pending, confirmed and discarded of the last batches).
apiReconcileReportاستعلام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.

الموصّلات وبيئة التجربة

الاسميُرجعالوصف
apiConnectionStatusاستعلامApiConnectionStatusView!Shop API: the connection behind this key — scopes, expiry, rotation advice, limits and remaining budget. Always granted to a connection key.
apiConnectorLatestاستعلام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.
connectorAppsاستعلامعام — بدون مفتاح[ConnectorAppView!]!Active first-party connectors (docs/adr/0126). Public, no secrets.
connectorReleasesاستعلامعام — بدون مفتاح[ConnectorReleaseView!]!Published releases of a connector, newest first (yanked ones included with their reason). Downloads need a shop session or a key.
createSandboxSellerتعديلعام — بدون مفتاح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.

الحساب والإعدادات والمالية والإعلانات

الاسميُرجعالوصف
apiMyAdBoostاستعلامAdBoostView!—
apiMyAdBoostsاستعلام[AdBoostView!]!The shop’s Meta boosts as the shop sees them: TND only (docs/adr/0098).
apiMyBalanceاستعلامSellerBalanceView!—
apiMyLedgerاستعلامSellerLedgerPage!—
apiMyPayoutsاستعلام[PayoutView!]!—
apiMySettingsاستعلامSellerSettingsView!—
apiMyStatementsاستعلام[SellerStatementView!]!—
apiMyStatementUrlاستعلامSignedReadView!—
apiMyVacationsاستعلام[SellerVacationView!]!—
apiRotateKeyتعديل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.
apiSetVacationتعديلSellerVacationView!—

الأنواع

أنواع الكائنات (144)

أنواع الإدخال (16)

التعدادات (61)

القيم العددية (1)

المهملات

الاسمالوصف
OrderLineView.storageTypeUse fulfilmentMode (fbo = stocked, fbs = cross_dock).
OrderSliceView.storageTypeUse fulfilmentMode (fbo = stocked, fbs = cross_dock).