Query

(OBJECT)

Querying retrieves data (read access). Batching of multiple queries is not supported with this API. To modify data or perform operations @see Mutation definition.

As of GraphQL nature, for each query you need to specify fields returned. To make this simpler you may use predefined fragments of data (default datasets) which honor the _<ObjectName> convention. You may combine predefined fragments with specific field enumeration in your queries. @see fragments.graphql

You may need to distinguish between cursors i.e. pageable lists of items (SomeobjectList objects) returned and simple sets of items (array of objects). General rule is that lists are used for 'content generated by public' and are retrieved by getObjectList queries, simple sets are used for 'items created/managed by administrator' and retrieved by listObjects calls.

Please note for cursors you may not request more than 30 items at once (i.e. page size is limited to max. 30 items). Querying retrieves data (read access).

GraphQL Schema definition

type Query {
#   simple greeting method to test request validity, syntax or response 
#   processing.
Says Hello to whomever you like. 
# 
# Arguments
#   name: whom to greet 
hello(name: String): String 
#   retrieves a paginated list of orders. 
# 
# Arguments
#   lang_code: language ISO code 
#   status: order status ID 
#   newer_from: retrieves only orders received after the specified 
#   date 
#   changed_from: retrieves only orders changed after the specified 
#   date 
#   include_blocking: includes currently blocked orders 
#   params: pagination and filtering parameters 
#   filter: bulk order filtering, available only with a partner 
#   token 
getOrderList(
lang_code: CountryCodeAlpha2,
status: Int,
newer_from: DateTime,
changed_from: DateTime,
include_blocking: Boolean,
params: OrderParams,
filter: OrderFilter
): OrderList 
#   retrieve detailed information about specific order. Use '_Order' fragment to 
#   retrieve default set of information. 
# 
# Arguments
#   order_num: the order's evidence number 
getOrder(order_num: String!): Order 
#   retrieves a list of preinvoices 
# 
# Arguments
#   company_id: invoicing company business ID 
#   params: pagination and filtering parameters 
#   filter: using the bulk pre-invoice filter requires a partner 
#   token. 
getPreinvoiceList(
company_id: ID,
params: OrderParams,
filter: PreinvoiceFilter
): PreinvoiceList 
#   retrieves a list of invoices 
# 
# Arguments
#   company_id: invoicing company business ID 
#   params: pagination and filtering parameters 
#   filter: using the bulk invoice filter requires a partner token 
getInvoiceList(
company_id: ID,
params: OrderParams,
filter: InvoiceFilter
): InvoiceList 
#   retrieves detailed information about a specific invoice 
# 
# Arguments
#   invoice_num: invoice number 
getInvoice(invoice_num: String!): Invoice 
#   retrieves a list of products 
# 
# Arguments
#   lang_code: language version for which products are returned 
#   category_id: main product category, if this argument is 
#   specified, the lang_code parameter will be ignored 
#   params: pagination and filtering parameters 
#   filter: bulk product filter, available only with a partner 
#   token 
getProductList(
lang_code: CountryCodeAlpha2!,
category_id: ID,
params: ProductParams,
filter: ProductFilter
): ProductList 
#   retrieves detailed information about a specific product 
# 
# Arguments
#   product_id: internal product ID 
#   lang_code: language code - if omitted, product details of main 
#   system language version are provided 
#   import_code: import code from supplier or data source 
#   ean: gets product details by EAN 
getProduct(
product_id: ID,
lang_code: CountryCodeAlpha2,
import_code: String,
ean: Ean
): Product 
#   retrieves the XML feed URL containing products and their final prices 
# 
# Arguments
#   lang_code: language_code
#   type: feed type — either 'products' or 'availability'
getFeedUrl(lang_code: CountryCodeAlpha2!, type: FeedType!): Url 
#   retrieves detailed information about a specific category 
# 
# Arguments
#   category_id: internal category id 
#   productListParams: filter and pagination parameters for 
#   products within this category 
getCategory(category_id: ID!, productListParams: ProductParams): Category 
#   retrieves a list of warehouse items that have had recent stock or blocking 
#   changes 
# 
# Arguments
#   changed_from: returns stock items changed since the specified 
#   date. 
#   params: filter and pagination parameters 
getWarehouseItemsWithRecentStockUpdates(
changed_from: DateTime!,
params: WarehouseItemParams
): WarehouseItemList 
#   retrieves detailed information about a warehouse item. At least one identifier — 
#   'warehouse_number' or 'ean' — must be provided. 
# 
# Arguments
#   warehouse_number: warehouse item identifier 
#   ean: EAN code of the warehouse item 
getWarehouseItem(warehouse_number: WarehouseNumber, ean: Ean): WarehouseItem 
#   retrieves detailed content for a specific web page. 
# 
# Arguments
#   id: internal ID 
getWebPage(id: ID!): WebPage 
#   retrieves a list of all web pages containing a block of the specified type. 
#   Note: currently only supports the 'News' block. 
# 
# Arguments
#   block_type: block type identificator 
#   params: pagination and filtering parameters 
getWebPageListWithBlock(
block_type: ContentBlockType!,
params: WebPageParams
): WebPageList 
#   retrieves a list of invoicing companies 
# 
# Arguments
#   id: internal ID
#   name: company name 
#   company_id: company business ID 
listMyCompanies(id: ID, name: String, company_id: String): [InvoicingCompany] 
#   retrieves a list of order statuses 
# 
# Arguments
#   lang_code: returns order statuses translated for the specified 
#   language version 
#   only_active: if true, ignores statuses managed by inactive 
#   payment gateways 
listOrderStatuses(
lang_code: CountryCodeAlpha2,
only_active: Boolean
): [OrderStatus] 
#   retrieves a list of warehouse statuses 
# 
# Arguments
#   allow_order: only statuses for which ordering is allowed  
#   pickup: 
#   lang_code: language ISO code for localization  
listWarehouseStatuses(
allow_order: Boolean,
pickup: Boolean,
lang_code: CountryCodeAlpha2
): [WarehouseStatus] 
#   retrieves a list of producers 
# 
# Arguments
#   search: search term for filtering producers.
listProducers(search: String): [Producer]! 
#   retrieves a list of available shipping methods 
# 
# Arguments
#   lang_code: shipping methods available for the specified 
#   language version. 
#   only_active: returns only active shipping methods 
listShippings(lang_code: CountryCodeAlpha2!, only_active: Boolean): [Shipping]! 
#   retrieves a list of available payment methods 
# 
# Arguments
#   lang_code: payment methods available for the specified language 
#   version. 
#   only_active: returns only active payments 
listPayments(lang_code: CountryCodeAlpha2!, only_active: Boolean): [Payment]! 
#   retrieves a list of currencies. 
listCurrencies: [Currency]! 
#   retrieves a list of available language versions. 
listLanguageVersions: [LanguageVersion]! 
#   retrieves all product attributes and their values, translated to the given 
#   language (falls back to the base language). Note: Available only with a partner 
#   token. 
# 
# Arguments
#   lang_code: language code of the requested translation 
listAttributes(lang_code: CountryCodeAlpha2): [Attribute] 
#   retrieves all root-level web pages. 
listRootWebPages: [WebPage!] 
#   retrieves all root-level product categories. 
listRootCategories: [Category!] 
}

Require by

This element is not required by anyone

Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by