Magidoc

Query
Object

The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

Fields

#

products

ProductConnection

List of Product.

Required Scopes: read:inventory

product

Product

Returns a Product by ID.

Required Scopes: read:inventory

shippingProfiles

[ ShippingProfile !]!
Non-null

All shipping profiles available to this seller: active custom profiles + standard Whatnot default profiles

Required Scopes: read:inventory

productVariants

ProductVariantConnection

List of ProductVariant.

Required Scopes: read:inventory

productVariant

ProductVariant

Returns a ProductVariant by ID.

Required Scopes: read:inventory

productTaxonomyNodes

ProductTaxonomyNodeConnection

List of ProductTaxonomyNode.

productTaxonomyNode

ProductTaxonomyNode

Returns a ProductTaxonomyNode by ID.

listings

ListingConnection

List of Listing.

Required Scopes: read:inventory

listing

Listing

Returns a Listing by ID.

Required Scopes: read:inventory

bulkOperations

BulkOperationConnection

List of BulkOperations.

bulkOperation

BulkOperation

Returns a BulkOperation by ID.

currentBulkOperation

BulkOperation

Get the currently running bulk operation

livestreams

LivestreamConnection

List of Livestreams

livestream

Livestream

Returns a Livestream by ID.

orders

OrderConnection

List of Orders

Required Scopes: read:orders

order

Order

Returns a Order by ID.

Required Scopes: read:inventory

shipments

ShipmentConnection

⚠ Beta — The types, behavior, and existence of this item may change without notice. Not recommended for production use.

List of Shipments

Required Scopes: read:shipments

shipment

Shipment

⚠ Beta — The types, behavior, and existence of this item may change without notice. Not recommended for production use.

Returns a Shipment by ID.

Required Scopes: read:shipments

productAttributes

ProductAttributeConnection

Get the available product attributes for a given filter.

productAttribute

ProductAttribute

Returns a ProductAttribute by ID.

me

User

Get the current user.

node

Node

Returns a given Node by ID.