Magidoc

Query
Object

The query root of Orderchamp's GraphQL interface.

Fields

#

accessToken

AccessToken !
Non-null

Returns the currently authenticated AccessToken.

account

Account !
Non-null

Returns the currently authenticated Account (either a retailer or a supplier)

attributes

[Attribute ]

brand

Brand

Returns a Brand resource by ID.

brands

BrandConnection !
Non-null

List of Brands.

categories

[Category ]

channel

Channel

Returns a Channel resource by ID.

channels

ChannelConnection !
Non-null

Returns a list of channels owned by the authenticated account.

customCategories

CustomCategoryConnection !
Non-null

List of custom categories.

customCategory

CustomCategory

Returns a CustomCategory resource by ID.

customFields

[CustomField !]

Returns all custom field definitions for the authenticated account.

customer

Customer

Returns a Customer resource by ID.

customers

CustomerConnection !
Non-null

List of customers.

hsCode

HsCode

hsCodes

[HsCode ]

List of available HS codes, used for categorizing products.

ingestedOrders

IngestedOrderConnection !
Non-null

List of ingested orders (Dropshipping) created by the authenticated retailer.

invoice

Invoice

Returns an Invoice resource by ID. Accepts the IDs returned on Invoice resources (for example via order.invoices), regardless of the invoice type.

node

Node

Fetches an object given its ID.

nodes

[Node ]!
Non-null

Fetches a list of objects given a list of IDs.

order

Order

Returns an Order resource by ID

orders

OrderConnection !
Non-null

priceList

PriceList

Returns a PriceList resource by ID or external ID. At least one identifier must be provided. If both are provided, they must resolve to the same price list.

priceLists

PriceListConnection !
Non-null

List of price lists.

product

Product

Returns a Product resource by ID.

productCollection

ProductCollection

Returns a ProductCollection resource by ID or external ID. At least one identifier must be provided. If both are provided, they must resolve to the same collection.

productCollections

ProductCollectionConnection !
Non-null

List of ProductCollections.

productVariant

ProductVariant

Returns a ProductVariant resource by ID.

productVariantAttributes

[ProductVariantAttribute ]

productVariantBySku

ProductVariant

productVariants

ProductVariantConnection !
Non-null

List of productVariants.

products

ProductConnection !
Non-null

List of products.

publication

Publication

Returns a Publication resource by ID or Product ID.

publicationVariant

PublicationVariant

Returns a PublicationVariant resource by ID.

publications

PublicationConnection !
Non-null

List of publications.

retailerOrder

RetailerOrder

Returns an RetailerOrder resource by ID

shipment

Shipment

Returns a Shipment resource by ID.

shipments

ShipmentConnection !
Non-null

List of productVariants.

storefronts

StorefrontConnection !
Non-null

supplierBill

SupplierBill

Returns a Supplier Bill resource by ID

supplierInvoice

SupplierInvoice

Returns a Supplier Invoice resource by ID

supplierInvoices

SupplierInvoiceConnection !
Non-null

webhook

Webhook

Returns a webhook resource by ID.

webhooks

WebhookConnection !
Non-null

List of webhooks.